Get All Order Types

get

https://sandbox-api.softpoint.io/interface/v1/locations/YOUR_LOCATION_ID/order_types

Returns a paginated list of the order types defined for a location.

Request Headers

Header	Required	Description
Authorization	Yes	Bearer YOUR_ACCESS_TOKEN

Request Parameters

Path Parameters:

Parameter	Type	Required	Description
location_id	integer	Yes	Location whose order types are listed.

Query Parameters:

Parameter	Type	Required	Description
status	integer	No	Filter by status (`1` = active).
user_id	integer	Yes	The acting user.
limit	integer	No	Page size.
paginate	string	No	Pagination mode.
page	integer	No	Page number.
global_on_id	integer	No	Originating channel identifier.

cURL Example

curl --request GET \
  --url "https://sandbox-api.softpoint.io/interface/v1/locations/3000324/order_types?status=1&user_id=1&limit=10&paginate=data&page=1&global_on_id=2" \
  --header "Authorization: Bearer YOUR_ACCESS_TOKEN"

Success Response

{
  "order_type": {
    "current_page": 1,
    "data": [
      { "id": 2054, "id_external": "100", "default": 1, "pos_id": 100, "status": 1, "name": "PICKUP" },
      { "id": 2055, "id_external": "101", "default": 0, "pos_id": 101, "status": 1, "name": "DELIVERY" }
    ],
    "per_page": 10,
    "total": 2
  }
}

Response Fields

Field	Type	Description
order_type	object	Paginator wrapper.
order_type.data	array	Order-type records.
data[].id	integer	Internal order-type ID.
data[].id_external	string	External/POS ID.
data[].pos_id	integer	POS-side identifier.
data[].default	integer	`1` if this is the default order type.
data[].status	integer	Status.
data[].name	string	Order-type name.

Status Codes

Code	Description
200	Order types returned
401	Token missing or invalid

Workflow Placement

A reference read used to resolve order-type IDs before checkout.

Notes

The paginator is nested under an order_type key.

Common Mistakes

Reading data at the top level instead of under order_type.

Response

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/plain

200OK