Order Channels

Working with order channels.

List Order Channels

GET /v1/orders/channels

List order channels

Return Type

array<OrderChannels>

Filters

Field	Operators	Value List URL
search	`LIKE`	fuzzy search across selected attributes
status	`EQUALS`

Available expands

Field	Return Type	Description
`brands`	`array<Brands>`	Brand data.
`default_warehouse`	`Warehouses`	A warehouse.
`organisation`	`Organisations`	Organisation data.
`tax`	`OrganisationTaxes`	Organisation tax data.

Rate limit cost

Each call to this endpoint deducts 1 credit from your request bucket.

Scopes

This endpoint is only available for users with scope APP::ORDERS::READ.

<?php

// Instantiate a GuzzleHttp client
$client = new \GuzzleHttp\Client();

// Make the request
$response = $client->request("GET", "https://public-api.bladepro.io/v1/orders/channels?expand=*", [
    "headers" => [
        "Content-Type" => "application/json",
        "Access-Token" => "my-token-from-login",
    ],
]);

// Process the response
$responseBody = json_decode($response->getBody(), true);

require 'rest-client'
require 'json'

# Make the request
response = RestClient.get 'https://public-api.bladepro.io/v1/orders/channels?expand=*', {
  access_token: 'my-token-from-login',
  content_type: :json,
  accept: :json
}

# Process the response
puts response.body

// Require the node HTTP module
var request = require("request");

// Make the request
request({
    method: "GET",
    json: true,
    uri: "https://public-api.bladepro.io/v1/orders/channels?expand=*",
    headers: {
        "Access-Token": "my-token-from-login",
        "Content-Type": "application/json",
    },
    (error, response, body) => {
        // Process the response
        console.log(body);
    },
});

# Make the request
curl --location --request GET 'https://public-api.bladepro.io/v1/orders/channels?expand=*' \
--header 'Content-Type: application/json' \
--header 'Access-Token: my-token-from-login'

Example result:

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