Overview

The Orders endpoints allow you to access all the orders containing Supplier products that have been purchased from your Storefront. Note: only Canal Supplier products should appear in these orders.

Order Creation Example

curl https://api.shopcanal.com/platform/orders/
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Accept: application/json' \
  --header 'x-canal-app-id: xxxx-xxxx-xxxx-xxxx' \
  --header 'x-canal-app-token: your_canal_api_access_token' \
  --data '{
    "line_items": [
      {
        "variant_id": "94b276a6-13bb-47a9-bc08-833e7548bb80",
        "quantity": 1
      }
    ],
    "shipping_address": {
      "name": "John Doe",
      "address1": "123 Your St",
      "address2": "",
      "city": "San Francisco",
      "province": "California",
      "province_code": "CA",
      "country": "United States of America",
      "country_code": "USA",
      "zip": "94111",
      "phone": "123-456-7890"
    },
    "customer": {
      "email": "[email protected]",
      "first_name": "John",
      "last_name": "Doe"
    }
  }'