Get Order Details

curl --request GET \
  --url https://api.retailreadyai.com/api/v1/orders/{order_id} \
  --header 'Authorization: Bearer <token>'

{
  "message": "Order details retrieved successfully",
  "data": {
    "identifiers": {
      "id": "944bf737-7860-4629-8933-d8e871f19d72",
      "picksheet_code": "3132324301-9675",
      "external_order_id": null,
      "po_number": "3132324301",
      "brand": {
        "external_brand_code": "a6d6662a-53b0-4afe-9aaf-42441b0f490d"
      },
      "facility": {
        "external_facility_code": "faba3d7a-c0f8-417b-9eab-4664baa02aaf"
      },
      "transportation_method": "PARCEL",
      "bill_of_lading_number": "1234567890",
      "pro_number": "1234567890",
      "carrier": "UPS",
      "service_method": "ups_ground",
      "parcel_account_number": "XYZ123",
      "parcel_billing_type": "SENDER"
    },
    "status": "Packed",
    "pallets": [
      {
        "id": "faba3d7a-c0f8-417b-9eab-4664baa02aaf",
        "created_at": "2023-11-07T05:31:56Z",
        "staged_by": "John Doe",
        "staged_at": "2023-11-07T05:31:56Z",
        "sscc": "00001234560000002822",
        "status": "Loaded",
        "cartonQuantity": 1,
        "dim_unit": "in",
        "height": 12,
        "width": 12,
        "length": 24,
        "weight_unit": "lb",
        "weight": 15,
        "cartons": [
          {
            "id": "0eb578cd-c522-4ae0-8189-1419b58ddf96",
            "sscc": "00001234560000002821",
            "created_at": "2023-11-07T05:31:56Z",
            "packed_by": "John Doe",
            "packing_complete_at": "2023-11-07T05:31:56Z",
            "parcel_tracking_number": "XYZ123000000000",
            "dim_unit": "in",
            "height": 10,
            "width": 10,
            "length": 20,
            "weight_unit": "lb",
            "weight": 14,
            "skus": [
              {
                "sku": "123",
                "upc": "456",
                "serial_numbers": [
                  "123456789012345",
                  "987654321098765",
                  "456789012345678"
                ],
                "quantity": 3
              }
            ]
          }
        ]
      }
    ]
  }
}

GET

api

orders

{order_id}

Get Order Details

curl --request GET \
  --url https://api.retailreadyai.com/api/v1/orders/{order_id} \
  --header 'Authorization: Bearer <token>'

