Envios

A API de Envíos contém todos os endpoints para criar envios e obter os dados dos seus envios criados. Também encontrarás os endpoints para receber notificações sobre as novidades do estado dos seus envios mediante um webhook.

Envíos Externos

Ao definir sua integração, você poderá optar por NÃO utilizar nosso serviço de distribuição de cartões.

Nesse caso, os grupos de afinidade refletirão a configuração que você escolheu. Além disso, ao criar um cartão ou um lote de cartões, devolveremos 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 embozadora definida na integração.

Criar Envio

O endpoint /shipping/v1/ é usado para criar um novo envio de um cartão innominado. Tenha em mente que para criar um envio, é requisito que você tenha criado um lote de cartões innominados.

Considerações

O campo region corresponde a:

  • Província na Argentina
  • Estado no Brasil
  • Estado na Colômbia
  • Estado no México

O campo courier.tracking_url da resposta estará disponível assim que o envio for confirmado pelo parceiro logístico correspondente. Até lá, terá valor nulo.

Para o Brasil

  • Se você opera no Brasil, o taxIdentificationNumber sempre será obrigatório.
  • Os campos documentNumber e documentType não serão requeridos.
  • O campo additional_info não está disponível para uso.
  • Além disso, você deve preencher o campo region com o código 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, ou seja, você pode não enviá-lo.
  • O campo additional_info não está disponível para uso.

Para o México

O campo additional_info estará disponível apenas para envios que utilizem logística 99 Minutos.

Envio de cartões innominados desde depósito

Você pode associar um envio com o usuário para o qual enviará o cartão especificando o user_id no corpo do shipment.

Parâmetros disponíveis
Header Parameters
Authorizationstringrequired
Exemplo: Bearer {access_token}
x-idempotency-keystringrequired
ID único em cada solicitação para usar 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_UNKNOWNRETURNEDCARD_NOT_PERSONALIZEDCLIENT_REFUSEDCLIENT_MOVEDMAIL_BOXDEMAGE_ORDEREX_EMPLOYEECLIENT_REQUESTSTREET_NOT_EXISTSNEIGHBORHOOD_IS_MISSINGBLOCK_APARTMENT_MISSINGEXTENSION_MISSINGWAITING_EXCEEDEDSTRIKEDEMAGED_VEHICULEOTHERSCLOSEDBAD_ROUTINGINCOMPLETE_RECORD_OF_RECIPIENTS
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"
"additional_info":
"Torre 2. Casa amarilla"
}
"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"
"additional_info":
"Torre 2. Casa amarilla"
}
"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 que você busque um grupo de envios de acordo com os atributos que você especificar.

Você poderá filtrar e ordenar os envios seguindo esta documentação.

Os atributos para ordenar são:

  • shipment_type
  • status
  • status_detail
  • created_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-3
filter[user_id]string
page[size]number
Tamanho da página.
page[number]number
Número da 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} será utilizado para atualizar o endereço de entrega de um envio.

Considerações

Para atualizar o endereço de entrega, o envio deve ter como STATUS_DETAIL um dos seguintes valores de acordo com a transportadora:

CourierEstados permitidos
99 MINUTOSPENDING, SHIPMENT_CONFIRMED, RECEIVED_BY_CARRIER, ROAD_TO_PICKUP, UNSUCCESSFUL_PICKUP, UNSUCCESSFUL_PICKUP,FAILED_DELIVERY_ATTEMPT
ANDREANIPENDING, END_OF_CUSTODY, DISTRIBUTION, WRONG_ADDRESS
DOMINACALL_SCHEDULED, VISIT_SCHEDULED, CALL_FAILED_UNKNOWN, CLIENT_NOT_PRESENT, WRONG_ADDRESS, IN_TRANSIT, INCOMPLETE_ADDRESS, RECEIVED_BY_CARRIER, CALL_RESCHEDULED
ESTAFETAFAILED_DELIVERY_ATTEMPT
FLASHSTART_OF_CUSTODY

