Retrieving a Package

Overview

Endpoint: https://{base_url}/v1/packages/{package_id}/
Method: GET
Headers:

• Authorization: JWT {id_token}
• Accept: application/json

The URL must contain the following parameters:

• package_id: Unique package id generated by Olist;

Payload:

This method does not need any payload in body.

Response codes:

• 200: Ok
• 401: Unauthorized

Request

curl --location 'https://{base_url}/v1/packages/{package_id}/' \
--header 'Accept: application/json' \
--header 'Authorization: JWT {id_token}'

Response

{
    "id": "56104222-6fb2-4e40-b8a2-d09f3bdb7eb3",
    "invoice_id": "7b8baf4e-4c04-430d-b253-cf46266eca8e",
    "created_at": "2025-01-01T22:17:03.149468Z",
    "updated_at": "2025-01-01T22:17:03.253951Z",
    "estimated_delivery_date": "2025-01-06",
    "seller_id": "dfb888d6-6a5d-4c0e-b7e3-546f0f74a3fb",
    "product_sku": "PRDJ8A5CP01747AD",
    "seller_order_code": "ORDPFXB3B9QN8IQ7",
    "seller_order_items": [
        {
            "seller_order_item_id": "32891821-7f1c-4212-bad0-f57947daaaad",
            "product_sku": "PRDJ8A5CP01747AD",
            "price": "99.99",
            "currency": ""
        },
        {
            "seller_order_item_id": "fd0a78dd-c4fe-4259-90c3-e0f388ffbc89",
            "product_sku": "PRDJ8A5CP01747AD",
            "price": "99.99",
            "currency": ""
        }
    ],
    "alias": "C00J7T4",
    "volume_id": "0f9dc748-fdf5-4d04-ad74-c9fd62ab79e5",
    "volume_items_total_value": 99.99,
    "measures_id": "a388ff8e-7c3b-455c-825e-0a63a5225f6a",
    "width": 30.0,
    "height": 30.0,
    "length": 30.0,
    "weight": 30.0,
    "history": [
        {
            "id": "2d8e517f-1147-4f56-a3a5-13bea3a694eb",
            "status": "created",
            "last_tracking_date": null,
            "tracking_status": "",
            "tracking_event_timestamp": ""
        },
        {
            "id": "44c4041c-0b88-4b84-96e3-d64db8605795",
            "status": "ready_to_ship",
            "last_tracking_date": null,
            "tracking_status": "",
            "tracking_event_timestamp": ""
        }
    ],
    "tracking_code": "",
    "shipment_id": null,
    "label_printed_at": null,
    "partners_shipment_id": "",
    "expected_freight_value": null,
    "first_tracking_exception_date": null,
    "limit_action_date": null,
    "external_pack_id": "",
    "returning_receipt": null,
    "reverse_package": "",
    "status": "ready_to_ship",
    "state": "",
    "city": "",
    "address": "",
    "country": "",
    "district": "",
    "zip_code": "",
    "complement": "",
    "customer_name": "",
    "branded_store_slug": "olist",
    "carrier_name": "Correios",
    "shipment_type": "",
    "carrier_rate_id": "ab4ea715-e862-4b67-9c63-619af8c60663",
    "carrier_shipment_id": "",
    "carrier_slug": "oss-correios",
    "cloned": false,
    "invoice_danfe_url": "",
    "last_shipping_date": null,
    "last_shipping_status": "",
    "last_tracking_date": null,
    "order_cancelation_status": "",
    "order_suspension_reason": "",
    "parent": null,
    "reference": "",
    "shipping_label_url": "",
    "reverse_ticket_code": "",
    "zpl_label_url": "",
    "shipping_method_name": "",
    "tracking_event_timestamp": "",
    "tracking_status": "",
    "tracking_url": "",
    "service_type": "normal",
    "region": "br",
    "external_shipment_id": "",
    "logistic_type": "by_olist",
    "package_type": "normal",
    "label_created_at": null,
    "number": "",
    "zpl_text": ""
}

What's Next