Get Orders Analytics Table v2

curl --request GET \
  --url https://api.retailreadyai.com/api/v2/orders/analytics/table/{facility_id} \
  --header 'Authorization: Bearer <token>'

{
  "message": "Orders analytics table retrieved successfully",
  "data": [
    {
      "order_id": "6f8d7e6a-5b4c-3d2e-1f0g-9h8i7j6k5l4m",
      "total_cartons": 5,
      "total_labels": 5,
      "unique_labels": 5,
      "order_number": "83652219",
      "total_pallets": 2,
      "unique_sku_count": 3,
      "order_status": "Shipped",
      "total_units": 250,
      "total_vas_actions": 2,
      "asn_sent_at": "2023-11-07T05:31:56Z",
      "brand": "EcoGear",
      "retailer": "REI"
    }
  ]
}

GET

api

orders

analytics

table

{facility_id}

Get Orders Analytics Table v2

curl --request GET \
  --url https://api.retailreadyai.com/api/v2/orders/analytics/table/{facility_id} \
  --header 'Authorization: Bearer <token>'

{
  "message": "Orders analytics table retrieved successfully",
  "data": [
    {
      "order_id": "6f8d7e6a-5b4c-3d2e-1f0g-9h8i7j6k5l4m",
      "total_cartons": 5,
      "total_labels": 5,
      "unique_labels": 5,
      "order_number": "83652219",
      "total_pallets": 2,
      "unique_sku_count": 3,
      "order_status": "Shipped",
      "total_units": 250,
      "total_vas_actions": 2,
      "asn_sent_at": "2023-11-07T05:31:56Z",
      "brand": "EcoGear",
      "retailer": "REI"
    }
  ]
}

Authorizations

Authorization

string

header

required

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

Path Parameters

facility_id

string<uuid>

required

ID of the facility to fetch orders for

Query Parameters

page

integer

If page or page_size are not provided, page will default to 1 and page_size will default to 10.

page_size

integer

Maximum page_size is 10. If page or page_size are not provided, page will default to 1 and page_size will default to 10.

order_id

string

Filter results by specific order ID

created_at_from

string<date>

created_at_to

string<date>

ship_window_from

string<date>

ship_window_to

string<date>

packed_at_from

string<date>

packed_at_to

string<date>

retailers

string

brands

string

asn

string

Response

Successful retrieval of orders analytics table for facility.

message

string

Example:

"Orders analytics table retrieved successfully"

data

object[]

Show child attributes

data.order_id

string<uuid>

Example:

"6f8d7e6a-5b4c-3d2e-1f0g-9h8i7j6k5l4m"

data.total_cartons

integer

Example:

5

data.total_labels

integer

Example:

5

data.unique_labels

integer

Example:

5

data.order_number

string

Example:

"83652219"

data.total_pallets

integer

Example:

2

data.unique_sku_count

integer

Example:

3

data.order_status

string

Example:

"Shipped"

data.total_units

integer

Example:

250

data.total_vas_actions

integer

Example:

2

data.asn_sent_at

string<date-time>

data.brand

string

Example:

"EcoGear"

data.retailer

string

Example:

"REI"

Get Orders Analytics Table v1 Get Compliance Report Binary

⌘I

API Documentation

Authentication

Documents

Facilities

Brands

Retailers

Item Master

Orders

Get Orders Analytics Table v2

Authorizations

Path Parameters

Query Parameters

Response