Orders: Shipment, Quality Check and Payment
After the Customer has accepted one or more Offers made by a Buyback Platform Buyer, as seen on the Evaluating Offers page, an Order with the accepted Items is created.
To handle Orders, you will need primarly one identifier: the orderId sent on the response body of the Offers Evaluation endpoint.
After creating an Order, the Customer must inform the platform of the delivery method and will be able to choose between available shipment options for pick-up or drop-off to a courier point. To make this selection, it is necessary to get the available shipment types by querying the existing Shipment Capabilities.
Endpoint: Shipment Capabilities
To get the available shipment types PickUp allowed and/or DropOff allowed, the customer can make a request to GET Shipment Capabilities endpoint:
GET /v2/sellers/{sellerId}/orders/{orderId}/shipment-capabilities
Endpoints: Pickup Capabilities and Requests
For pick-up delivery option, the Customer must inform the platform of a set of date and time slots for the Order to be picked up. In Platform words, the Customer must create a Pickup Request.
To create a Pickup Request, the Customer can choose from a set of date and time slots where the Pickup is available. These are listed via the GET Pickup Capabilities endpoint:
GET /v2/sellers/{sellerId}/orders/{orderId}/pickup-capabilities
With this information, the Pickup Request creation is done via the POST Pickup Request endpoint:
POST /v2/sellers/{sellerId}/orders/{orderId}/pickup-request
Endpoints: DropOff Requests
For drop-off delivery option instead a pick-up the Customer must create a DropOff Request.
The DropOff Request creation is done via the POST DropOff Request endpoint:
POST /v2/sellers/{sellerId}/orders/{orderId}/dropoff-request
Endpoints: Order Payment Details Requests
To Inform the payment details such as bank account and billing address for one order when payment type is Cash, the customer must create a Payment Details request.
The Payment details request is done via the POST Payment Details endpoint:
POST /v2/sellers/{sellerId}/orders/{orderId}/payment-details
Order Events
After creating a new Pickup Request, the Buyer of the Order will then proceed with the following steps:
- Pickup Schedule - pickup scheduling for the requested timeslot. Here it will be provided the Order Invoice, Shipping Document (Waybill) and Tracking Number;
- Order Tracking - shipment status informing if the Item is either In Transit, Received at the Warehouse or if the Customer has a Missed Pickup;
- Quality Check - check if the Items pass or not the Quality Check process;
- Finalize - close the Order and confirm the Payment can be executed.
After creating a new DropOff Request instead of a Pickup Request, the Buyer of the Order will then proceed with the following steps:
- DropOff Pending - the Buyer initiates shipping by selecting DropOff. Here it will be provided the Order Invoice, Shipping Document (Waybill) and Tracking Number;
- Order Tracking - shipment status informing if the Item is either In Transit or Received at the Warehouse;
- Quality Check - check if the Items pass or not the Quality Check process;
- Finalize - close the Order and confirm the Payment can be executed.
All of the steps mentioned above change the status of the Order and its Items and can be tracked via the Events described below.
Event: Order Created
Once the Customer has accepted one or more Offers, an Order is created and an OrderCreatedEvent is raised.
Payload
json
{
"type": "OrderCreatedEvent",
"token": "ffba2e99-4316-4860-a3a2-6d67ebb58d96",
"result": {
"id": "a989e247-ea7d-4ca5-823f-4a2beca861be",
"timestamp": "2022-11-21T14:29:06.868057Z",
"order": {
"id": "a989e247-ea7d-4ca5-823f-4a2beca861be",
"externalOrderId": "ExternalOrderId1",
"externalReference": "OC123456",
"submissionExternalReference": "QC123456",
"commercialInvoiceUrl": "CommercialInvoiceUrl1",
"countryOfOrigin": "PT",
"customerInformation": {
"firstName": "FirstName1",
"lastName": "LastName1",
"email": "customer@trade-in.com",
"address": {
"firstLine": "FirstLine1",
"secondLine": "SecondLine1",
"zipCode": "ZipCode1",
"city": "Lisbon",
"state": "Lisbon",
"country": "Portugal",
"timezone": "Europe/Lisbon"
},
"telephoneNumber": {
"countryCode": "351",
"number": "910456789"
},
"externalUserId": "ABCDEFGHHJ"
},
"items": [
{
"id": "83f94362-52f2-4072-8679-bba09a5bf76a",
"status": "Created",
"category": {
"id": "58232508-12d8-4645-abba-0a38e4e39e81",
"name": "Bag"
},
"brand": {
"id": "cfe0b00e-f184-46c9-af0b-540d7ed641b7",
"name": "Brand"
},
"model": "Model1",
"description": "Description1",
"attributes": [
{
"id": "1a3abd07-75e0-4af7-853e-10eea208fbb7",
"name": "Size",
"values": [
{
"id": "5bb39d34-4f72-4410-8cdc-e83f0e8a16c4",
"label": "Label"
}
]
}
],
"offers": [
{
"id": "e24c9ffd-2000-479a-9ad1-9908519feccc",
"basePrice": {
"currencyIsoCode": "EUR",
"amount": 100
},
"totalPrice": {
"currencyIsoCode": "EUR",
"amount": 110
},
"status": "WinningOffer",
"promotions": [
{
"name": "Name1",
"price": {
"currencyIsoCode": "EUR",
"amount": 10
},
"percentage": 1
}
]
}
],
"files": [
{
"type": "Photos",
"location": "https://image.png",
"metadata": {
"type": "Additional",
"subType": "Inside"
}
}
],
"returns": [],
"rejectionReasons": []
}
]
}
}
}Result Object
| Field | Description |
|---|---|
| timestamp | Event Timestamp. |
| id | Order Identifier. |
| order | Order object. |
Order Object
| Field | Description |
|---|---|
| externalOrderId | External Order identifier. |
| externalReference | Order user-friendly reference. Generated internally by the Platform. |
| submissionExternalReference | Submission user-friendly reference. Generated internally by the Platform. |
| countryOfOrigin | Country ISO 3166-1 Alpha-2 code. |
| customerInformation | Customer personal information. |
| items | Items from the accepted Offers. |
Customer Information Object
| Field | Description |
|---|---|
| name | First name. |
| lastname | Last name. |
| Email. | |
| address.firstLine | First line. |
| address.secondLine | Second line. |
| address.zipCode | ZIP code. |
| address.city | City. |
| address.state | State. |
| address.country | Country ISO 3166-1 Alpha-2 code. |
| telephoneNumber.countryCode | ITU Dialing Code. |
| telephoneNumber.number | Telephone Number. |
| timezone | IANA timezone. |
Order Item Object
| Field | Description |
|---|---|
| id | Item identifier. This identifier is the same as the Submission item. |
| status | Item Status. |
| category.id | Category identifier. |
| category.name | Category name. |
| brand.id | Brand identifier. |
| brand.name | Brand name. |
| model | Model. |
| description | Description sent by the customer. |
| attributes | List of Item attributes. |
| offers | List of Item Offers. |
| files | List of Item assets. |
Order Item Attribute Object
| Field | Description |
|---|---|
| id | Attribute type identifier. |
| name | Attribute type name. |
| values.id | Attribute Value identifier. |
| values.label | Attribute Value option name. |
Order Item Offer Object
| Field | Description |
|---|---|
| id | Offer identifier. This is the same as the Submission Item Offer identifier. |
| status | Status of the Order Item Offer. One of the following: WinningOffer. |
| basePrice | Price without promotions. |
| totalPrice | Price with promotions added. |
| promotions | List of promotions applied to the item. |
Price Object
| Field | Description |
|---|---|
| currencyIsoCode | Currency ISO 4217 three-letter code. |
| amount | Offered amount. |
Order Item File Object
| Field | Description |
|---|---|
| type | File type. One of the following: Photos, Others. |
| location | URL with the given asset. |
| metadata | Extra metadata of the file, such as the Photo Type or Subtype. |
Event: Pickup Scheduled
Triggered when the Pickup has been scheduled by the Buyer. Once this happens, the Invoice and the Air Waybill are made available in the Platform. They are mandatory documents for the Shipment process to happen.
json
{
"type": "CollectionItemPickUpScheduledEvent",
"token": "ffba2e99-4316-4860-a3a2-6d67ebb58d96",
"result": {
"timestamp": "2022-10-10T14:29:10.8409227Z",
"collectionId": "a989e247-ea7d-4ca5-823f-4a2beca861be",
"itemId": "a6182370-602a-4039-9119-e15438c0788b",
"initialSlot": "2022-10-20T09:00:00+00:00",
"finalSlot": "2022-10-20T15:00:00+00:00",
"isReschedule": false,
"commercialInvoiceUrl": "http://my-invoices.net/invoice.pdf",
"shipment": {
"id": "e3d8973b-f636-4a78-a0d4-26c922af5430",
"waybillUrl": "https://my-waybill.net/file.pdf",
"trackingCode": "123456789",
"carrier": "DHLExpress",
"mergedDocuments": "https://my-docs.net/merged-docs.pdf"
},
"order": {
"id": "a989e247-ea7d-4ca5-823f-4a2beca861be",
"externalOrderId": "ExternalOrderId1",
"externalReference": "OC123456",
"submissionExternalReference": "QC123456",
"commercialInvoiceUrl": "http://my-invoices.net/invoice.pdf",
"countryOfOrigin": "PT",
"status": "PickupScheduled",
"customerInformation": {
"firstName": "FirstName1",
"lastName": "LastName1",
"email": "customer@trade-in.com",
"address": {
"firstLine": "FirstLine1",
"secondLine": "SecondLine1",
"zipCode": "ZipCode1",
"city": "Lisbon",
"state": "Lisbon",
"country": "Portugal",
"timezone": "Europe/Lisbon"
},
"telephoneNumber": {
"countryCode": "351",
"number": "910456789"
},
"externalUserId": "ABCDEFGHHJ"
},
"items": [
{
"id": "83f94362-52f2-4072-8679-bba09a5bf76a",
"status": "PickUpScheduled",
"category": {
"id": "58232508-12d8-4645-abba-0a38e4e39e81",
"name": "Bag"
},
"brand": {
"id": "cfe0b00e-f184-46c9-af0b-540d7ed641b7",
"name": "Brand"
},
"model": "Model1",
"description": "Description1",
"attributes": [
{
"id": "1a3abd07-75e0-4af7-853e-10eea208fbb7",
"name": "Size",
"values": [
{
"id": "5bb39d34-4f72-4410-8cdc-e83f0e8a16c4",
"label": "Label"
}
]
}
],
"offers": [
{
"id": "e24c9ffd-2000-479a-9ad1-9908519feccc",
"basePrice": {
"currencyIsoCode": "EUR",
"amount": 100
},
"totalPrice": {
"currencyIsoCode": "EUR",
"amount": 110
},
"status": "WinningOffer",
"promotions": [
{
"name": "Name1",
"price": {
"currencyIsoCode": "EUR",
"amount": 10
},
"percentage": 1
}
]
}
],
"files": [
{
"type": "Photos",
"location": "https://image.png",
"metadata": {
"type": "Additional",
"subType": "Inside"
}
}
]
}
]
}
}
}Result Object
| Field | Description |
|---|---|
| timestamp | Event Timestamp. |
| collectionId | Collection (Order) Identifier. |
| itemId | Item Identifier. This is the same Identifier from the Submission Item. |
| initialSlot | Initial slot where the Pickup should happen. DateTime sent in UTC. |
| finalSlot | Final slot where the Pickup should happen. DateTime sent in UTC. |
| commercialInvoiceUrl | URL with the Commercial Invoice. Required for packaging and Customs. |
| isReschedule | Indicates if this has been a reschedule. |
| shipment | Object with scheduled Shipment information. |
| order | Object with the entire Order information. |
Shipment Object
| Field | Description |
|---|---|
| id | Shipment identifier. |
| waybillUrl | URL with the Air Waybill. Required for packaging and Customs. |
| trackingCode | Shipment tracking code. |
| carrier | Carrier responsible by the Shipment. |
| mergedDocuments | URL with a merged document containing the Air Waybill and the Commercial Invoice. Required for packaging and Customs. |
Order Object
Same object used in the OrderCreatedEvent.
Event: Pickup Reminder
Triggered 1 day before the collection date is due. Use this event to trigger the Collection Date Reminder communication.
json
{
"type": "OrderPickupReminderEvent",
"token": "6972cce1-4afc-4408-ae78-15392b692f41",
"result": {
"id": "8e2e798f-d42a-40b7-9444-d539fa96ee82",
"timestamp": "2022-11-21T14:29:07.125404Z",
"withinDays": 1,
"order": {
"id": "a989e247-ea7d-4ca5-823f-4a2beca861be",
"externalOrderId": "ExternalOrderId1",
"externalReference": "OC123456",
"submissionExternalReference": "QC123456",
"commercialInvoiceUrl": "http://my-invoices.net/invoice.pdf",
"countryOfOrigin": "PT",
"status": "PickupScheduled",
"customerInformation": {
"firstName": "FirstName1",
"lastName": "LastName1",
"email": "customer@trade-in.com",
"address": {
"firstLine": "FirstLine1",
"secondLine": "SecondLine1",
"zipCode": "ZipCode1",
"city": "Lisbon",
"state": "Lisbon",
"country": "Portugal",
"timezone": "Europe/Lisbon"
},
"telephoneNumber": {
"countryCode": "351",
"number": "910456789"
},
"externalUserId": "ABCDEFGHHJ"
},
"items": [
{
"id": "83f94362-52f2-4072-8679-bba09a5bf76a",
"status": "PickUpScheduled",
"category": {
"id": "58232508-12d8-4645-abba-0a38e4e39e81",
"name": "Bag"
},
"brand": {
"id": "cfe0b00e-f184-46c9-af0b-540d7ed641b7",
"name": "Brand"
},
"model": "Model1",
"description": "Description1",
"attributes": [
{
"id": "1a3abd07-75e0-4af7-853e-10eea208fbb7",
"name": "Size",
"values": [
{
"id": "5bb39d34-4f72-4410-8cdc-e83f0e8a16c4",
"label": "Label"
}
]
}
],
"offers": [
{
"id": "e24c9ffd-2000-479a-9ad1-9908519feccc",
"basePrice": {
"currencyIsoCode": "EUR",
"amount": 100
},
"totalPrice": {
"currencyIsoCode": "EUR",
"amount": 110
},
"status": "WinningOffer",
"promotions": [
{
"name": "Name1",
"price": {
"currencyIsoCode": "EUR",
"amount": 10
},
"percentage": 1
}
]
}
],
"files": [
{
"type": "Photos",
"location": "https://image.png",
"metadata": {
"type": "Additional",
"subType": "Inside"
}
}
]
}
],
"shipments": [
{
"id": "00000000-0000-0000-0000-000000000000",
"waybillUrl": "http://my-docs.com/waybill.pdf",
"trackingCode": "TrackingCode1",
"carrier": "Carrier1",
"mergedDocuments": "http://my-docs.com/merged-invoice-waybill.pdf"
}
]
}
}
}Result Object
| Field | Description |
|---|---|
| timestamp | Event Timestamp. |
| collectionId | Collection (Order) Identifier. |
| withinDays | Number of days when the Pickup will happen. |
| shipment | Object with scheduled Shipment information. |
| order | Object with the entire Order information. |
Order Object
Same object used in the Pickup Scheduled Event.
Shipment Object
Same object used in the Pickup Scheduled Event.
Event: Pickup Missed
Triggered when there was as issue with the courier or the Customer has missed the Collection slot. In this case, a new call to the Pickup Request endpoint should be made so that the Buyer is informed about the new preferred dates for the Customer and through that to reschedule the Pickup. Use this event to trigger the Missed Collection communication.
json
{
"type": "CollectionItemPickupMissedEvent",
"token": "ffba2e99-4316-4860-a3a2-6d67ebb58d96",
"result": {
"timestamp": "2022-10-10T14:29:10.8409227Z",
"collectionId": "a989e247-ea7d-4ca5-823f-4a2beca861be",
"itemId": "a6182370-602a-4039-9119-e15438c0788b",
"shipment": {
"id": "e3d8973b-f636-4a78-a0d4-26c922af5430",
"waybillUrl": "https://my-waybill.net/file.pdf",
"trackingCode": "123456789",
"carrier": "DHLExpress",
"mergedDocuments": "https://my-docs.net/merged-docs.pdf"
},
"order": {
"id": "a989e247-ea7d-4ca5-823f-4a2beca861be",
"externalOrderId": "ExternalOrderId1",
"externalReference": "OC123456",
"submissionExternalReference": "QC123456",
"commercialInvoiceUrl": "http://my-invoices.net/invoice.pdf",
"countryOfOrigin": "PT",
"status": "MissedPickup",
"customerInformation": {
"firstName": "FirstName1",
"lastName": "LastName1",
"email": "customer@trade-in.com",
"address": {
"firstLine": "FirstLine1",
"secondLine": "SecondLine1",
"zipCode": "ZipCode1",
"city": "Lisbon",
"state": "Lisbon",
"country": "Portugal",
"timezone": "Europe/Lisbon"
},
"telephoneNumber": {
"countryCode": "351",
"number": "910456789"
},
"externalUserId": "ABCDEFGHHJ"
},
"items": [
{
"id": "83f94362-52f2-4072-8679-bba09a5bf76a",
"status": "MissedPickUp",
"category": {
"id": "58232508-12d8-4645-abba-0a38e4e39e81",
"name": "Bag"
},
"brand": {
"id": "cfe0b00e-f184-46c9-af0b-540d7ed641b7",
"name": "Brand"
},
"model": "Model1",
"description": "Description1",
"attributes": [
{
"id": "1a3abd07-75e0-4af7-853e-10eea208fbb7",
"name": "Size",
"values": [
{
"id": "5bb39d34-4f72-4410-8cdc-e83f0e8a16c4",
"label": "Label"
}
]
}
],
"offers": [
{
"id": "e24c9ffd-2000-479a-9ad1-9908519feccc",
"basePrice": {
"currencyIsoCode": "EUR",
"amount": 100
},
"totalPrice": {
"currencyIsoCode": "EUR",
"amount": 110
},
"status": "WinningOffer",
"promotions": [
{
"name": "Name1",
"price": {
"currencyIsoCode": "EUR",
"amount": 10
},
"percentage": 1
}
]
}
],
"files": [
{
"type": "Photos",
"location": "https://image.png",
"metadata": {
"type": "Additional",
"subType": "Inside"
}
}
]
}
],
"shipments": [
{
"id": "e3d8973b-f636-4a78-a0d4-26c922af5430",
"waybillUrl": "https://my-waybill.net/file.pdf",
"trackingCode": "123456789",
"carrier": "DHLExpress",
"mergedDocuments": "https://my-docs.net/merged-docs.pdf"
}
]
}
}
}Result Object
| Field | Description |
|---|---|
| collectionId | Collection (Order) Identifier. |
| timestamp | Event Timestamp. |
| itemId | Item Identifier. This is the same Identifier from the Submission Item. |
| shipment | Object with scheduled Shipment information. |
| order | Object with the entire Order information. |
Order Object
Same object used in the Pickup Scheduled Event.
Shipment Object
Same object used in the Pickup Scheduled Event.
Event: Item In Transit
In the case of the Pickup has been handled by Luxclusif, this event is sent when the Item has been picked at the Customer Address and is in transit.
json
{
"type": "CollectionItemInTransitEvent",
"token": "ffba2e99-4316-4860-a3a2-6d67ebb58d96",
"result": {
"timestamp": "2022-10-10T14:29:10.8409227Z",
"collectionId": "a989e247-ea7d-4ca5-823f-4a2beca861be",
"itemId": "a6182370-602a-4039-9119-e15438c0788b",
"shipment": {
"id": "e3d8973b-f636-4a78-a0d4-26c922af5430",
"waybillUrl": "https://my-waybill.net/file.pdf",
"trackingCode": "123456789",
"carrier": "DHLExpress",
"mergedDocuments": "https://my-docs.net/merged-docs.pdf"
},
"order": {
"id": "a989e247-ea7d-4ca5-823f-4a2beca861be",
"externalOrderId": "ExternalOrderId1",
"externalReference": "OC123456",
"submissionExternalReference": "QC123456",
"commercialInvoiceUrl": "http://my-invoices.net/invoice.pdf",
"countryOfOrigin": "PT",
"status": "InTransit",
"customerInformation": {
"firstName": "FirstName1",
"lastName": "LastName1",
"email": "customer@trade-in.com",
"address": {
"firstLine": "FirstLine1",
"secondLine": "SecondLine1",
"zipCode": "ZipCode1",
"city": "Lisbon",
"state": "Lisbon",
"country": "Portugal",
"timezone": "Europe/Lisbon"
},
"telephoneNumber": {
"countryCode": "351",
"number": "910456789"
},
"externalUserId": "ABCDEFGHHJ"
},
"items": [
{
"id": "83f94362-52f2-4072-8679-bba09a5bf76a",
"status": "InTransit",
"category": {
"id": "58232508-12d8-4645-abba-0a38e4e39e81",
"name": "Bag"
},
"brand": {
"id": "cfe0b00e-f184-46c9-af0b-540d7ed641b7",
"name": "Brand"
},
"model": "Model1",
"description": "Description1",
"attributes": [
{
"id": "1a3abd07-75e0-4af7-853e-10eea208fbb7",
"name": "Size",
"values": [
{
"id": "5bb39d34-4f72-4410-8cdc-e83f0e8a16c4",
"label": "Label"
}
]
}
],
"offers": [
{
"id": "e24c9ffd-2000-479a-9ad1-9908519feccc",
"basePrice": {
"currencyIsoCode": "EUR",
"amount": 100
},
"totalPrice": {
"currencyIsoCode": "EUR",
"amount": 110
},
"status": "WinningOffer",
"promotions": [
{
"name": "Name1",
"price": {
"currencyIsoCode": "EUR",
"amount": 10
},
"percentage": 1
}
]
}
],
"files": [
{
"type": "Photos",
"location": "https://image.png",
"metadata": {
"type": "Additional",
"subType": "Inside"
}
}
]
}
],
"shipments": [
{
"id": "e3d8973b-f636-4a78-a0d4-26c922af5430",
"waybillUrl": "https://my-waybill.net/file.pdf",
"trackingCode": "123456789",
"carrier": "DHLExpress",
"mergedDocuments": "https://my-docs.net/merged-docs.pdf"
}
]
}
}
}Result Object
| Field | Description |
|---|---|
| collectionId | Collection (Order) Identifier. |
| timestamp | Event Timestamp. |
| itemId | Item Identifier. This is the same Identifier from the Submission Item. |
| shipment | Object with scheduled Shipment information. |
| order | Object with the entire Order information. |
Order Object
Same object used in the Pickup Scheduled Event.
Shipment Object
Same object used in the Pickup Scheduled Event.
Event: Item Received at the Warehouse
Triggered when the item has been received at the warehouse. Use this event to trigger the Item Received communication.
json
{
"type": "CollectionItemReceivedEvent",
"token": "ffba2e99-4316-4860-a3a2-6d67ebb58d96",
"result": {
"timestamp": "2022-10-10T14:29:10.8409227Z",
"collectionId": "a989e247-ea7d-4ca5-823f-4a2beca861be",
"itemId": "a6182370-602a-4039-9119-e15438c0788b",
"shipment": {
"id": "e3d8973b-f636-4a78-a0d4-26c922af5430",
"waybillUrl": "https://my-waybill.net/file.pdf",
"trackingCode": "123456789",
"carrier": "DHLExpress",
"mergedDocuments": "https://my-docs.net/merged-docs.pdf"
},
"order": {
"id": "a989e247-ea7d-4ca5-823f-4a2beca861be",
"externalOrderId": "ExternalOrderId1",
"externalReference": "OC123456",
"submissionExternalReference": "QC123456",
"commercialInvoiceUrl": "http://my-invoices.net/invoice.pdf",
"countryOfOrigin": "PT",
"status": "Processing",
"customerInformation": {
"firstName": "FirstName1",
"lastName": "LastName1",
"email": "customer@trade-in.com",
"address": {
"firstLine": "FirstLine1",
"secondLine": "SecondLine1",
"zipCode": "ZipCode1",
"city": "Lisbon",
"state": "Lisbon",
"country": "Portugal",
"timezone": "Europe/Lisbon"
},
"telephoneNumber": {
"countryCode": "351",
"number": "910456789"
},
"externalUserId": "ABCDEFGHHJ"
},
"items": [
{
"id": "83f94362-52f2-4072-8679-bba09a5bf76a",
"status": "Received",
"category": {
"id": "58232508-12d8-4645-abba-0a38e4e39e81",
"name": "Bag"
},
"brand": {
"id": "cfe0b00e-f184-46c9-af0b-540d7ed641b7",
"name": "Brand"
},
"model": "Model1",
"description": "Description1",
"attributes": [
{
"id": "1a3abd07-75e0-4af7-853e-10eea208fbb7",
"name": "Size",
"values": [
{
"id": "5bb39d34-4f72-4410-8cdc-e83f0e8a16c4",
"label": "Label"
}
]
}
],
"offers": [
{
"id": "e24c9ffd-2000-479a-9ad1-9908519feccc",
"basePrice": {
"currencyIsoCode": "EUR",
"amount": 100
},
"totalPrice": {
"currencyIsoCode": "EUR",
"amount": 110
},
"status": "WinningOffer",
"promotions": [
{
"name": "Name1",
"price": {
"currencyIsoCode": "EUR",
"amount": 10
},
"percentage": 1
}
]
}
],
"files": [
{
"type": "Photos",
"location": "https://image.png",
"metadata": {
"type": "Additional",
"subType": "Inside"
}
}
]
}
],
"shipments": [
{
"id": "e3d8973b-f636-4a78-a0d4-26c922af5430",
"waybillUrl": "https://my-waybill.net/file.pdf",
"trackingCode": "123456789",
"carrier": "DHLExpress",
"mergedDocuments": "https://my-docs.net/merged-docs.pdf"
}
]
}
}
}Result Object
| Field | Description |
|---|---|
| collectionId | Collection (Order) Identifier. |
| timestamp | Event Timestamp. |
| itemId | Item Identifier. This is the same Identifier from the Submission Item. |
| shipment | Object with scheduled Shipment information. |
| order | Object with the entire Order information. |
Order Object
Same object used in the Pickup Scheduled Event.
Shipment Object
Same object used in the Pickup Scheduled Event.
Event: Item Failed at the Quality Check
Triggered when an Order Item did not pass the final evaluation and will be returned to the customer. Use this event to trigger the Quality Check Fail communication.
json
{
"type": "CollectionItemQualityCheckFailedEvent",
"token": "6972cce1-4afc-4408-ae78-15392b692f41",
"result": {
"timestamp": "2022-09-27T19:29:20.7243751Z",
"collectionId": "a989e247-ea7d-4ca5-823f-4a2beca861be",
"itemId": "83f94362-52f2-4072-8679-bba09a5bf76a",
"externalReference": "OC123456",
"submissionExternalReference": "QC123456",
"rejectionReasons": [
"NonSaleableModel"
],
"countryIsoCode": "PT",
"customerInformation": {
"name": "FirstName1",
"lastName": "LastName1",
"email": "customer@trade-in.com",
"address": {
"firstLine": "FirstLine1",
"secondLine": "SecondLine1",
"zipCode": "ZipCode1",
"city": "Lisbon",
"state": "Lisbon",
"country": "Portugal",
"timezone": "Europe/Lisbon"
},
"telephoneNumber": {
"countryCode": "351",
"number": "910456789"
},
"externalUserId": "ABCDEFGHHJ"
},
"items": [
{
"id": "350c2675-ffe8-43b6-aff6-1bb3923078c6",
"model": "TEST",
"brandId": "13a43eed-5fe9-4a3c-92c6-f67eb6b85ac8",
"brandName": "Alexander McQueen",
"categoryId": "d2eb568a-d538-444a-9055-a31bc2f29fbc",
"categoryName": "Bags",
"mainPhotoUrl": "https://ourimages.net/1664306867018.png",
"totalValue": {
"currencyIsoCode": "EUR",
"amount": 1150
},
"customerPrice": {
"currencyIsoCode": "EUR",
"amount": 1000
},
"promotionValue": 150,
"status": "QualityCheckFail",
"promotions": [
{
"id": "00000000-0000-0000-0000-000000000001",
"name": "Name1",
"price": {
"currencyIsoCode": "EUR",
"amount": 150
},
"percentage": 15
}
]
}
]
}
}Result Object
| Field | Description |
|---|---|
| collectionId | Collection (Order) Identifier. |
| timestamp | Event Timestamp. |
| itemId | Item Identifier. This is the same Identifier from the Submission Item. |
| externalReference | Order user-friendly reference. Generated internally by the Platform. |
| submissionExternalReference | Submission user-friendly reference. Generated internally by the Platform. |
| rejectionReasons | Array of reason for the Quality Check Fail. |
| customerInformation | Customer personal information. |
| items | Array with the Order Items information. |
Customer Information Object
| Field | Description |
|---|---|
| name | First name. |
| lastname | Last name. |
| Email. | |
| address.firstLine | First line. |
| address.secondLine | Second line. |
| address.zipCode | ZIP code. |
| address.city | City. |
| address.state | State. |
| address.country | Country ISO 3166-1 Alpha-2 code. |
| telephoneNumber.countryCode | ITU Dialing Code. |
| telephoneNumber.number | Telephone Number. |
| timezone | IANA timezone. |
| externalUserId | External User identifier. |
Item Object
| Field | Description |
|---|---|
| id | Order Item identifier. |
| model | Item model. |
| brandId | Brand identifier. |
| brandName | Brand name. |
| categoryId | Brand identifier. |
| categoryName | Category name. |
| mainPhotoUrl | Main Photo URL. |
| customerPrice | Base Offer price. |
| totalValue | Base Offer price plus the sum of applied promotions. |
| promotionValue | Promotion amount applied to the Offer. |
| promotions | List of promotions applied to the item. |
| status | Order Item status. |
Event: Item Finalized/Passed the Quality Check
Triggered when the Item passes the final evaluation and Payment can be issued to the Customer by the Trade-In. Use this event to trigger the Item Approved communication.
json
{
"type": "CollectionItemFinalizedEvent",
"token": "6972cce1-4afc-4408-ae78-15392b692f41",
"result": {
"timestamp": "2022-10-07T22:31:20.457748Z",
"collectionId": "e9bb1080-9333-4fd3-b7e1-0701edf5002c",
"itemId": "83f94362-52f2-4072-8679-bba09a5bf76a",
"externalReference": "OC123456",
"submissionExternalReference": "QC123456",
"countryIsoCode": "PT",
"paymentType": "Credit"
"customerInformation": {
"name": "FirstName1",
"lastName": "LastName1",
"email": "customer@trade-in.com",
"address": {
"firstLine": "FirstLine1",
"secondLine": "SecondLine1",
"zipCode": "ZipCode1",
"city": "Lisbon",
"state": "Lisbon",
"country": "Portugal",
"timezone": "Europe/Lisbon"
},
"telephoneNumber": {
"countryCode": "351",
"number": "910456789"
},
"externalUserId": "ABCDEFGHHJ"
},
"items": [
{
"id": "350c2675-ffe8-43b6-aff6-1bb3923078c6",
"model": "TEST",
"brandId": "13a43eed-5fe9-4a3c-92c6-f67eb6b85ac8",
"brandName": "Alexander McQueen",
"categoryId": "d2eb568a-d538-444a-9055-a31bc2f29fbc",
"categoryName": "Bags",
"mainPhotoUrl": "https://ourimages.net/1664306867018.png",
"totalValue": {
"currencyIsoCode": "EUR",
"amount": 1150
},
"customerPrice": {
"currencyIsoCode": "EUR",
"amount": 1000
},
"promotionValue": 150,
"status": "Finalized",
"promotions": [
{
"id": "00000000-0000-0000-0000-000000000001",
"name": "Name1",
"price": {
"currencyIsoCode": "EUR",
"amount": 150
},
"percentage": 15
}
]
}
]
}
}Result Object
| Field | Description |
|---|---|
| collectionId | Collection (Order) Identifier. |
| timestamp | Event Timestamp. |
| externalReference | Order user-friendly reference. Generated internally by the Platform. |
| submissionExternalReference | Submission user-friendly reference. Generated internally by the Platform. |
| timestamp | Event Timestamp. |
| paymentType | Indicate the payment type for order, the value could be Credit or Cash |
| customerInformation | Customer personal information. |
| items | Array with the Order Items information. |
Customer Information Object
Same object as the Quality Check Failed Event.
Item Object
Same object as the Quality Check Failed Event.
Event: Order Payment Details Created
Triggered when the customer inform the payment details for one order when payment type configuration is Cash. Use this event to trigger the payment details received communication.
json
{
"type":"OrderCustomerPaymentDetailsCreatedEvent",
"token":"1180e49d-b894-4907-92bc-7b23545510d3",
"result":{
"order":{
"id":"30656b1b-202b-4a99-8f46-6c1f799fd870",
"externalReference":"externalReference",
"submissionExternalReference":"submissionExternalReference",
"commercialInvoiceUrl":"CommercialInvoiceUrl1",
"status":"Closed",
"countryOfOrigin":"US",
"paymentType":"Cash",
"customerInformation":{
"firstName":"FirstName1",
"lastName":"LastName1",
"email":"firstname.lastname@outlook.com",
"address":{
"firstLine":"West 28th Street 140",
"secondLine":"Springhill Marriot",
"zipCode":"85713-2844",
"city":"Tucson",
"state":"Arizona",
"country":"US",
"timezone":"America/Phoenix"
},
"telephoneNumber":{
"countryCode":"351",
"number":"915512170"
},
"customerPaymentDetails":{
"firstName":"FirstName",
"lastName":"LastName",
"bankAccount":{
"accountNumber":"TESTE",
"financialInstitutionIdentifier":"123456789",
"beneficiaryName":"TESTE"
},
"billingAddress":{
"firstLine":"West 28th Street 140",
"secondLine":"Springhill Marriot",
"zipCode":"85713-2844",
"city":"Tucson",
"state":"Arizona",
"country":"US",
"timezone":""
}
}
},
"items":[
{
"id":"b670ed67-9be9-4ebd-a321-c7c93d3b01bb",
"status":"Finalized",
"category":{
"id":"ba6f12dd-fa70-4235-94de-e5ba5a9c4b2b",
"name":"Bags"
},
"brand":{
"id":"4753146f-d10b-41a1-a54c-341ad9b0e6e8",
"name":"Gucci"
},
"model":"TESTE",
"description":"",
"attributes":[
{
"id":"4a61d5d9-d099-44c0-afe7-e99f23d99cd4",
"name":"Size",
"values":[
{
"id":"cd263c43-41d1-4167-ac57-8a7dfa02a28c",
"label":"S"
}
]
}
],
"offers":[
{
"id":"1a6c4a48-38ee-4c24-8af5-e917c08a076c",
"basePrice":{
"currencyIsoCode":"USD",
"amount":100.0
},
"totalPrice":{
"currencyIsoCode":"USD",
"amount":105.0
},
"status":"WinningOffer",
"promotions":[
{
"id":"1e44f1c1-8f82-4c49-893b-a8d08c4115eb",
"name":"PlatformPartnerUplift",
"price":{
"currencyIsoCode":"USD",
"amount":5.0
},
"percentage":5.0
}
]
}
],
"files":[
{
"type":"Photos",
"location":"https://image.png",
"metadata":{
"name":"Front",
"order":"0",
}
}
],
"returns":[],
"rejectionReasons":[]
}
],
"shipments":[
{
"id":"dd21fca9-f94b-40fa-9039-31a6d87b670d"
},
{
"id":"edea05b9-b054-4182-8ab1-1c722bce288e",
"waybillUrl":"http://my-docs.com/waybill.pdf",
"trackingCode":"123456789",
"carrier":"DHL",
"mergedDocuments":"http://my-docs.com/merged-invoice-waybill.pdf"
}
]
},
"collectionId":"30656b1b-202b-4a99-8f46-6c1f799fd870",
"timestamp":"2024-02-02T14:36:04.8929014Z"
}
}Result Object
| Field | Description |
|---|---|
| timestamp | Event Timestamp. |
| id | Order Identifier. |
| order | Order object. |
Order Object
Same object used in the OrderCreatedEvent.
Customer Information Object
Same object used in the OrderCreatedEvent.
Customer Payment Details Object
| Field | Description |
|---|---|
| firstName | First name. |
| lastName | Last name. |
| bankAccount | contains the customer's bank account data object. |
| billingAddress | contains the customer's billing address object. |
Bank Account Object
| Field | Description |
|---|---|
| accountNumber | Account number/IBAN |
| financialInstitutionIdentifier | Routing number/Swift/BIC |
| beneficiaryName |
Billing Address Object
| Field | Description |
|---|---|
| firstLine | First line. |
| secondLine | Second line. |
| zipCode | ZIP code. |
| city | City. |
| state | State. |
| country | Country ISO 3166-1 Alpha-2 code. |
Order Item Object
Same object used in the OrderCreatedEvent.
Order Item Attribute Object
Same object used in the OrderCreatedEvent.
Order Item Offer Object
Same object used in the OrderCreatedEvent.
Price Object
Same object used in the OrderCreatedEvent.
Order Item File Object
Same object used in the OrderCreatedEvent.
Event: DropOff Pending
Triggered when the Buyer generates a shipping order for DropOff, indicating that the items are prepared for deposit at a designated DropOff point. Subsequently, the Platform makes both the Invoice and the Air Waybill accessible. These documents are essential prerequisites for the seamless progression of the shipment process. Please take note of the Order item status, which will be marked as 'DropOffPending' during this phase.
json
{
"type": "OrderDropOffPendingEvent",
"token": "8f52b1f6-38a4-4e2f-b448-cb677aa15b42",
"result": {
"order": {
"id": "d59995c6-5dee-4638-a956-3fd6e391b3f3",
"externalOrderId": "ExternalOrderId1",
"externalReference": "ExternalReference1",
"submissionExternalReference": "SubmissionExternalReference1",
"commercialInvoiceUrl": "CommercialInvoiceUrl1",
"status": "None",
"countryOfOrigin": "None",
"customerInformation": {
"firstName": "FirstName1",
"lastName": "LastName1",
"email": "customer@trade-in.com",
"address": {
"firstLine": "FirstLine1",
"secondLine": "SecondLine1",
"zipCode": "ZipCode1",
"city": "City1",
"state": "State1",
"country": "Country1",
"timezone": "Timezone1"
},
"telephoneNumber": {
"countryCode": "CountryCode1",
"number": "Number1"
}
},
"items": [
{
"id": "5bcdc800-c839-4275-99cb-afb71f02c063",
"status": "DropOffPending",
"category": {
"id": "d7f4d9da-8ce4-43b5-ae8d-c87fb978ac05",
"name": "Bag"
},
"brand": {
"id": "cccd0ac6-acad-4a57-85d8-7fff20acca93",
"name": "Brand"
},
"model": "Model1",
"description": "Description1",
"attributes": [
{
"id": "22607fad-b496-4830-9145-c7248067831c",
"name": "Size",
"values": [
{
"id": "ecd5ea84-fb17-4f60-8e0c-3e01deeccf32",
"label": "Label"
}
]
}
],
"offers": [
{
"id": "37e7b33c-3973-43b7-95a4-3b0cb2168cc0",
"basePrice": {
"currencyIsoCode": "EUR",
"amount": 100
},
"totalPrice": {
"currencyIsoCode": "EUR",
"amount": 110
},
"status": "WinningOffer",
"promotions": [
{
"id": "00000000-0000-0000-0000-000000000001",
"name": "Name1",
"price": {
"currencyIsoCode": "EUR",
"amount": 10
},
"percentage": 1
}
]
}
],
"files": [
{
"type": "Photos",
"location": "https://image.png",
"metadata": {
"type": "Additional",
"subType": "Inside"
}
}
],
"returns": [],
"rejectionReasons": []
}
],
"shipments": [
{
"id": "00000000-0000-0000-0000-000000000001",
"waybillUrl": "http://my-docs.com/waybill.pdf",
"trackingCode": "TrackingCode1",
"carrier": "Carrier1",
"mergedDocuments": "http://my-docs.com/merged-invoice-waybill.pdf"
}
]
},
"shipment": {
"waybillUrl": "http://my-docs.com/waybill.pdf",
"trackingCode": "123456789",
"carrier": "UPS",
"mergedDocuments": "http://my-docs.com/merged-invoice-waybill.pdf"
},
"collectionId": "d59995c6-5dee-4638-a956-3fd6e391b3f3",
"timestamp": "2023-12-15T14:37:41.085137Z"
}
}Result Object
| Field | Description |
|---|---|
| order | Object with the entire Order information. |
| shipment | Object with scheduled Shipment information. |
| collectionId | Collection (Order) Identifier. |
| timestamp | Event Timestamp. |
Shipment Object
| Field | Description |
|---|---|
| id | Shipment identifier. |
| waybillUrl | URL with the Air Waybill. Required for packaging and Customs. |
| trackingCode | Shipment tracking code. |
| carrier | Carrier responsible by the Shipment. |
| mergedDocuments | URL with a merged document containing the Air Waybill and the Commercial Invoice. Required for packaging and Customs. |
Order Object
Same object used in the OrderCreatedEvent.
Order Reminder Events
After accepting the Offer (and the Order created), the following reminders could be triggered:
- The Schedule Pickup Reminder - the first reminder email. Triggered
1 hourafter the customer accepts the offer, if the Schedule was not done; - The Schedule Pickup Reminder - the second reminder email. Triggered after the number of days indicated in the
daysAfterCreationproperty, if the Schedule was not done; - The Collection Pickup Date Reminder - triggered
1 daybefore the collection date is due; - The Collection DropOff Reminder - triggered
7 daysafter the DropOff shipment created date;
Event: Schedule Pickup Reminder (first/second reminders)
Triggered 1h after the customer accepts the offer, if the Schedule was not done.
json
{
"type": "OrderSchedulePickupReminderEvent",
"token": "502bad4c-f70b-4cb8-ad45-d51522ae5ffa",
"result": {
"daysAfterCreation": 0,
"order": {
"id": "427a56f6-121f-42d9-853e-6e3e8b029460",
"externalReference": "B2BOCUT22NY",
"submissionExternalReference": "B2BLMQFYL",
"status": "Created",
"countryOfOrigin": "PT",
"customerInformation": {
"firstName": "FirstName1",
"lastName": "LastName1",
"email": "customer@trade-in.com"
},
"items": [
{
"id": "5ba1d794-ad4a-4853-895d-1a2af0a01917",
"status": "Created",
"category": {
"id": "ba6f12dd-fa70-4235-94de-e5ba5a9c4b2b",
"name": "Bags"
},
"brand": {
"id": "9fb3dab1-cb26-4450-a205-44f4129995a7",
"name": "Balenciaga"
},
"model": "Model1",
"description": "Description1",
"attributes": [
{
"id": "4a61d5d9-d099-44c0-afe7-e99f23d99cd4",
"name": "Size",
"values": [
{
"id": "cd263c43-41d1-4167-ac57-8a7dfa02a28c",
"label": "S"
}
]
},
{
"id": "ea895fcb-18d1-40f7-9176-c0664b74db20",
"name": "Condition",
"values": [
{
"id": "a5885590-a191-4c87-a9d6-7085732beea2",
"label": "APlus"
}
]
},
{
"id": "2a53bfaf-fb5b-4e02-a0d0-ef7258ba0210",
"name": "Extras",
"values": [
{
"id": "6530e7c3-5bcf-4e1f-8764-2b2fbd7b256c",
"label": "Pouch"
},
{
"id": "5745b1d6-7a73-4688-a34c-6c9a7c1f983c",
"label": "Dustbag"
}
]
}
],
"offers": [
{
"id": "0cb3a69f-d8c5-479c-b2be-00615133fe7e",
"basePrice": {
"currencyIsoCode": "EUR",
"amount": 94
},
"totalPrice": {
"currencyIsoCode": "EUR",
"amount": 94
},
"status": "WinningOffer",
"promotions": []
}
],
"files": [
{
"type": "Photos",
"location": "https://ourimages.net/1697559339588.jpeg",
"metadata": {
"name": "Front",
"order": "0",
"required": "True"
}
},
{
"type": "Photos",
"location": "https://ourimages.net/1697559339569.jpeg",
"metadata": {
"name": "Back",
"order": "1",
"required": "True"
}
},
{
"type": "Photos",
"location": "https://ourimages.net/1697559339572.jpeg",
"metadata": {
"name": "Bottom",
"order": "2",
"required": "True"
}
},
{
"type": "Photos",
"location": "https://ourimages.net/1697559339575.jpeg",
"metadata": {
"name": "Inside",
"order": "3",
"required": "True"
}
},
{
"type": "Photos",
"location": "https://ourimages.net/1697559339582.jpeg",
"metadata": {
"name": "Serial Number",
"order": "4",
"required": "False"
}
}
],
"returns": [],
"rejectionReasons": []
}
],
"shipments": []
},
"collectionId": "427a56f6-121f-42d9-853e-6e3e8b029460",
"timestamp": "2023-10-17T19:59:21.033727Z"
}
}Result Object
| Field | Description |
|---|---|
| timestamp | Event Timestamp. |
| collectionId | Collection (Order) Identifier. |
| daysAfterCreation | Number of days/hour since the Offer Acceptance. If equal 0 then was created 1h before, if > 0 then was created the number of days indicated. |
| order | Object with the entire Order information. |
Order Object
Same object used in the Pickup Scheduled Event.
Event: Collection Pickup Date Reminder
Triggered 1 day before the collection date is due.
json
{
"type": "OrderPickupReminderEvent",
"token": "9226e1e1-ae8b-4d12-a461-84e95e196393",
"result": {
"withinDays": 1,
"order": {
"id": "c66f9170-e1a8-4b3e-b857-24032ef246d8",
"externalOrderId": "ExternalOrderId1",
"externalReference": "ExternalReference1",
"submissionExternalReference": "SubmissionExternalReference1",
"commercialInvoiceUrl": "CommercialInvoiceUrl1",
"status": "None",
"countryOfOrigin": "None",
"customerInformation": {
"firstName": "FirstName1",
"lastName": "LastName1",
"email": "customer@trade-in.com",
"address": {
"firstLine": "FirstLine1",
"secondLine": "SecondLine1",
"zipCode": "ZipCode1",
"city": "City1",
"state": "State1",
"country": "Country1",
"timezone": "Timezone1"
},
"telephoneNumber": {
"countryCode": "CountryCode1",
"number": "Number1"
}
},
"items": [
{
"id": "5e4ea25f-6626-4360-8099-b6c48aacd7b9",
"status": "PickUpScheduled",
"category": {
"id": "74b974a4-c01a-42e5-95f5-6eacc5d5c3ed",
"name": "Bag"
},
"brand": {
"id": "6be6f5c0-f523-4cf8-8644-1b21e7a82b2f",
"name": "Brand"
},
"model": "Model1",
"description": "Description1",
"attributes": [
{
"id": "b7473afc-de7d-40e1-abfe-1d17d7670262",
"name": "Size",
"values": [
{
"id": "56a57f21-3697-46c7-b306-61350c37945e",
"label": "Label"
}
]
}
],
"offers": [
{
"id": "b0bf27c9-4728-40ad-84b1-6bbc7058d76a",
"basePrice": {
"currencyIsoCode": "EUR",
"amount": 100
},
"totalPrice": {
"currencyIsoCode": "EUR",
"amount": 110
},
"status": "WinningOffer",
"promotions": [
{
"id": "00000000-0000-0000-0000-000000000001",
"name": "Name1",
"price": {
"currencyIsoCode": "EUR",
"amount": 10
},
"percentage": 1
}
]
}
],
"files": [
{
"type": "Photos",
"location": "https://image.png",
"metadata": {
"type": "Additional",
"subType": "Inside"
}
}
],
"returns": [],
"rejectionReasons": []
}
],
"shipments": [
{
"id": "00000000-0000-0000-0000-000000000001",
"waybillUrl": "http://my-docs.com/waybill.pdf",
"trackingCode": "TrackingCode1",
"carrier": "Carrier1",
"mergedDocuments": "http://my-docs.com/merged-invoice-waybill.pdf"
}
]
},
"activeShipmentPickup": {
"startDate": "2023-10-24T10:22:54.583899Z",
"endDate": "2023-10-24T15:22:54.584845Z",
"waybillUrl": "WaybillUrl1",
"trackingCode": "TrackingCode1",
"carrier": "Carrier1",
"mergedDocuments": "MergedDocuments1"
},
"collectionId": "c66f9170-e1a8-4b3e-b857-24032ef246d8",
"timestamp": "2023-10-23T10:22:54.429901Z"
}
}Result Object
| Field | Description |
|---|---|
| timestamp | Event Timestamp. |
| collectionId | Collection (Order) Identifier. |
| withinDays | Number of days for the Pickup Collection. |
| order | Object with the entire Order information. |
| activeShipmentPickup | Object with the current Pickup information. |
Order Object
Same object used in the Pickup Scheduled Event.
Event: Collection DropOff Reminder
Triggered 7 days after the DropOff shipment created date.
json
{
"type": "OrderDropOffReminderEvent",
"token": "6ac42187-469a-4985-bba6-4c1d506d3dc0",
"result": {
"daysAfterCreation": 7,
"order": {
"id": "0b83a801-247d-4117-9fa3-d1f7483c40ec",
"externalOrderId": "ExternalOrderId1",
"externalReference": "ExternalReference1",
"submissionExternalReference": "SubmissionExternalReference1",
"commercialInvoiceUrl": "CommercialInvoiceUrl1",
"status": "None",
"countryOfOrigin": "None",
"customerInformation": {
"firstName": "FirstName1",
"lastName": "LastName1",
"email": "customer@trade-in.com",
"address": {
"firstLine": "FirstLine1",
"secondLine": "SecondLine1",
"zipCode": "ZipCode1",
"city": "City1",
"state": "State1",
"country": "Country1",
"timezone": "Timezone1"
},
"telephoneNumber": {
"countryCode": "CountryCode1",
"number": "Number1"
}
},
"items": [
{
"id": "1f742ebf-6400-4df1-bc6e-0f66b9d5e20f",
"status": "DropOffPending",
"category": {
"id": "433bd0b0-7965-4c0b-a4c3-07c974ac8d48",
"name": "Bag"
},
"brand": {
"id": "de0401a9-c102-4f7b-a76b-a0a0f2232a76",
"name": "Brand"
},
"model": "Model1",
"description": "Description1",
"attributes": [
{
"id": "519995fc-85bf-4a7b-aafb-ee23fb76cfa7",
"name": "Size",
"values": [
{
"id": "408c0b28-4e97-4543-aa6f-28b4cc1d0da0",
"label": "Label"
}
]
}
],
"offers": [
{
"id": "609a4f79-a0d1-431e-b405-b4f0850680ee",
"basePrice": {
"currencyIsoCode": "EUR",
"amount": 100
},
"totalPrice": {
"currencyIsoCode": "EUR",
"amount": 110
},
"status": "WinningOffer",
"promotions": [
{
"id": "00000000-0000-0000-0000-000000000001",
"name": "Name1",
"price": {
"currencyIsoCode": "EUR",
"amount": 10
},
"percentage": 1
}
]
}
],
"files": [
{
"type": "Photos",
"location": "https://image.png",
"metadata": {
"type": "Additional",
"subType": "Inside"
}
}
],
"returns": [],
"rejectionReasons": []
}
],
"shipments": [
{
"id": "00000000-0000-0000-0000-000000000001",
"waybillUrl": "http://my-docs.com/waybill.pdf",
"trackingCode": "TrackingCode1",
"carrier": "Carrier1",
"mergedDocuments": "http://my-docs.com/merged-invoice-waybill.pdf"
}
]
},
"shipment": {
"waybillUrl": "http://my-docs.com/waybill.pdf",
"trackingCode": "123456789",
"carrier": "UPS",
"mergedDocuments": "http://my-docs.com/merged-invoice-waybill.pdf"
},
"collectionId": "0b83a801-247d-4117-9fa3-d1f7483c40ec",
"timestamp": "2023-12-21T10:11:19.044005Z"
}
}Result Object
| Field | Description |
|---|---|
| daysAfterCreation | Number of days after the Shipment created. |
| order | Object with the entire Order information. |
| shipment | Object with scheduled Shipment information. |
| collectionId | Collection (Order) Identifier. |
| timestamp | Event Timestamp. |
Order Object
Same object used in the OrderCreatedEvent.
Shipment Object
| Field | Description |
|---|---|
| id | Shipment identifier. |
| waybillUrl | URL with the Air Waybill. Required for packaging and Customs. |
| trackingCode | Shipment tracking code. |
| carrier | Carrier responsible by the Shipment. |
| mergedDocuments | URL with a merged document containing the Air Waybill and the Commercial Invoice. Required for packaging and Customs. |