Orders

Create Order

Creates an order.

POST

/v1/orders

Create Order

curl --request POST \
  --url 'https://public-api.bladepro.io/v1/orders?expand=%3Cstring%3E' \
  --header 'Content-Type: application/json' \
  --data '
{
  "channel": "<string>",
  "currency": "<string>",
  "goodsouts": "<any>",
  "reference": "<string>"
}
'

{
  "data": {
    "goodsouts": {
      "attributes": [
        {
          "name": "Marketplace",
          "value": "202-9999999-9995900"
        }
      ],
      "cancellation_date": "2019-11-25T14:52:56.000Z",
      "date_placed": "2019-11-25T14:52:56.000Z",
      "delivery_instructions": "When not home put in shed.",
      "despatch_date": null,
      "despatch_on_date": null,
      "gift_message": "Happy birthday Sam!<br/>Hope you enjoy this gift.",
      "id": 1049789,
      "lines": [
        {
          "discount": 1.5,
          "discount_type": "percentage",
          "id": 3450345,
          "net_unit_principal": 12,
          "quantity": 4,
          "status": "active",
          "transaction_sku": "GREEN-BALL",
          "variation": {
            "barcode": "0123456789012",
            "created": "2019-11-25T14:52:56.000Z",
            "descriptions": [
              {
                "created": "2019-11-25T14:52:56.000Z",
                "full_description": "Example product description",
                "id": 1,
                "locale": {
                  "code": "en",
                  "created": "2019-11-25T14:52:56.000Z",
                  "id": 1,
                  "modified": "2019-11-25T14:52:56.000Z",
                  "name": "English"
                },
                "locale_id": 1,
                "modified": "2019-11-25T14:52:56.000Z",
                "name": "Example product",
                "product_variation_id": 1
              }
            ],
            "despatch_instructions": "Always pack facing upwards.",
            "discontinued_date": "2019-11-25T14:52:56.000Z",
            "id": 1,
            "modified": "2019-11-25T14:52:56.000Z",
            "product_id": 1,
            "product_variation_type_id": 1,
            "sku": "DEMO-SKU-01",
            "status": "active",
            "type": {
              "created": "2019-11-25T14:52:56.000Z",
              "id": 1,
              "modified": "2019-11-25T14:52:56.000Z",
              "name": "Standard Product",
              "type": "product"
            }
          }
        }
      ],
      "order": {
        "channel": {
          "created": "2019-11-25T14:52:56.000Z",
          "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",

Scope(s): APP::ORDERS::MANAGE

Query Parameters

expandstringquery

Usage: expand=*

Expand goodsouts, goodsouts.attributes, goodsouts.lines, goodsouts.shipments, goodsouts.shipments.shipping_service, goodsouts.shipments.shipping_service.courier_account, goodsouts.shipments.shipping_service.courier_account.courier

Body

channelstringrequired

Channel's unique short code or ID.

currencystringrequired

Currency ISO code.

goodsoutsanyrequired

List of goodsouts to create on the order.

referencestringrequired

Order specific reference.

Response

successful operation

channelobject

Order Channel.

Show child attributes

goodsoutsany

List of goodsouts.

idnumber

ID.

referencestring

Unique reference.

statusenum<string>

Order status.

Available options: draft, open, complete, cancelled

Still need help? Share an idea