Você não poderá criar outra solicitação de mudança de endereço para um envio enquanto houver uma pendente.

Para consultar o estado da solicitação, você terá que 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: a transportadora nos confirmou a mudança de endereço de envio.
  • REJECTED_UPDATE_ADDRESS: a transportadora rejeitou a alteração de endereço de envio.

Se sua solicitação for rejeitada, você continuará vendo o endereço de envio original.

Parâmetros disponíveis
Header Parameters
Authorizationstringrequired
Exemplo: Bearer {access_token}
x-idempotency-keystringrequired
ID único em cada solicitação para usar 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_UNKNOWNRETURNEDCARD_NOT_PERSONALIZEDCLIENT_REFUSEDCLIENT_MOVEDMAIL_BOXDEMAGE_ORDEREX_EMPLOYEECLIENT_REQUESTSTREET_NOT_EXISTSNEIGHBORHOOD_IS_MISSINGBLOCK_APARTMENT_MISSINGEXTENSION_MISSINGWAITING_EXCEEDEDSTRIKEDEMAGED_VEHICULEOTHERSCLOSEDBAD_ROUTINGINCOMPLETE_RECORD_OF_RECIPIENTS
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"
"additional_info":
"Torre 2. Casa amarilla"
}
}
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"
"additional_info":
"Torre 2. Casa amarilla"
}
"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":{
"status":
"ENTREGA"
"status_detail":
"ENTREGA CERTIFICADA"
"received_by":
"Franco Iglesias"
}
"request_status":
"PENDING_UPDATE_ADDRESS"
}

Obter Envio

O endpoint /shipping/v1/{shipment_id} permite que você obtenha informações sobre um envio em particular.

Você tem dúvidas sobre o estado dos envios? Nós contamos o que significa cada um em nossa documentação.

Considerações

Você deve especificar o shipment_id para fazer a consulta.

Envíos para um armazém e em território mexicano:

Para os envios para um warehouse e também para os que são realizados no México, não devolveremos um ID externo de rastreamento, mas não se preocupe! Manteremos você informado sobre o estado do envio a partir do Dashboard e também via webhooks.

Parâmetros disponíveis
Header Parameters
Authorizationstringrequired
Exemplo: Bearer {access_token}
Path Parameters
shipment_idstringrequired
Id do envio
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_UNKNOWNRETURNEDCARD_NOT_PERSONALIZEDCLIENT_REFUSEDCLIENT_MOVEDMAIL_BOXDEMAGE_ORDEREX_EMPLOYEECLIENT_REQUESTSTREET_NOT_EXISTSNEIGHBORHOOD_IS_MISSINGBLOCK_APARTMENT_MISSINGEXTENSION_MISSINGWAITING_EXCEEDEDSTRIKEDEMAGED_VEHICULEOTHERSCLOSEDBAD_ROUTINGINCOMPLETE_RECORD_OF_RECIPIENTS
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"
"additional_info":
"Torre 2. Casa amarilla"
}
"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":{
"status":
"ENTREGA"
"status_detail":
"ENTREGA CERTIFICADA"
"received_by":
"Franco Iglesias"
}
"request_status":
"PENDING_UPDATE_ADDRESS"
}

Obter Histórico de Envio

O endpoint /shipping/v1/{shipment_id}/history permite que você obtenha o histórico de estados de um envio em particular.

Você tem dúvidas sobre o estado dos envios? Nós contamos o que significa cada um em nossa documentação.

Considerações

Você deve especificar o shipment_id para fazer a consulta.

A lista de eventos é ordenada de forma ascendente pela 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 do envio
Detalhe 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 de envios

Você deve incluir este endpoint em seu serviço para que possamos comunicar as novidades dos envios em tempo real.

Se você tiver dúvidas sobre como configurar um webhook, visite nossa documentação.

