Endpoint: https://{base_url}/v1/seller-orders/{code}/
Method: GET
Headers:
JWT {id_token}application/jsonThe URL must contain the following parameters:
Payload:
This method does not need any payload in body.
Response codes:
If an order is canceled or suspended by any reason, the field status will not be modified.
When an order is just suspended the field suspension_reason will be filled.
When an order is canceled the fields suspension_reason, cancelation_reason and cancelation_status will be filled.
curl --location 'https://{base_url}/v1/seller-orders/{code}/' \
--header 'Accept: application/json' \
--header 'Authorization: JWT {id_token}'{
"approved_at": "2025-01-01T22:14:55.159136Z",
"availability_days": 0,
"branded_store_slug": "olist",
"cancelation_reason": "",
"cancelation_status": "",
"financial_mediator": "36138724062013",
"code": "ORDPFXB3B9QN8IQ7",
"count_items": 2,
"created_at": "2025-01-01T22:15:05.870046Z",
"currency": "BRL",
"customer": {
"address": {
"address": "Rua Tao tao distante, 123",
"city": "Colombo",
"complement": "Apto 999",
"country": "Brasil",
"district": "Longe",
"full_address": "Rua Tao tao distante, 123, 9999 - Apto 999 Longe - Colombo - PR - 00000-000",
"number": "9999",
"reference": "Ao lado da escola",
"state": "PR",
"zip_code": "00000000"
},
"document_number": "78104125743",
"name": "Fake name",
"phones": [
{
"phone": "47933185700",
"phone_type": "mobile"
},
{
"phone": "91483575447",
"phone_type": "home"
}
]
},
"delivered_customer_date": null,
"display_status": "",
"estimated_delivery_date": "2025-01-01",
"estimated_delivery_shift": "not_scheduled",
"invoice_danfe_url": "",
"invoice_error_message": "",
"invoice_errors": null,
"invoice_id": "7b8baf4e-4c04-430d-b253-cf46266eca8e",
"invoice_issue_date": null,
"invoice_key": "<factory.faker.Faker object at 0x7918c2b93d50>",
"invoice_number": 0,
"invoice_serial_number": 0,
"invoice_source": "",
"invoice_status": "invoiced",
"invoice_url": "http://example.com/invoices/invoice.xml",
"order_id": "a49a25a6-2758-4f12-8af5-465bb0e66378",
"payer": {
"address": {
"address": "Rua Tao tao distante, 123",
"city": "Colombo",
"complement": "Apto 999",
"country": "Brasil",
"district": "Longe",
"full_address": "Rua Tao tao distante, 123, 9999 - Apto 999 Longe - Colombo - PR - 00000-000",
"number": "9999",
"reference": "Ao lado da escola",
"state": "PR",
"zip_code": "00000000"
},
"birth_date": "2000-01-01",
"document_number": "21845114495",
"name": "Fake name",
"phones": [
{
"phone": "45377674258",
"phone_type": "mobile"
},
{
"phone": "83557312763",
"phone_type": "business"
}
]
},
"payment_methods": [
{
"installments": 1,
"payment_type": "credit_card",
"sequential": 1,
"value": "99.00"
}
],
"purchase_timestamp": "2025-01-01T22:14:55.159145Z",
"region": "br",
"seller_brand": "",
"seller_email": "developers@partners-sandbox-api.olist.com",
"seller_id": "dfb888d6-6a5d-4c0e-b7e3-546f0f74a3fb",
"seller_name": "Developers",
"seller_order_items": [
{
"availability_days": 0,
"carrier": "ETC",
"code": "ITRDCKYJ3ZREE4Z7N6UQM",
"customer_id": "23018d6e-a6ea-433b-9fb7-00682fd0513d",
"expected_financial_transfer": "79.99",
"flat_fee": "0.00",
"flat_freight_discount": "0.00",
"flat_freight": "0.00",
"free_shipping": false,
"freight_value": "10.00",
"full_name": "Camisa Polo Muito Linda Mesmo",
"id": "32891821-7f1c-4212-bad0-f57947daaaad",
"incentive_value": "0.00",
"invoice_value": "109.99",
"price_discount": null,
"price_freight_shift": "0.00",
"price": "99.99",
"pricing_version": "v1",
"product_attributes": [
{
"Cor": "Verde"
},
{
"Tamanho": "G"
}
],
"product_gtin": "21700719670850",
"product_photo": "https://olist-v2-dev.s3.amazonaws.com/products-images/85c8e282-1f1a-4bda-a7cc-7b55553bfc94.jpg",
"product_sku": "PRDJ8A5CP01747AD",
"seller_id": "dfb888d6-6a5d-4c0e-b7e3-546f0f74a3fb",
"seller_order_code": "ORDPFXB3B9QN8IQ7",
"seller_order": "2435dc0e-5eb9-4159-bbed-ecc49f35192a",
"seller_product_code": "54321",
"smart_offer": "0.00",
"status": "created",
"total_commission": "20.00",
"order_item_id": "6814e3ec-2116-4d8a-ad13-4a0e1de69658",
"history": [
{
"created_at": "2025-01-01T22:15:05.973505Z",
"id": "922e3c31-dcf9-4ef0-bd16-f51425416c3e",
"status": "created"
}
]
},
{
"availability_days": 0,
"carrier": "ETC",
"code": "ITF1G86AK1411EUA5YF01",
"customer_id": "23018d6e-a6ea-433b-9fb7-00682fd0513d",
"expected_financial_transfer": "79.99",
"flat_fee": "0.00",
"flat_freight_discount": "0.00",
"flat_freight": "0.00",
"free_shipping": false,
"freight_value": "10.00",
"full_name": "Camisa Polo Muito Linda Mesmo",
"id": "fd0a78dd-c4fe-4259-90c3-e0f388ffbc89",
"incentive_value": "0.00",
"invoice_value": "109.99",
"price_discount": null,
"price_freight_shift": "0.00",
"price": "99.99",
"pricing_version": "v1",
"product_attributes": [
{
"Cor": "Verde"
},
{
"Tamanho": "G"
}
],
"product_gtin": "21700719670850",
"product_photo": "https://olist-v2-dev.s3.amazonaws.com/products-images/85c8e282-1f1a-4bda-a7cc-7b55553bfc94.jpg",
"product_sku": "PRDJ8A5CP01747AD",
"seller_id": "dfb888d6-6a5d-4c0e-b7e3-546f0f74a3fb",
"seller_order_code": "ORDPFXB3B9QN8IQ7",
"seller_order": "2435dc0e-5eb9-4159-bbed-ecc49f35192a",
"seller_product_code": "54321",
"smart_offer": "0.00",
"status": "created",
"total_commission": "20.00",
"order_item_id": "c74ebad2-e8ef-44ea-8028-feb0fd8f994c",
"history": [
{
"created_at": "2025-01-01T22:15:05.975195Z",
"id": "e1e7466c-12da-4345-819a-f0a11077d378",
"status": "created"
}
]
}
],
"shipment": null,
"shipping_limit_date": "2025-01-01T22:15:05.843594Z",
"shipping_quote_group_id": null,
"shipping_status": "waiting_approval",
"shipping_markup": "delayed",
"status": "invoiced",
"suspension_reason": "",
"total_amount": "219.98",
"total_freight": "20.00",
"total_freight_shift": "0.00",
"total_incentive": "0.00",
"total_invoice": "199.98",
"total_items": "199.98",
"updated_at": "2025-01-01T22:17:03.142110Z",
"volumes": [
{
"code": "VOL9KH9XXP0LC3FB",
"enabled": true,
"id": "0f9dc748-fdf5-4d04-ad74-c9fd62ab79e5",
"limit_action_date": null,
"measures": {
"height_unit": "cm",
"height_value": "30.0000",
"length_unit": "cm",
"length_value": "30.0000",
"width_unit": "cm",
"width_value": "30.0000",
"weight_unit": "g",
"weight_value": "30.0000",
"id": "a388ff8e-7c3b-455c-825e-0a63a5225f6a"
},
"parents": [],
"rate": {
"carrier_name": "Correios",
"carrier_slug": "correios",
"cost": "99.99",
"currency": "BRL",
"carrier_address": "SBN Quadra 1 Bloco A, 1 - Asa Norte, Brasília - DF, 70002-900",
"carrier_cnpj": "99.307.323/7173-53",
"carrier_ie": "Isento",
"service_type": "normal"
},
"seller_order_items": [
"32891821-7f1c-4212-bad0-f57947daaaad"
],
"shipment": null,
"smart_offer": 0.0,
"status": "carrier_assigned",
"value": "99.99"
},
{
"code": "VOLK3OFE6MNR4EHC",
"enabled": true,
"id": "b83bc32b-f8d4-4330-9613-a0a9b2c7091b",
"limit_action_date": null,
"measures": {
"height_unit": "cm",
"height_value": "30.0000",
"length_unit": "cm",
"length_value": "30.0000",
"width_unit": "cm",
"width_value": "30.0000",
"weight_unit": "g",
"weight_value": "30.0000",
"id": "b90e0f4f-fa89-4ca2-8190-a432661531c6"
},
"parents": [],
"rate": {
"carrier_name": "Correios",
"carrier_slug": "correios",
"cost": "99.99",
"currency": "BRL",
"carrier_address": "SBN Quadra 1 Bloco A, 1 - Asa Norte, Brasília - DF, 70002-900",
"carrier_cnpj": "72.993.625/0368-56",
"carrier_ie": "Isento",
"service_type": "normal"
},
"seller_order_items": [
"fd0a78dd-c4fe-4259-90c3-e0f388ffbc89"
],
"shipment": null,
"smart_offer": 0.0,
"status": "carrier_assigned",
"value": "99.99"
}
],
"volumes_status": [],
"seller_order_history": [
{
"cancelation_reason": "",
"cancelation_status": "",
"created_at": "2025-01-01T22:15:05.871514Z",
"status": "pending",
"suspension_reason": ""
},
{
"cancelation_reason": "",
"cancelation_status": "",
"created_at": "2025-01-01T22:15:05.927681Z",
"status": "approved",
"suspension_reason": ""
},
{
"cancelation_reason": "",
"cancelation_status": "",
"created_at": "2025-01-01T22:17:03.142963Z",
"status": "invoiced",
"suspension_reason": ""
}
],
"expected_financial_transfer": "159.98"
}What's Next
Sending an Invoice