Newsman – Knowledge Base
Metoda API Newsman: coupons.getCouponCodes
Prototip: coupons.getCouponCodes(list_id, coupon_id, filter, start, limit)
Descriere: Returnează un Array având codurile cuponului. Fiecare element este un array cheie / valoare având cheile: code, created_at, expires_at, sent, subscriber_id, email, newsletter_id, form_id
Metoda HTTP: GET
Endpoint HTTP: /coupons.getCouponCodes.json
Endpoint XML-RPC: coupons.getCouponCodes
Tip raspuns: structInformatii raspuns: Array având codurile cuponului. Fiecare element este un array cheie / valoare având cheile: code, created_at, expires_at, sent, subscriber_id, email, newsletter_id, form_id
Parametrii request GET
| Variabila | Tip | Descriere |
|---|---|---|
| list_id | string|int | ID-ul listei din care face parte cuponul |
| coupon_id | string | ID-ul cuponului pentru care se preiau codurile |
| filter | struct|array|boolean | Array de tip cheie valoare prin care se pot filtra codurile. Cheile disponibile sunt: code, status (any, available, sent, expired), sent_to (string email). Se poate trimite false sau un array gol dacă nu se dorește filtrarea codurilor. |
| start | string|int | Numărul paginii de început. Implicit este prima pagină (start = 1). |
| limit | string|int | Numărul de rezultate per pagină. Implicit este 100. Nu poate depăsi 20000 |
Parametrii raspuns
| Parametru | Descriere |
|---|---|
| code | Codul |
| created_at | Data la care a fost adăugat codul |
| expires_at | Data la care expiră codul |
| sent | Dacă a fost trimis sau nu codul |
| subscriber_id | Id-ul abonatului la care a fost trimis codul (dacă a fost trimis) |
| Adresa de email la care a fost trimis codul (dacă a fost trimis) | |
| newsletter_id | Id-ul newsletter-ului prin care a fost trimis codul (dacă a fost trimis) |
| form_id | Id-ul formularului prin care a fost trimis codul (dacă a fost trimis) |
Exemple request
Exemplu output
[ { "code": "THECODE1", "created_at": 1715336780, "expires_at": null, "sent": false, "subscriber_id": null, "email": null, "newsletter_id": null, "form_id": null }, { "code": "THECODE2", "created_at": 1715336780, "expires_at": null, "sent": false, "subscriber_id": null, "email": null, "newsletter_id": null, "form_id": null }, { "code": "THECODE3", "created_at": 1715336780, "expires_at": null, "sent": false, "subscriber_id": null, "email": null, "newsletter_id": null, "form_id": null }, { "code": "THECODE4", "created_at": 1715336780, "expires_at": null, "sent": false, "subscriber_id": null, "email": null, "newsletter_id": null, "form_id": null }, { "code": "THECODE5", "created_at": 1715336780, "expires_at": null, "sent": false, "subscriber_id": null, "email": null, "newsletter_id": null, "form_id": null }, { "code": "THECODE6", "created_at": 1715336780, "expires_at": null, "sent": false, "subscriber_id": null, "email": null, "newsletter_id": null, "form_id": null }, { "code": "THECODE7", "created_at": 1715336780, "expires_at": null, "sent": false, "subscriber_id": null, "email": null, "newsletter_id": null, "form_id": null }, { "code": "THECODE8", "created_at": 1715336780, "expires_at": null, "sent": false, "subscriber_id": null, "email": null, "newsletter_id": null, "form_id": null }, { "code": "THECODE9", "created_at": 1715336780, "expires_at": null, "sent": false, "subscriber_id": null, "email": null, "newsletter_id": null, "form_id": null }, { "code": "THECODE10", "created_at": 1715336780, "expires_at": null, "sent": false, "subscriber_id": null, "email": null, "newsletter_id": null, "form_id": null } ]
Erori raspuns
| Cod | Mesaj | Descriere |
|---|---|---|
| 407 | Missing required param list_id | Parametrul list_id este obligatoriu |
| 407 | Missing required param coupon_id | Parametrul coupon_id este obligatoriu |
| 407 | Missing required param filter | Parametrul filter este obligatoriu |
| 407 | Missing required param start | Parametrul start este obligatoriu |
| 407 | Missing required param limit | Parametrul limit este obligatoriu |
| 101 | Not allowed for list_id = %s | Acces nepermis la list_id |
| 101 | No such coupon with ID: %s | Nu se poate accesa cuponul după ID: %s |
Exemple de erori
{ "err": true, "message": "Missing required param list_id", "code": 407 }
{ "err": true, "message": "Missing required param coupon_id", "code": 407 }
{ "err": true, "message": "Missing required param filter", "code": 407 }
{ "err": true, "message": "Missing required param start", "code": 407 }
{ "err": true, "message": "Missing required param limit", "code": 407 }