order

order.status.list

Retrieve list of statuses

get/order.status.list.json

Request

  • Base URL: https://api.api2cart.com/v1.1
  • URL: https://api.api2cart.com/v1.1/order.status.list.json
  • Auth: API key in header x-api-key and API key in header x-store-key

Query parameters

store_idstring

Store Id

actionstring

Available statuses for the specified action.

allow_user_defined_order_statusesboolean

Indicates whether custom (user-defined) order statuses should be included in the response.

response_fieldsstring

Set this parameter to choose which entity fields to retrieve. Use comma-separated field names in curly braces, nested to match the response structure, e.g. {result{product{id,name}}}. The wildcard * returns every field at a level: {} gives the whole response, {result{product{}}} all product fields.

Response

successful operation

return_codeinteger nullable
return_messagestring nullable
additional_fieldsobject nullable
custom_fieldsobject nullable

Changes

No recorded changes to this operation across all 1 revision of this API.