API Reference
Shipments
The Shipments API contains all the endpoints to create shipments and retrieve the data of your created shipments. You will also find the endpoints to receive notifications about the status updates of your shipments via a webhook.
External shipments
When defining your integration, you can choose NOT to use our card distribution service.
In that case, the affinity groups will reflect the configuration you have chosen. Additionally, when creating a card or a batch of cards, we will return an identifier in the shipment_id field, which we recommend you store in your integration as you will need it to make the pickup. The cards will be available for pickup at the embossing plant defined in the integration.
Create Shipment
The endpoint /shipping/v1/ is used to create a new shipment of an innominated card. Keep in mind that to create a shipment, it is required that you have created a batch of innominated cards..
Considerations
The region field corresponds to:
- Province in Argentina
- Status in Brazil
- Status in Colombia
- Status in Mexico
The courier.tracking_url field in the response will be available once the shipment is confirmed by the corresponding logistics partner. Until then, it will have a null value.
For Brazil
- If you operate in Brazil, the taxIdentificationNumber will always be mandatory.
- The fields
documentNumberanddocumentTypewill not be required. - The
additional_infofield is not available for use. - Additionally, you must complete the
regionfield with the two-character UF code. Example: 'SP' for 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)
For Colombia
- If you operate in Colombia, the
zip_codefield is optional, meaning you may choose not to send it. - The
additional_infofield is not available for use.
For Mexico
The additional_info field will be available only for shipments using 99 Minutes logistics.
Card shipping of innominated cards from deposit
You can associate a shipment with the user to whom you will send the card by specifying the user_id in the body of the shipment.
Available parameters
Header Parameters
Authorizationstringrequired
Example: Bearer {access_token}
x-idempotency-keystringrequired
Unique ID in each request to use our idempotency scheme.Example: fRwX12Dg3345AD
Body Parameters
shipment_typestringrequired
Enum: CARD_FROM_WAREHOUSE
affinity_group_idstringrequired
Example: afg-20MpN8vmIPj77ujhb9cS8ctstN2
countrystringrequired
Example: ARG
addressobjectrequired
receiverobjectrequired
user_idstring
Example: usr-20MpN8vmIPj77ujhb9cS8ctstN2
Response details
idstring
Example: shi-23hJL4bm94q9BFEd2sGhBjY6xbH
external_tracking_idstring
Example: 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
Example: afg-20MpN8vmIPj77ujhb9cS8ctstN2
affinity_group_namestring
Example: Pomelo Nominate Basic Physical
courierobject
country_codestring
Example: ARG
created_atstring
Example: 2020-07-10 15:00:00.000
batchobject
addressobject
receiverobject
user_idstring
Example: usr-20MpN8vmIPj77ujhb9cS8ctstN2
Was this section helpful to you?
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"
Response examples
{
"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"
Search Shipments
The endpoint /shipping/v1/ allows you to search for a group of shipments based on the attributes you specify.
You will be able to filter and sort the shipments following this documentation.
The attributes for sorting are:
shipment_typestatusstatus_detailcreated_at
Available parameters
Header Parameters
Authorizationstringrequired
Example: 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
Page size.page[number]number
Page number. The number of the first page is 0.sortstring
Example: pid, shipment_type, status, status_detail
Response details
dataarray
metaobject
Was this section helpful to you?
GET/shipping/v1
Response examples
{
"data":[
0:{
...
}"meta":{
"pagination":{
...
}"filter":[
...
]Change shipping information
The endpoint /shipping/v1/{shipment_id} will be used to update the delivery address of a shipment.
Considerations
To update the delivery address, the shipment must have a STATUS_DETAIL of one of the following values according to the carrier:
| Courier | Allowed statuses |
|---|---|
| 99 MINUTOS | PENDING, SHIPMENT_CONFIRMED, RECEIVED_BY_CARRIER, ROAD_TO_PICKUP, UNSUCCESSFUL_PICKUP, UNSUCCESSFUL_PICKUP,FAILED_DELIVERY_ATTEMPT |
| 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 |
You will not be able to create another address change request for a shipment while there is one pending.
To check the status of the request, you will need to interact with the endpoint Get shipping. In the request_status field, you will see one of the following values:
- PENDING_UPDATE_ADDRESS: waiting for the carrier's response.
- CONFIRMED_UPDATE_ADDRESS: the carrier confirmed the change of shipping address.
- REJECTED_UPDATE_ADDRESS: the carrier rejected the address change for the shipment.
If your request is rejected, you will continue to see the original shipping address.
Available parameters
Header Parameters
Authorizationstringrequired
Example: Bearer {access_token}
x-idempotency-keystringrequired
Unique ID in each request to use our idempotency scheme.Example: fRwX12Dg3345AD
Body Parameters
addressobject
Response details
idstring
Example: shi-23hJL4bm94q9BFEd2sGhBjY6xbH
external_tracking_idstring
Example: 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
Example: afg-20MpN8vmIPj77ujhb9cS8ctstN2
affinity_group_namestring
Example: Pomelo Nominate Basic Physical
courierobject
country_codestring
Example: ARG
created_atstring
Example: 2020-07-10 15:00:00.000
batchobject
addressobject
receiverobject
user_idstring
Example: usr-20MpN8vmIPj77ujhb9cS8ctstN2
due_delivery_datestring
Example: 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
Was this section helpful to you?
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"
Response examples
{
"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"
Get Shipping
The endpoint /shipping/v1/{shipment_id} allows you to obtain information about a particular shipment.
Do you have questions about the status of the shipments? We explain what each one means in our documentation.
Considerations
You must specify the shipment_id to make the inquiry.
Shipments to a warehouse and within Mexican territory:
For shipments to a warehouse and also for those made in Mexico, we will not return an external tracking ID, but don't worry! We will keep you informed about the status of the shipment from the Dashboard and also via webhooks.
Available parameters
Header Parameters
Authorizationstringrequired
Example: Bearer {access_token}
Path Parameters
shipment_idstringrequired
Shipment IDResponse details
idstring
Example: shi-23hJL4bm94q9BFEd2sGhBjY6xbH
external_tracking_idstring
Example: 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
Example: afg-20MpN8vmIPj77ujhb9cS8ctstN2
affinity_group_namestring
Example: Pomelo Nominate Basic Physical
courierobject
country_codestring
Example: ARG
created_atstring
Example: 2020-07-10 15:00:00.000
batchobject
addressobject
receiverobject
user_idstring
Example: usr-20MpN8vmIPj77ujhb9cS8ctstN2
due_delivery_datestring
Example: 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
Was this section helpful to you?
GET/shipping/v1/{shipment_id}
Response examples
{
"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"
Get Shipping History
The endpoint /shipping/v1/{shipment_id}/history allows you to obtain the status history of a particular shipment.
Do you have questions about the status of the shipments? We explain what each one means in our documentation.
Considerations
You must specify the shipment_id to make the inquiry.
The list of events is ordered in ascending order by update date, meaning the most recent status is at the end of the list.
Available parameters
Header Parameters
Authorizationstringrequired
Example: Bearer {access_token}
Path Parameters
shipment_idstringrequired
Shipment IDResponse details
dataobject
Was this section helpful to you?
GET/shipping/v1/{shipment_id}/history
Response examples
{
"data":{
"id":
"shi-23hJL4bm94q9BFEd2sGhBjY6xbH"
"external_tracking_id":
"f923da123"
"failed_delivery_attempts":
1
"max_delivery_attempts":
3
"events":[
...
]Shipping notifications
You must include this endpoint in your service so that we can communicate shipping updates to you in real time.
If you have questions about how to set up a webhook, visit our documentation.
Considerations
- In the updates, we will notify you if there are updates regarding a shipment. Keep in mind that you will be responsible for obtaining the shipment to check the updated status.
- We expect a response of type 2XX to ensure that you received the notification. Otherwise, we will resend it.
Find more information about the status of shipments in our documentation.
Available parameters
Header Parameters
X-Api-Keystringrequired
This header will allow you to identify which api-secret you need to use in case multiple pairs of api-key and api-secret have been configured.Example: X-Api-Key: h3Ws4Cv09JcCdw7732ig+1Eq3I2b+IWOI1anUu1A4dE=
X-Signaturestringrequired
This header contains the digital signature (timestamp + endpoint + body) that you must verify to ensure the integrity of the request. If the signature does not match, you must reject the order.Example: X-Signature: hmac-sha256 kLV3Jeyn7qbKfGHLDQKKuy5xzG/kbPrYEg8RvD8jb8A=
X-Timestampstringrequired
This header contains the moment when the order was signed in unix-epoch format so you can verify that the signature has not expired.Example: X-Timestamp: 1637117179
X-Endpointstringrequired
The endpoint to which the request is made and you used to generate the signature. Use this header to regenerate the signature to validate, compare it with your service endpoint, and verify that they match.Example: X-Endpoint: {clientPath}/shipping/updates
Body Parameters
event_idstring
Event identifier.Example: shipment-status-changed
shipment_idstring
Shipment ID.Example: shi-23hJL4bm94q9BFEd2sGhBjY6xbH
statusstring
Status of the shipment.Example: IN_TRANSIT
status_detailstring
Shipment status details.Example: RECEIVED_BY_CARRIER
request_statusstring
Status of the shipment request.Example: PENDING_UPDATE_ADDRESS
updated_atstring
Update date.Example: 2023-09-21T14:15:31.186Z
metaobject
idempotency_keystring
Idempotent identifier for event creation.Example: e42c0eb9-3986-4f01-9f4a-df8d02a9a92f
Was this section helpful to you?
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"
Response examples
Request recipient details
The endpoint /shipping/v1/{shipment_id}/receiver allows you to request the details of the person who received the shipment.
Considerations
You will not be able to create a request while there is a pending one for that same shipment_id.
To check the status of the request, you will need to interact with the endpoint Get shipping. In the request_status field, you will see one of the following values:
- REQUESTED_RECEIVER_DATA: waiting for the carrier to share the recipient's data for the shipment.
- GOT_RECEIVER_DATA: the carrier shared the receiver data of the shipment with us.
- MISSING_RECEIVER_DATA: the carrier was unable to share the receiver data of the shipment with us.
To see the card recipient's data, interact again with the endpoint Get shipping and read the received_by field found within courier_additional_info.
Available parameters
Header Parameters
Authorizationstringrequired
Example: Bearer {access_token}
Path Parameters
shipment_idstringrequired
Shipment IDResponse details
idstring
Example: shi-23hJL4bm94q9BFEd2sGhBjY6xbH
external_tracking_idstring
Example: 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
Example: afg-20MpN8vmIPj77ujhb9cS8ctstN2
affinity_group_namestring
Example: Pomelo Nominate Basic Physical
courierobject
country_codestring
Example: ARG
created_atstring
Example: 2020-07-10 15:00:00.000
batchobject
addressobject
receiverobject
user_idstring
Example: usr-20MpN8vmIPj77ujhb9cS8ctstN2
due_delivery_datestring
Example: 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
Was this section helpful to you?
POST/shipping/v1/{shipment_id}/receiver
Response examples
{
"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"