API Reference
Envios
A API de Envios inclui todos os endpoints para criar remessas e obter dados das suas remessas criadas. Você também encontrará endpoints para receber notificações sobre as novidades do status das suas remessas através de um webhook.
Envios externos
Ao definir a sua integração, você terá a opção de NÃO utilizar o nosso serviço de distribuição de cartões.
Nesse caso, os grupos de afinidade refletirão as configurações escolhidas. Além disso, ao criar um cartão ou um lote de cartões, retornaremos um identificador no campo shipment_id que recomendamos armazenar em sua integração, pois você precisará dele para fazer a retirada. Os cartões estarão disponíveis para retirada na planta de gravação definida na integração.
Criar remessa
O endpoint /shipping/v1/ é usado para criar um envio de um cartão inominado. Tenha em mente que, para criar um envio, é requisito que você criado um lote de cartões inominados.
Considerações
O campo região corresponde a:
- Província, na Argentina
- Estado, do Brasil
- Estado, na Colômbia
- Estado, no México
O campo courier.tracking_url da resposta estará disponível assim que o envio for informado pelo parceiro logístico correspondente. Até lá, terá valor nulo
Para o Brasil
- Se você opera no Brasil, o taxIdentificationNumber será sempre obrigatório.
- Os campos
documentNumberedocumentTypenão serão necessários. - Além disso, precisará preencher o campo da região com o código da UF de dois caracteres. Exemplo: 'SP' para São Paulo
- Rondônia (RO)
- Acre (AC)
- Amazonas (AM)
- Roraima (RR)
- Pará (PA)
- Amapá (AP)
- Tocantins (TO)
- Maranhão (MA)
- Piauí (PI)
- Ceará (CE)
- Rio Grande do Norte (RN)
- Paraíba (PB)
- Pernambuco (PE)
- Alagoas (AL)
- Sergipe (SE)
- Bahia (BA)
- Minas Gerais (MG)
- Espírito Santo (ES)
- Rio de Janeiro (RJ)
- São Paulo (SP)
- Paraná (PR)
- Santa Catarina (SC)
- Rio Grande do Sul (RS)
- Mato Grosso do Sul (MS)
- Mato Grosso (MT)
- Goiás (GO)
- Distrito Federal (DF)
Para a Colômbia
Se você opera na Colômbia, o campo zip_code é opcional, o que significa que você não pode enviá-lo.
Envio de tarjetas innominadas desde deposito
Puedes asociar un envío con el usuario al que le enviarás la tarjeta especificando el user_id en el body del shipment.
Parâmetros disponíveis
Header Parameters
Authorizationstringrequired
Exemplo: Bearer {access_token}
x-idempotency-keystringrequired
ID única em cada solicitação para utilizar nosso esquema de idempotência.Exemplo: fRwX12Dg3345AD
Body Parameters
shipment_typestringrequired
Enum: CARD_FROM_WAREHOUSE
affinity_group_idstringrequired
Exemplo: afg-20MpN8vmIPj77ujhb9cS8ctstN2
countrystringrequired
Exemplo: ARG
addressobjectrequired
receiverobjectrequired
user_idstring
Exemplo: usr-20MpN8vmIPj77ujhb9cS8ctstN2
Detalhe de respostas
idstring
Exemplo: shi-23hJL4bm94q9BFEd2sGhBjY6xbH
external_tracking_idstring
Exemplo: f923da123
statusstring
Enum: CREATEDPENDINGTRACKEDREJECTEDIN_WAREHOUSEIN_TRANSITFAILED_DELIVERY_ATTEMPTDISTRIBUTIONDELIVEREDNOT_DELIVEREDSTART_OF_CUSTODYEND_OF_CUSTODYDESTRUCTIONACCIDENT
status_detailstring
Enum: CREATEDPENDINGTRACKEDREADY_FOR_DISTRIBUTIONROAD_TO_PICKUPUNSUCCESSFUL_PICKUPROAD_TO_RETURNUNSUCCESSFUL_RETURNREJECTEDSHIPMENT_SENTSHIPMENT_CONFIRMEDIN_WAREHOUSEIN_TRANSITRECEIVED_BY_CARRIERFAILED_DELIVERY_ATTEMPTWRONG_ADDRESSSHIPMENT_CONSOLIDATEDDISTRIBUTIONDELIVEREDNOT_DELIVEREDSTART_OF_CUSTODYEND_OF_CUSTODYZONE_ASSIGNEDDESTRUCTIONACCIDENTSTOLENVISIT_SCHEDULEDCALL_SCHEDULEDVISIT_CONFIRMEDCALL_FAILED_UNKNOWNNO_ACCESSFAILED_VISIT_DEADWRONG_OPERATOR_ZONECALL_RESCHEDULEDCALL_FAILED_DEADCALL_FAILEDWHATSAPP_FAILEDCOURIER_FAILEDMISSING_DOCUMENTSRETURNED_TO_WAREHOUSECLIENT_NOT_PRESENTINCOMPLETE_ADDRESSCOVERAGEOPERATOR_REASSIGNEDCLIENT_UNKNOWNNO_CALLZONE_PROBLEMSCLIENT_WORKFRAUDFRAUD_CLIENTMISSING_NUMBERCLIENT_CANCELEDDESTROYED_BY_CLIENTWEATHERLOSTCLIENT_TRIPFAILED_VISIT_UNKNOWNRETURNED
shipment_typestring
Enum: SINGLE_CARDBOXWAREHOUSE_BOXCARD_FROM_WAREHOUSEEXTERNAL_SINGLE_CARDEXTERNAL_BOX
affinity_group_idstring
Exemplo: afg-20MpN8vmIPj77ujhb9cS8ctstN2
affinity_group_namestring
Exemplo: Pomelo Nominate Basic Physical
courierobject
country_codestring
Exemplo: ARG
created_atstring
Exemplo: 2020-07-10 15:00:00.000
batchobject
addressobject
receiverobject
user_idstring
Exemplo: usr-20MpN8vmIPj77ujhb9cS8ctstN2
Esta seção foi útil para você?
POST/shipping/v1
{
"shipment_type":
"CARD_FROM_WAREHOUSE"
"affinity_group_id":
"afg-20MpN8vmIPj77ujhb9cS8ctstN2"
"country":
"ARG"
"address":{
"street_name":
"Libertador"
"street_number":
"539"
"floor":
"2"
"apartment":
"B"
"city":
"Buenos Aires"
"region":
"Buenos Aires"
"country":
"Argentina"
"zip_code":
"5346"
"neighborhood":
"string"
"receiver":{
"full_name":
"Gonzalo Iglesias"
"email":
"document_type":
"dni"
"document_number":
"243432423"
"tax_identification_number":
"38912151888"
"telephone_number":
"53454342"
"user_id":
"usr-20MpN8vmIPj77ujhb9cS8ctstN2"
Respostas de amostra
{
"id":
"shi-23hJL4bm94q9BFEd2sGhBjY6xbH"
"external_tracking_id":
"f923da123"
"status":
"CREATED"
"status_detail":
"CREATED"
"shipment_type":
"SINGLE_CARD"
"affinity_group_id":
"afg-20MpN8vmIPj77ujhb9cS8ctstN2"
"affinity_group_name":
"Pomelo Nominate Basic Physical"
"courier":{
"company":
"ANDREANI"
"tracking_url":
"https://www.api.qa.com/#!/informacionEnv ..."
"country_code":
"ARG"
"created_at":
"2020-07-10 15:00:00.000"
"batch":{
"id":
"bch-23WEkAaZsqubbke9pYVAt9sG81e"
"quantity":
100
"has_stock":
true
"status":
"PENDING"
"address":{
"street_name":
"Libertador"
"street_number":
"539"
"floor":
"2"
"apartment":
"B"
"city":
"Buenos Aires"
"region":
"Buenos Aires"
"country":
"Argentina"
"zip_code":
"5346"
"neighborhood":
"string"
"receiver":{
"full_name":
"Gonzalo Iglesias"
"email":
"document_type":
"dni"
"document_number":
"243432423"
"tax_identification_number":
"38912151888"
"telephone_number":
"53454342"
"user_id":
"usr-20MpN8vmIPj77ujhb9cS8ctstN2"
Buscar envios
O endpoint `/shipping/v1/ permite buscar um grupo de envios com base nos atributos especificados.
Você conseguirá aplicar filtros e classificar os envios seguindo esta documentação.
Os atributos que podem ser ordenados são:
shipment_typestatusstatus_detailcreated_at
Parâmetros disponíveis
Header Parameters
Authorizationstringrequired
Exemplo: Bearer {access_token}
Query Parameters
filter[id]string
filter[shipment_type]string
Enum: SINGLE_CARDBOXCARD_FROM_WAREHOUSEWAREHOUSE_BOX
filter[batch_id]string
filter[email]string
filter[status]string
filter[batch_status]string
filter[document_number]string
filter[start_date]string
filter[end_date]string
filter[start_due_delivery_date]string
filter[end_due_delivery_date]string
filter[country_code]string
ISO 3166-1 alpha-3filter[user_id]string
page[size]number
Tamanho de página.page[number]number
Número de página. O número da primeira página é 0.sortstring
Exemplo: pid, shipment_type, status, status_detail
Detalhe de respostas
dataarray
metaobject
Esta seção foi útil para você?
GET/shipping/v1
Respostas de amostra
{
"data":[
0:{
...
}"meta":{
"pagination":{
...
}"filter":[
...
]Alterar dados de envio
O endpoint /shipping/v1/{shipment_id} permite que você atualize o endereço de entrega de um envio.
Considerações
Para actualizar la dirección de entrega, el envío debe tener como STATUS_DETAIL alguno de los siguientes valores según la transportadora:
| Courier | Estados permitidos |
|---|---|
| 99 MINUTOS | SHIPMENT_CONFIRMED, IN_WAREHOUSE, RECEIVED_BY_CARRIER, ROAD_TO_PICKUP, UNSUCCESSFUL_PICKUP |
| ANDREANI | PENDING, END_OF_CUSTODY, DISTRIBUTION, WRONG_ADDRESS |
| DOMINA | CALL_SCHEDULED, VISIT_SCHEDULED, CALL_FAILED_UNKNOWN, CLIENT_NOT_PRESENT, WRONG_ADDRESS, IN_TRANSIT, INCOMPLETE_ADDRESS, RECEIVED_BY_CARRIER, CALL_RESCHEDULED |
| ESTAFETA | FAILED_DELIVERY_ATTEMPT |
| FLASH | START_OF_CUSTODY |
Você não poderá criar outra solicitação de alteração de endereço para um envio enquanto houver uma pendente.
Para consultar o estado da solicitação, você precisará interagir com o endpoint Obter envio. No campo request_status, você verá um dos seguintes valores:
- PENDING_UPDATE_ADDRESS: aguardando a resposta da transportadora.
- CONFIRMED_UPDATE_ADDRESS: la transportadora nos confirmó el cambio de domicilio de envío.
- REJECTED_UPDATE_ADDRESS: a transportadora rejeitou a alteração de endereço do envio.
Se a sua solicitação for rejeitada, você continuará visualizando o endereço de envio original.
Parâmetros disponíveis
Header Parameters
Authorizationstringrequired
Exemplo: Bearer {access_token}
x-idempotency-keystringrequired
ID única em cada solicitação para utilizar nosso esquema de idempotência.Exemplo: fRwX12Dg3345AD
Body Parameters
addressobject
Detalhe de respostas
idstring
Exemplo: shi-23hJL4bm94q9BFEd2sGhBjY6xbH
external_tracking_idstring
Exemplo: f923da123
statusstring
Enum: CREATEDPENDINGTRACKEDREJECTEDIN_WAREHOUSEIN_TRANSITFAILED_DELIVERY_ATTEMPTDISTRIBUTIONDELIVEREDNOT_DELIVEREDSTART_OF_CUSTODYEND_OF_CUSTODYDESTRUCTIONACCIDENT
status_detailstring
Enum: CREATEDPENDINGTRACKEDREADY_FOR_DISTRIBUTIONROAD_TO_PICKUPUNSUCCESSFUL_PICKUPROAD_TO_RETURNUNSUCCESSFUL_RETURNREJECTEDSHIPMENT_SENTSHIPMENT_CONFIRMEDIN_WAREHOUSEIN_TRANSITRECEIVED_BY_CARRIERFAILED_DELIVERY_ATTEMPTWRONG_ADDRESSSHIPMENT_CONSOLIDATEDDISTRIBUTIONDELIVEREDNOT_DELIVEREDSTART_OF_CUSTODYEND_OF_CUSTODYZONE_ASSIGNEDDESTRUCTIONACCIDENTSTOLENVISIT_SCHEDULEDCALL_SCHEDULEDVISIT_CONFIRMEDCALL_FAILED_UNKNOWNNO_ACCESSFAILED_VISIT_DEADWRONG_OPERATOR_ZONECALL_RESCHEDULEDCALL_FAILED_DEADCALL_FAILEDWHATSAPP_FAILEDCOURIER_FAILEDMISSING_DOCUMENTSRETURNED_TO_WAREHOUSECLIENT_NOT_PRESENTINCOMPLETE_ADDRESSCOVERAGEOPERATOR_REASSIGNEDCLIENT_UNKNOWNNO_CALLZONE_PROBLEMSCLIENT_WORKFRAUDFRAUD_CLIENTMISSING_NUMBERCLIENT_CANCELEDDESTROYED_BY_CLIENTWEATHERLOSTCLIENT_TRIPFAILED_VISIT_UNKNOWNRETURNED
shipment_typestring
Enum: SINGLE_CARDBOXWAREHOUSE_BOXCARD_FROM_WAREHOUSEEXTERNAL_SINGLE_CARDEXTERNAL_BOX
affinity_group_idstring
Exemplo: afg-20MpN8vmIPj77ujhb9cS8ctstN2
affinity_group_namestring
Exemplo: Pomelo Nominate Basic Physical
courierobject
country_codestring
Exemplo: ARG
created_atstring
Exemplo: 2020-07-10 15:00:00.000
batchobject
addressobject
receiverobject
user_idstring
Exemplo: usr-20MpN8vmIPj77ujhb9cS8ctstN2
due_delivery_datestring
Exemplo: 2020-07-20T00:00:00.000Z
courier_additional_infoobject
request_statusstring
Enum: PENDING_UPDATE_ADDRESSCONFIRMED_UPDATE_ADDRESSREJECTED_UPDATE_ADDRESSREQUESTED_RECEIVER_DATAGOT_RECEIVER_DATAMISSING_RECEIVER_DATA
Esta seção foi útil para você?
PATCH/shipping/v1/{shipment_id}
{
"address":{
"street_name":
"Libertador"
"street_number":
"539"
"floor":
"2"
"apartment":
"B"
"city":
"Buenos Aires"
"region":
"Buenos Aires"
"country":
"Argentina"
"zip_code":
"5346"
"neighborhood":
"string"
Respostas de amostra
{
"id":
"shi-23hJL4bm94q9BFEd2sGhBjY6xbH"
"external_tracking_id":
"f923da123"
"status":
"CREATED"
"status_detail":
"CREATED"
"shipment_type":
"SINGLE_CARD"
"affinity_group_id":
"afg-20MpN8vmIPj77ujhb9cS8ctstN2"
"affinity_group_name":
"Pomelo Nominate Basic Physical"
"courier":{
"company":
"ANDREANI"
"tracking_url":
"https://www.api.qa.com/#!/informacionEnv ..."
"country_code":
"ARG"
"created_at":
"2020-07-10 15:00:00.000"
"batch":{
"id":
"bch-23WEkAaZsqubbke9pYVAt9sG81e"
"quantity":
100
"has_stock":
true
"status":
"PENDING"
"address":{
"street_name":
"Libertador"
"street_number":
"539"
"floor":
"2"
"apartment":
"B"
"city":
"Buenos Aires"
"region":
"Buenos Aires"
"country":
"Argentina"
"zip_code":
"5346"
"neighborhood":
"string"
"receiver":{
"full_name":
"Gonzalo Iglesias"
"email":
"document_type":
"dni"
"document_number":
"243432423"
"tax_identification_number":
"38912151888"
"telephone_number":
"53454342"
"user_id":
"usr-20MpN8vmIPj77ujhb9cS8ctstN2"
"due_delivery_date":
"2020-07-20T00:00:00.000Z"
"courier_additional_info":{
"received_by":
"Franco Iglesias"
"request_status":
"PENDING_UPDATE_ADDRESS"
Obter envio
O endpoint /shipping/v1/{shipment_id} é utilizado para obtenção de informações sobre uma remessa específica.
Tem dúvidas sobre os status de envio? Explicamos o significado de cada um na nossa documentação.
Considerações
Será preciso especificar o shipping_id para fazer a consulta.
Envios para um warehouse e em território mexicano:
Nos casos de envios para um warehouse e aqueles feitos dentro do México, não forneceremos um ID externo de rastreamento, mas não se preocupe! Vamos garantir que você fique atualizado sobre o status do envio através do Dashboard e também por meio de webhooks.
Parâmetros disponíveis
Header Parameters
Authorizationstringrequired
Exemplo: Bearer {access_token}
Path Parameters
shipment_idstringrequired
ID da remessaDetalhe de respostas
idstring
Exemplo: shi-23hJL4bm94q9BFEd2sGhBjY6xbH
external_tracking_idstring
Exemplo: f923da123
statusstring
Enum: CREATEDPENDINGTRACKEDREJECTEDIN_WAREHOUSEIN_TRANSITFAILED_DELIVERY_ATTEMPTDISTRIBUTIONDELIVEREDNOT_DELIVEREDSTART_OF_CUSTODYEND_OF_CUSTODYDESTRUCTIONACCIDENT
status_detailstring
Enum: CREATEDPENDINGTRACKEDREADY_FOR_DISTRIBUTIONROAD_TO_PICKUPUNSUCCESSFUL_PICKUPROAD_TO_RETURNUNSUCCESSFUL_RETURNREJECTEDSHIPMENT_SENTSHIPMENT_CONFIRMEDIN_WAREHOUSEIN_TRANSITRECEIVED_BY_CARRIERFAILED_DELIVERY_ATTEMPTWRONG_ADDRESSSHIPMENT_CONSOLIDATEDDISTRIBUTIONDELIVEREDNOT_DELIVEREDSTART_OF_CUSTODYEND_OF_CUSTODYZONE_ASSIGNEDDESTRUCTIONACCIDENTSTOLENVISIT_SCHEDULEDCALL_SCHEDULEDVISIT_CONFIRMEDCALL_FAILED_UNKNOWNNO_ACCESSFAILED_VISIT_DEADWRONG_OPERATOR_ZONECALL_RESCHEDULEDCALL_FAILED_DEADCALL_FAILEDWHATSAPP_FAILEDCOURIER_FAILEDMISSING_DOCUMENTSRETURNED_TO_WAREHOUSECLIENT_NOT_PRESENTINCOMPLETE_ADDRESSCOVERAGEOPERATOR_REASSIGNEDCLIENT_UNKNOWNNO_CALLZONE_PROBLEMSCLIENT_WORKFRAUDFRAUD_CLIENTMISSING_NUMBERCLIENT_CANCELEDDESTROYED_BY_CLIENTWEATHERLOSTCLIENT_TRIPFAILED_VISIT_UNKNOWNRETURNED
shipment_typestring
Enum: SINGLE_CARDBOXWAREHOUSE_BOXCARD_FROM_WAREHOUSEEXTERNAL_SINGLE_CARDEXTERNAL_BOX
affinity_group_idstring
Exemplo: afg-20MpN8vmIPj77ujhb9cS8ctstN2
affinity_group_namestring
Exemplo: Pomelo Nominate Basic Physical
courierobject
country_codestring
Exemplo: ARG
created_atstring
Exemplo: 2020-07-10 15:00:00.000
batchobject
addressobject
receiverobject
user_idstring
Exemplo: usr-20MpN8vmIPj77ujhb9cS8ctstN2
due_delivery_datestring
Exemplo: 2020-07-20T00:00:00.000Z
courier_additional_infoobject
request_statusstring
Enum: PENDING_UPDATE_ADDRESSCONFIRMED_UPDATE_ADDRESSREJECTED_UPDATE_ADDRESSREQUESTED_RECEIVER_DATAGOT_RECEIVER_DATAMISSING_RECEIVER_DATA
Esta seção foi útil para você?
GET/shipping/v1/{shipment_id}
Respostas de amostra
{
"id":
"shi-23hJL4bm94q9BFEd2sGhBjY6xbH"
"external_tracking_id":
"f923da123"
"status":
"CREATED"
"status_detail":
"CREATED"
"shipment_type":
"SINGLE_CARD"
"affinity_group_id":
"afg-20MpN8vmIPj77ujhb9cS8ctstN2"
"affinity_group_name":
"Pomelo Nominate Basic Physical"
"courier":{
"company":
"ANDREANI"
"tracking_url":
"https://www.api.qa.com/#!/informacionEnv ..."
"country_code":
"ARG"
"created_at":
"2020-07-10 15:00:00.000"
"batch":{
"id":
"bch-23WEkAaZsqubbke9pYVAt9sG81e"
"quantity":
100
"has_stock":
true
"status":
"PENDING"
"address":{
"street_name":
"Libertador"
"street_number":
"539"
"floor":
"2"
"apartment":
"B"
"city":
"Buenos Aires"
"region":
"Buenos Aires"
"country":
"Argentina"
"zip_code":
"5346"
"neighborhood":
"string"
"receiver":{
"full_name":
"Gonzalo Iglesias"
"email":
"document_type":
"dni"
"document_number":
"243432423"
"tax_identification_number":
"38912151888"
"telephone_number":
"53454342"
"user_id":
"usr-20MpN8vmIPj77ujhb9cS8ctstN2"
"due_delivery_date":
"2020-07-20T00:00:00.000Z"
"courier_additional_info":{
"received_by":
"Franco Iglesias"
"request_status":
"PENDING_UPDATE_ADDRESS"
Obter histórico de envio
O endpoint /shipping/v1/{shipment_id}/history permite obter o histórico de estados de um envio específico.
Tem dúvidas sobre os status de envio? Explicamos o significado de cada um na nossa documentação.
Considerações
Será preciso especificar o shipping_id para fazer a consulta.
A lista de eventos é ordenada em ordem ascendente por data de atualização, ou seja, o estado mais recente está no final da lista.
Parâmetros disponíveis
Header Parameters
Authorizationstringrequired
Exemplo: Bearer {access_token}
Path Parameters
shipment_idstringrequired
ID da remessaDetalhe de respostas
dataobject
Esta seção foi útil para você?
GET/shipping/v1/{shipment_id}/history
Respostas de amostra
{
"data":{
"id":
"shi-23hJL4bm94q9BFEd2sGhBjY6xbH"
"external_tracking_id":
"f923da123"
"failed_delivery_attempts":
1
"max_delivery_attempts":
3
"events":[
...
]Notificações dos envios
Você precisa incluir este endpoint em seu serviço para podermos enviar atualizações em tempo real sobre os envios.
Se tiver dúvidas sobre como configurar um webhook, visite nossa documentação.
Considerações
- Nas novidades, vamos mantê-lo informado sobre quaisquer atualizações relacionadas a um envio. Apenas saiba que será responsável por obter o envio para verificar o status atualizado.
- Esperamos uma resposta na faixa 2XX para garantir que você tenha recebido a notificação. Caso contrário, iremos reenviá-la.
Encontre mais informações sobre o status dos envios na nossa documentação.
Parâmetros disponíveis
Header Parameters
X-Api-Keystringrequired
Este header permitirá identificar qual api-secret deve-se usar, caso vários pares de api-key e api-secret tenham sido configurados.Exemplo: X-Api-Key: h3Ws4Cv09JcCdw7732ig+1Eq3I2b+IWOI1anUu1A4dE=
X-Signaturestringrequired
Este cabeçalho contém a assinatura digital (timestamp + endpoint + body) que deve ser verificada para garantir a integridade da solicitação. Se a assinatura não corresponder, o pedido deve ser rejeitado.Exemplo: X-Signature: hmac-sha256 kLV3Jeyn7qbKfGHLDQKKuy5xzG/kbPrYEg8RvD8jb8A=
X-Timestampstringrequired
Este header contém a hora em que a solicitação foi assinada, no formato unix-epoch, para que você possa verificar se a assinatura não expirou.Exemplo: X-Timestamp: 1637117179
X-Endpointstringrequired
O endpoint que você usou para gerar a assinatura, e para o qual é feita a solicitação. Use este header para gerar novamente a assinatura a ser validada, e compare-o com o endpoint do seu serviço para verificar se eles correspondem.Exemplo: X-Endpoint: {clientPath}/shipping/updates
Body Parameters
event_idstring
Identificador de evento.Exemplo: shipment-status-changed
shipment_idstring
ID do envio.Exemplo: shi-23hJL4bm94q9BFEd2sGhBjY6xbH
statusstring
Status do envio.Exemplo: IN_TRANSIT
status_detailstring
Detalhe do status do envio.Exemplo: RECEIVED_BY_CARRIER
request_statusstring
Status da solicitação de envio.Exemplo: PENDING_UPDATE_ADDRESS
updated_atstring
Data de AtualizaçãoExemplo: 2023-09-21T14:15:31.186Z
metaobject
idempotency_keystring
Identificador idempotente para criar o evento.Exemplo: e42c0eb9-3986-4f01-9f4a-df8d02a9a92f
Esta seção foi útil para você?
POST/shipping/updates
{
"event_id":
"shipment-status-changed"
"shipment_id":
"shi-23hJL4bm94q9BFEd2sGhBjY6xbH"
"status":
"IN_TRANSIT"
"status_detail":
"RECEIVED_BY_CARRIER"
"request_status":
"PENDING_UPDATE_ADDRESS"
"updated_at":
"2023-09-21T14:15:31.186Z"
"meta":{
"resource_url":
"https://api.pomelo.la/shipping/v1/shi-23 ..."
"idempotency_key":
"e42c0eb9-3986-4f01-9f4a-df8d02a9a92f"
Respostas de amostra
Solicitar dados do receptor
O endpoint /shipping/v1/{shipment_id}/receiver permite que você solicite os dados do destinatário que recebeu o envio.
Considerações
Você não poderá criar uma solicitação enquanto houver uma pendente para o mesmo shipment_id.
Para consultar o estado da solicitação, você precisará interagir com o endpoint Obter envio. No campo request_status, você verá um dos seguintes valores:
- REQUESTED_RECEIVER_DATA: Aguardando a transportadora compartilhar os dados do destinatário do envio.
- GOT_RECEIVER_DATA: A transportadora compartilhou os dados do destinatário do envio conosco.
- MISSING_RECEIVER_DATA: a transportadora não conseguiu compartilhar conosco os dados do envio.
Para visualizar os dados do destinatário do cartão, interaja novamente com o endpoint Obter envio e leia o campo received_by localizado dentro de courier_additional_info.
Parâmetros disponíveis
Header Parameters
Authorizationstringrequired
Exemplo: Bearer {access_token}
Path Parameters
shipment_idstringrequired
ID da remessaDetalhe de respostas
idstring
Exemplo: shi-23hJL4bm94q9BFEd2sGhBjY6xbH
external_tracking_idstring
Exemplo: f923da123
statusstring
Enum: CREATEDPENDINGTRACKEDREJECTEDIN_WAREHOUSEIN_TRANSITFAILED_DELIVERY_ATTEMPTDISTRIBUTIONDELIVEREDNOT_DELIVEREDSTART_OF_CUSTODYEND_OF_CUSTODYDESTRUCTIONACCIDENT
status_detailstring
Enum: CREATEDPENDINGTRACKEDREADY_FOR_DISTRIBUTIONROAD_TO_PICKUPUNSUCCESSFUL_PICKUPROAD_TO_RETURNUNSUCCESSFUL_RETURNREJECTEDSHIPMENT_SENTSHIPMENT_CONFIRMEDIN_WAREHOUSEIN_TRANSITRECEIVED_BY_CARRIERFAILED_DELIVERY_ATTEMPTWRONG_ADDRESSSHIPMENT_CONSOLIDATEDDISTRIBUTIONDELIVEREDNOT_DELIVEREDSTART_OF_CUSTODYEND_OF_CUSTODYZONE_ASSIGNEDDESTRUCTIONACCIDENTSTOLENVISIT_SCHEDULEDCALL_SCHEDULEDVISIT_CONFIRMEDCALL_FAILED_UNKNOWNNO_ACCESSFAILED_VISIT_DEADWRONG_OPERATOR_ZONECALL_RESCHEDULEDCALL_FAILED_DEADCALL_FAILEDWHATSAPP_FAILEDCOURIER_FAILEDMISSING_DOCUMENTSRETURNED_TO_WAREHOUSECLIENT_NOT_PRESENTINCOMPLETE_ADDRESSCOVERAGEOPERATOR_REASSIGNEDCLIENT_UNKNOWNNO_CALLZONE_PROBLEMSCLIENT_WORKFRAUDFRAUD_CLIENTMISSING_NUMBERCLIENT_CANCELEDDESTROYED_BY_CLIENTWEATHERLOSTCLIENT_TRIPFAILED_VISIT_UNKNOWNRETURNED
shipment_typestring
Enum: SINGLE_CARDBOXWAREHOUSE_BOXCARD_FROM_WAREHOUSEEXTERNAL_SINGLE_CARDEXTERNAL_BOX
affinity_group_idstring
Exemplo: afg-20MpN8vmIPj77ujhb9cS8ctstN2
affinity_group_namestring
Exemplo: Pomelo Nominate Basic Physical
courierobject
country_codestring
Exemplo: ARG
created_atstring
Exemplo: 2020-07-10 15:00:00.000
batchobject
addressobject
receiverobject
user_idstring
Exemplo: usr-20MpN8vmIPj77ujhb9cS8ctstN2
due_delivery_datestring
Exemplo: 2020-07-20T00:00:00.000Z
courier_additional_infoobject
request_statusstring
Enum: PENDING_UPDATE_ADDRESSCONFIRMED_UPDATE_ADDRESSREJECTED_UPDATE_ADDRESSREQUESTED_RECEIVER_DATAGOT_RECEIVER_DATAMISSING_RECEIVER_DATA
Esta seção foi útil para você?
POST/shipping/v1/{shipment_id}/receiver
Respostas de amostra
{
"id":
"shi-23hJL4bm94q9BFEd2sGhBjY6xbH"
"external_tracking_id":
"f923da123"
"status":
"CREATED"
"status_detail":
"CREATED"
"shipment_type":
"SINGLE_CARD"
"affinity_group_id":
"afg-20MpN8vmIPj77ujhb9cS8ctstN2"
"affinity_group_name":
"Pomelo Nominate Basic Physical"
"courier":{
"company":
"ANDREANI"
"tracking_url":
"https://www.api.qa.com/#!/informacionEnv ..."
"country_code":
"ARG"
"created_at":
"2020-07-10 15:00:00.000"
"batch":{
"id":
"bch-23WEkAaZsqubbke9pYVAt9sG81e"
"quantity":
100
"has_stock":
true
"status":
"PENDING"
"address":{
"street_name":
"Libertador"
"street_number":
"539"
"floor":
"2"
"apartment":
"B"
"city":
"Buenos Aires"
"region":
"Buenos Aires"
"country":
"Argentina"
"zip_code":
"5346"
"neighborhood":
"string"
"receiver":{
"full_name":
"Gonzalo Iglesias"
"email":
"document_type":
"dni"
"document_number":
"243432423"
"tax_identification_number":
"38912151888"
"telephone_number":
"53454342"
"user_id":
"usr-20MpN8vmIPj77ujhb9cS8ctstN2"
"due_delivery_date":
"2020-07-20T00:00:00.000Z"
"courier_additional_info":{
"received_by":
"Franco Iglesias"
"request_status":
"PENDING_UPDATE_ADDRESS"