{
  "message": "Order details retrieved successfully",
  "data": {
    "identifiers": {
      "id": "944bf737-7860-4629-8933-d8e871f19d72",
      "picksheet_code": "3132324301-9675",
      "external_order_id": null,
      "po_number": "3132324301",
      "brand": {
        "external_brand_code": "a6d6662a-53b0-4afe-9aaf-42441b0f490d"
      },
      "facility": {
        "external_facility_code": "faba3d7a-c0f8-417b-9eab-4664baa02aaf"
      },
      "transportation_method": "PARCEL",
      "bill_of_lading_number": "1234567890",
      "pro_number": "1234567890",
      "carrier": "UPS",
      "service_method": "ups_ground",
      "parcel_account_number": "XYZ123",
      "parcel_billing_type": "SENDER"
    },
    "status": "Packed",
    "pallets": [
      {
        "id": "faba3d7a-c0f8-417b-9eab-4664baa02aaf",
        "created_at": "2023-11-07T05:31:56Z",
        "staged_by": "John Doe",
        "staged_at": "2023-11-07T05:31:56Z",
        "sscc": "00001234560000002822",
        "status": "Loaded",
        "cartonQuantity": 1,
        "dim_unit": "in",
        "height": 12,
        "width": 12,
        "length": 24,
        "weight_unit": "lb",
        "weight": 15,
        "cartons": [
          {
            "id": "0eb578cd-c522-4ae0-8189-1419b58ddf96",
            "sscc": "00001234560000002821",
            "created_at": "2023-11-07T05:31:56Z",
            "packed_by": "John Doe",
            "packing_complete_at": "2023-11-07T05:31:56Z",
            "parcel_tracking_number": "XYZ123000000000",
            "dim_unit": "in",
            "height": 10,
            "width": 10,
            "length": 20,
            "weight_unit": "lb",
            "weight": 14,
            "skus": [
              {
                "sku": "123",
                "upc": "456",
                "serial_numbers": [
                  "123456789012345",
                  "987654321098765",
                  "456789012345678"
                ],
                "quantity": 3
              }
            ]
          }
        ]
      }
    ]
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

order_id

string

required

Unique identifier of the order

Response

Order details retrieved successfully

message

string

Example:

"Order details retrieved successfully"

data

object

Show child attributes

data.identifiers

object

Show child attributes

data.identifiers.id

string

Example:

"944bf737-7860-4629-8933-d8e871f19d72"

data.identifiers.picksheet_code

string

Example:

"3132324301-9675"

data.identifiers.external_order_id

string | null

Example:

null

data.identifiers.po_number

string

Example:

"3132324301"

data.identifiers.brand

object

Show child attributes

data.identifiers.brand.external_brand_code

string | null

Example:

"a6d6662a-53b0-4afe-9aaf-42441b0f490d"

data.identifiers.facility

object

Show child attributes

data.identifiers.facility.external_facility_code

string | null

Example:

"faba3d7a-c0f8-417b-9eab-4664baa02aaf"

data.identifiers.transportation_method

string | null

Example:

"PARCEL"

data.identifiers.bill_of_lading_number

string | null

Example:

"1234567890"

data.identifiers.pro_number

string | null

Example:

"1234567890"

data.identifiers.carrier

string | null

Example:

"UPS"

data.identifiers.service_method

string | null

Example:

"ups_ground"

data.identifiers.parcel_account_number

string | null

Example:

"XYZ123"

data.identifiers.parcel_billing_type

string | null

Example:

"SENDER"

data.status

string

Example:

"Packed"

data.pallets

object[]

Show child attributes

data.pallets.id

string

Example:

"faba3d7a-c0f8-417b-9eab-4664baa02aaf"

data.pallets.created_at

string<date-time>

data.pallets.staged_by

string | null

Example:

"John Doe"

data.pallets.staged_at

string<date-time> | null

data.pallets.sscc

string

Example:

"00001234560000002822"

data.pallets.status

string

Example:

"Loaded"

data.pallets.cartonQuantity

integer

Example:

1

data.pallets.dim_unit

string

Example:

"in"

data.pallets.height

number

Example:

12

data.pallets.width

number

Example:

12

data.pallets.length

number

Example:

24

data.pallets.weight_unit

string

Example:

"lb"

data.pallets.weight

number

Example:

15

data.pallets.cartons

object[]

Show child attributes

data.pallets.cartons.id

string

Example:

"0eb578cd-c522-4ae0-8189-1419b58ddf96"

data.pallets.cartons.sscc

string

Example:

"00001234560000002821"

data.pallets.cartons.created_at

string<date-time>

data.pallets.cartons.packed_by

string | null

Example:

"John Doe"

data.pallets.cartons.packing_complete_at

string<date-time> | null

data.pallets.cartons.parcel_tracking_number

string | null

Example:

"XYZ123000000000"

data.pallets.cartons.dim_unit

string

Example:

"in"

data.pallets.cartons.height

number

Example:

10

data.pallets.cartons.width

number

Example:

10

data.pallets.cartons.length

number

Example:

20

data.pallets.cartons.weight_unit

string

Example:

"lb"

data.pallets.cartons.weight

number

Example:

14

data.pallets.cartons.skus

object[]

Show child attributes

data.pallets.cartons.skus.sku

string

Example:

"123"

data.pallets.cartons.skus.upc

string

Example:

"456"

data.pallets.cartons.skus.serial_numbers

string[] | null

Example:

[
  "123456789012345",
  "987654321098765",
  "456789012345678"
]

data.pallets.cartons.skus.quantity

integer

Example:

3

Create Order Get Orders Analytics Table v1

⌘I

API Documentation

Authentication

Documents

Facilities

Brands

Retailers

Item Master

Orders

Get Order Details

Authorizations

Path Parameters

Response