ReferencePromoções
Consultar pedido de promoção
Devolve o estado atual do pedido e de cada link. Consulte até status ser final:
completed, completed_with_errors, failed, cancelled ou expired.
A chave de API vê os pedidos feitos por chaves de API da conta; o app de parceiro vê só os pedidos que ele mesmo criou.
x-api-key<token>
Chave de API no formato sk_live_..., no header x-api-key.
In: header
Path Parameters
id_promotion_job*string
ID do pedido de promoção (formato promotion_job_<uuid>).
Length
length <= 100Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/api/external/info-promotion-job/string"{ "success": true, "id_promotion_job": "string", "status": "queued", "mode": "create", "id_segment": "string", "on_error": "skip", "summary": { "total": 0, "queued": 0, "processing": 0, "generated": 0, "created": 0, "failed": 0, "skipped": 0, "cancelled": 0, "expired": 0 }, "items": [ { "index": 0, "link": "string", "store": "string", "status": "queued", "id_campaign": "string", "campaign_status": "string", "scheduled_at": "2019-08-24T14:15:22Z", "product": { "title": "string" }, "message": "string", "link_url": "string", "template_applied": { "mode": "id", "id_template": "string" }, "coupon_applied": { "code": "string", "link": "string" }, "discount_applied": true, "error": { "code": "string", "message": "string", "retryable": true }, "warnings": [ "string" ] } ], "created_at": "2019-08-24T14:15:22Z", "finished_at": "2019-08-24T14:15:22Z"}{ "success": false, "error": "Unauthorized", "message": "Chave de API inválida ou ausente."}{ "success": false, "error": "Forbidden", "code": "plan_feature_locked", "message": "Seu plano permite 1 link por pedido. Para vários links de uma vez é preciso o Multi Sender.", "feature": "multi_sender"}{ "success": false, "error": "Not Found", "code": "promotion_job_not_found", "message": "Pedido de promoção não encontrado."}{ "success": false, "error": "Too Many Requests", "code": "too_many_active_jobs", "message": "Esta conta já tem 3 pedidos de promoção em andamento. Aguarde um terminar."}{ "success": false, "error": "Internal Server Error", "code": "internal_error", "message": "Erro interno ao processar o pedido de promoção."}{ "success": false, "error": "Service Unavailable", "code": "service_paused", "message": "A geração de promoções pela API está pausada no momento. Tente novamente mais tarde."}