Order Channels

List Order Channels

List order channels

GET

/v1/orders/channels

List Order Channels

curl --request GET \
  --url 'https://public-api.bladepro.io/v1/orders/channels?expand=%3Cstring%3E&status%5BEQUALS%5D=%3Cany%3E'

{
  "data": [
    {
      "brands": [
        {
          "id": 5,
          "name": "Demo Brand"
        }
      ],
      "created": "2019-11-25T14:52:56.000Z",
      "default_warehouse": {
        "active": true,
        "country_id": 1,
        "created": "2019-11-25T14:52:56.000Z",
        "currency_id": 1,
        "id": 1,
        "latitude": 50.739492,
        "longitude": -1.734224,
        "modified": "2019-11-25T14:52:56.000Z",
        "name": "Christchurch",
        "return_warehouse_id": 1,
        "short_code": "CHR",
        "virtual": false
      },
      "id": 321,
      "modified": "2019-11-25T14:52:56.000Z",
      "name": "Demo Channel",
      "organisation": {
        "active": true,
        "contact_email": "joe.bloggs@example.com",
        "contact_mobile": "+44 00000000",
        "contact_name": "Mr Joe Bloggs",
        "contact_phone": "+44 01425 000 000",
        "created": "2019-11-25T14:52:56.000Z",
        "id": 1,
        "modified": "2019-11-25T14:52:56.000Z",
        "name": "Demo",
        "notes": "Demo account...",
        "vat_number": "GB999 9999 73"
      },
      "organisation_id": 321,
      "short_code": "DEMO",
      "status": "active",
      "tax": {
        "active": true,
        "code": "20",
        "created": "2019-11-25T14:52:56.000Z",
        "description": "standard 20%",
        "id": 1,
        "modified": "2019-11-25T14:52:56.000Z",
        "name": "standard",
        "rate": 20
      }
    }
  ],
  "meta": {
    "paging": {
      "page": 1,
      "per_page": 250,
      "records": 1,
      "total_pages": 1,
      "total_records": 1
    },
    "request_reference": "233f2gjwz-c893v86"
  }
}

Fuzzy search available

Scope(s): APP::ORDERS::READ

Query Parameters

expandstringquery

Usage: expand=*

Expand brands, default_warehouse, organisation, tax

status[EQUALS]anyquery

Filter for the status of the channel. (EQUALS)

Response

successful operation

brandsany

List of related brands

createdany

Created timestamp in BladePRO.

default_warehouseobject

Default warehouse

idnumber

ID of the channel.

modifiedany

Last modified timestamp in BladePRO.

namestring

The name of the channel.

organisationobject

List of related brands

organisation_idnumber

ID of the organisation the channel belongs to.

short_codestring

A short string identifier of the channel.

statusenum<string>

The status of the channel.

Available options: active, inactive

taxobject

Default tax rate

Still need help? Share an idea