Skip to main content

Market All Ep

POST 
/v1/market/all

Market All

Retrieves detailed information for all markets within the system, including their active status, associated trailer configurations, and sectors.

Required Scopes (ia.r)

Response​

id: str
The internal identifier unique to that market.

name: str
The name of the market.

network_radius: int | None = 250
Defines the radius, in miles, that a terminal must be within to supply a store.

active: bool | None = True
Indicates whether a market is active.

trailer_config: str | None = None
The trailer configuration associated with the market.

updated_on: datetime | None = None
The timestamp of the most recent edit to the market data.

extra_data: object | None = {}
Any extra data provided or managed by the client through integration endpoints.

sectors: list[str] | None = {}
The list of sectors within the market.

Show Child Attributes

In each sector, the following attributes are specified to describe the sector:

id: str
The internal identifier unique to that sector.

name: str | None = None
Name assigned to the sector.

trailer_config: str | None = None
The trailer configuration associated with the sector.

extra_data: dict | None = None
Any additional data provided or managed by the client through integration endpoints.

auto_dispatch_profile: str | None = None
Name of the auto-dispatch profile this market runs under, or null if the market is not auto-dispatched.

delivery_window_default: DeliveryWindowDefault | None
The delivery-window defaults applied to requests for sites in this market.

Show Child Attributes

name: str
Name of the delivery window default.

cutoffs: list[Cutoff]
The cutoff rules that make up the default. At least one is always present.

Show Cutoff Attributes

cutoff_time: int
Hour of the day (0–23) the cutoff falls on.

earliest_request_hours: int
Earliest hour of the day a delivery may be requested for.

earliest_request_offset_days: int
How many days out the earliest request lands. When 0, earliest_request_hours must be greater than cutoff_time.

fixed_window_hours: int | None = None
Length of a fixed delivery window in hours, when the default uses fixed windows. Either every cutoff sets this or none do.

Responses​

Successful Response

[
  {
    "id": "string",
    "name": "string",
    "network_radius": 250,
    "active": true,
    "trailer_config": "string",
    "updated_on": "2026-09-25T19:33:18.196Z",
    "extra_data": {},
    "sectors": [
      {
        "id": "string",
        "name": "string",
        "trailer_config": "string",
        "extra_data": {}
      }
    ],
    "auto_dispatch_profile": "string",
    "delivery_window_default": {
      "_id": "5eb7cf5a86d9755df3a6c593",
      "name": "string",
      "cutoffs": [
        {
          "cutoff_time": 0,
          "earliest_request_hours": 0,
          "earliest_request_offset_days": 0,
          "fixed_window_hours": 0
        }
      ]
    }
  }
]
Loading...