Considerações

  • Nas novidades, notificaremos se houver atualizações sobre um envio. Tenha em mente que você será responsável por obter o envio para consultar o estado atualizado.
  • Esperamos uma resposta do tipo 2XX para garantir que você recebeu a notificação. Caso contrário, iremos reenviá-la.

Encontre mais informações sobre o estado dos envios em nossa documentação.

Parâmetros disponíveis
Header Parameters
X-Api-Keystringrequired
Este header permitirá identificar qual api-secret você deve usar no caso de múltiplos pares de api-key e api-secret terem sido configurados.
Exemplo: X-Api-Key: h3Ws4Cv09JcCdw7732ig+1Eq3I2b+IWOI1anUu1A4dE=
X-Signaturestringrequired
Este header contém a assinatura digital (timestamp + endpoint + body) que você deve verificar para garantir a integridade do request. Se a assinatura não coincidir, você deve rejeitar o pedido.
Exemplo: X-Signature: hmac-sha256 kLV3Jeyn7qbKfGHLDQKKuy5xzG/kbPrYEg8RvD8jb8A=
X-Timestampstringrequired
Este header contém o momento em que o pedido foi assinado em formato unix-epoch para que você possa verificar se a assinatura não expirou.
Exemplo: X-Timestamp: 1637117179
X-Endpointstringrequired
O endpoint para o qual o pedido é feito e que você usou para gerar a assinatura. Use este cabeçalho para regenerar a assinatura a ser validada, compará-la com o endpoint do seu serviço e verificar se coincidem.
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
Estado do envio.
Exemplo: IN_TRANSIT
status_detailstring
Detalhe do estado do envio.
Exemplo: RECEIVED_BY_CARRIER
request_statusstring
Estado da solicitação do envio.
Exemplo: PENDING_UPDATE_ADDRESS
updated_atstring
Data de atualização.
Exemplo: 2023-09-21T14:15:31.186Z
metaobject
idempotency_keystring
Identificador idempotente de criação do 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 destinatário

O endpoint /shipping/v1/{shipment_id}/receiver permite que você solicite os dados de quem recebeu o envio.

Considerações

Você não poderá criar uma solicitação enquanto houver uma pendente para esse mesmo shipment_id.

Para consultar o estado da solicitação, você terá que interagir com o endpoint Obter envio. No campo request_status você verá um dos seguintes valores:

  • REQUESTED_RECEIVER_DATA: aguardando que a transportadora nos compartilhe os dados do receptor do envio.
  • GOT_RECEIVER_DATA: a transportadora nos compartilhou os dados do receptor do envio.
  • MISSING_RECEIVER_DATA: a transportadora não pôde compartilhar os dados do receptor do envio.

Para ver os dados do receptor do cartão, interaja novamente com o endpoint Obter envio e leia o campo received_by que se encontra dentro de courier_additional_info.

Parâmetros disponíveis
Header Parameters
Authorizationstringrequired
Exemplo: Bearer {access_token}
Path Parameters
shipment_idstringrequired
Id do envio
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_UNKNOWNRETURNEDCARD_NOT_PERSONALIZEDCLIENT_REFUSEDCLIENT_MOVEDMAIL_BOXDEMAGE_ORDEREX_EMPLOYEECLIENT_REQUESTSTREET_NOT_EXISTSNEIGHBORHOOD_IS_MISSINGBLOCK_APARTMENT_MISSINGEXTENSION_MISSINGWAITING_EXCEEDEDSTRIKEDEMAGED_VEHICULEOTHERSCLOSEDBAD_ROUTINGINCOMPLETE_RECORD_OF_RECIPIENTS
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"
"additional_info":
"Torre 2. Casa amarilla"
}
"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":{
"status":
"ENTREGA"
"status_detail":
"ENTREGA CERTIFICADA"
"received_by":
"Franco Iglesias"
}
"request_status":
"PENDING_UPDATE_ADDRESS"
}