Skip to main content
POST
/
api-order
/
subscriptions
/
orders
Create subscriptions orders
curl --request POST \
  --url https://prod01-apigw.{customer_name}.fabric.zone/api-order/subscriptions/orders \
  --header 'Content-Type: application/json' \
  --header 'x-site-context: <x-site-context>' \
  --data '
{
  "cartId": "5e4876e10cfe1d8902005d33",
  "channel": 11,
  "orderTotal": 125.99,
  "taxTotal": 5.23,
  "orderCurrency": "USD",
  "status": "ORDER_CREATED",
  "customerUserId": "5e3598e3007c5e00080d2bb8",
  "shipTo": [
    {
      "shipToId": 1000001,
      "shipToType": "SHIP_TO_ADDRESS",
      "price": 24.87,
      "currency": "USD",
      "estimatedTax": 10.25,
      "committedTax": 10.25,
      "promosApplied": [
        {}
      ],
      "total": 1,
      "taxCode": "FR020000",
      "shipmentCarrier": "Fedex",
      "shipmentMethod": "Express",
      "shipmentMethodId": "10000001",
      "promisedDeliveryDate": "2019-12-14",
      "shipmentInstructions": "Leave at back door",
      "shipmentStatus": "Delivered",
      "address": {
        "name": {
          "first": "John",
          "last": "Smith",
          "middle": "Paul"
        },
        "email": "[email protected]",
        "street1": "10400 NE 4th St",
        "city": "Bellevue",
        "state": "WA",
        "country": "USA",
        "zipCode": "98004",
        "phone": {
          "number": "<string>",
          "kind": "<string>"
        },
        "street2": "Suite 500",
        "kind": "Ship to address"
      }
    }
  ],
  "orderReference": "<string>",
  "statusLog": "Order has been cancelled",
  "customerAccountId": "5e3598e3007c5e00080d2bb8",
  "customerEmail": "[email protected]",
  "customerPhone": {
    "number": "<string>",
    "kind": "<string>"
  },
  "notes": "<string>",
  "tags": [
    "tag100",
    "tag101"
  ],
  "events": [
    {
      "status": "ORDER_CREATED",
      "data": {}
    }
  ]
}
'
{
  "tags": [
    "Monthly Penut Bar"
  ],
  "_id": "60b5b8b08766410008dd72be",
  "channel": 13,
  "orderTotal": 125.33,
  "taxTotal": 5.23,
  "orderCurrency": "USD",
  "status": "ORDER_CREATED",
  "statusLog": "Order has been created",
  "customerUserId": "5e3598e3007c5e00080d2bb8",
  "customerAccountId": "5e3598e3007c5e00080d2bb8",
  "customerEmail": "[email protected]",
  "customerPhone": {
    "number": "555-555-5555",
    "kind": "mobile"
  },
  "orderId": "2468-1668-79485",
  "shipTo": [
    {
      "address": {
        "name": {
          "first": "Mark",
          "middle": "p",
          "last": "styler"
        },
        "email": "[email protected]",
        "phone": {
          "number": "555-555-5555",
          "kind": "mobile"
        },
        "street1": "10400 NE 4th St",
        "street2": "Suite 500",
        "city": "Bellevue",
        "state": "WA",
        "country": "USA",
        "zipCode": 98004,
        "kind": "Ship to address"
      },
      "promosApplied": [
        {
          "name": "test1"
        }
      ],
      "_id": "60b5b8b08766410008dd72bf",
      "shipToId": 1000001,
      "shipToType": "SHIP_TO_ADDRESS",
      "price": 24.87,
      "currency": "USD",
      "estimatedTax": 10,
      "committedTax": 10,
      "total": 34.87,
      "taxCode": "FR020000",
      "shipmentCarrier": "Fedex",
      "shipmentMethod": "Express",
      "shipmentMethodId": 10000001,
      "promisedDeliveryDate": "2021-02-14T00:00:00.000Z",
      "shipmentInstructions": "Leave at back door",
      "shipmentStatus": "Delivered"
    }
  ],
  "items": [
    {
      "group": [
        "Group1"
      ],
      "promosApplied": [
        {
          "name": "test"
        }
      ],
      "_id": "60b5b8b08766410008dd72c0",
      "lineItemId": 1,
      "itemId": 1000000051,
      "priceListId": 100003,
      "sku": 1538910,
      "title": "Luminous Cushion Lagoon",
      "quantity": 10,
      "price": 4.5,
      "discount": 1,
      "currency": "USD",
      "shipToId": 1000001,
      "estimatedTax": 10.25,
      "committedTax": 10.25,
      "total": 4.54,
      "taxCode": "FR020000",
      "weight": 10,
      "weightUnit": "lb",
      "reservedLocation": "<array>",
      "attributes": "<array>"
    }
  ],
  "shipments": "<array>",
  "payments": [
    {
      "billToAddress": {
        "name": {
          "first": "Marl",
          "middle": "p",
          "last": "styler"
        },
        "email": "[email protected]",
        "phone": {
          "number": "555-555-5555",
          "kind": "mobile"
        },
        "street1": "10400 NE 4th St",
        "street2": "Suite 500",
        "city": "Bellevue",
        "state": "WA",
        "country": "USA",
        "zipCode": 98004,
        "kind": "Ship to address"
      },
      "shipToId": [
        1000001
      ],
      "_id": "60b5b8b08766410008dd72c1",
      "billToId": 1000001,
      "paymentIdentifier": {
        "cardIdentifier": 4242
      },
      "paymentMethod": "Visa",
      "paymentToken": {
        "token": 12345689
      },
      "paymentKind": "Default payment",
      "amount": 533.33,
      "currency": "USD",
      "conversion": 1,
      "paymentStatus": "Pending"
    }
  ],
  "revision": 0,
  "totalQuantity": 10,
  "statusDescriptions": "<array>",
  "events": "<array>",
  "attributes": "<array>",
  "createdAt": "2021-06-01T04:33:52.118Z",
  "updatedAt": "2021-06-01T04:33:52.118Z"
}

Headers

​
x-api-key
string
Example:

"0LybWR49k95cCwYh3cu0waCYoh4H2Eux2J52wn4k"

​
x-site-context
string
required

The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.

Example:

"{\"date\": \"2023-01-01T00:00:00.000Z\", \"channel\": 12, \"account\": \"1234abcd5678efgh9ijklmno\",\"stage\":\"production\"}"

Body

application/json
  • Option 1
  • Option 2
  • Option 3
​
cartId
string
required
Required string length: 24
Example:

"5e4876e10cfe1d8902005d33"

​
channel
number
required
Example:

11

​
orderTotal
number
required
Required range: x >= 0
Example:

125.99

​
taxTotal
number
required
Required range: x >= 0
Example:

5.23

​
orderCurrency
string
required
Required string length: 3
Example:

"USD"

​
status
enum<string>
required
Available options:
ORDER_CREATED,
ORDER_CONFIRMED,
ORDER_CANCELLED,
ORDER_PARTIALLY_SHIPPED,
ORDER_SHIPPED,
ORDER_PARTIALLY_DELIVERED,
ORDER_DELIVERED,
ORDER_RETURNED,
ORDER_PARTIALLY_RETURNED,
ORDER_PAYMENT_AUTHORIZED,
ORDER_PAYMENT_INVALID,
ORDER_FULFILLED,
ORDER_PARTIALLY_FULFILLED,
ORDER_REFUNDED
Minimum string length: 5
Example:

"ORDER_CREATED"

​
customerUserId
string
required
Required string length: 24
Example:

"5e3598e3007c5e00080d2bb8"

​
shipTo
object[]
required
Minimum array length: 1
​
orderReference
string
​
statusLog
string
Example:

"Order has been cancelled"

​
customerAccountId
string
Minimum string length: 3
Example:

"5e3598e3007c5e00080d2bb8"

​
customerEmail
string<email>
Minimum string length: 3
​
customerPhone
object
​
notes
string
Minimum string length: 1
​
tags
string[]
Example:
["tag100", "tag101"]
​
events
object[]

Response

Created subscription order

​
tags
string[]
​
_id
string
Example:

"60b5b8b08766410008dd72be"

​
channel
number
Example:

13

​
orderTotal
number
Example:

125.33

​
taxTotal
number
Example:

5.23

​
orderCurrency
string
Example:

"USD"

​
status
string
Example:

"ORDER_CREATED"

​
statusLog
string
Example:

"Order has been created"

​
customerUserId
string
Example:

"5e3598e3007c5e00080d2bb8"

​
customerAccountId
string
Example:

"5e3598e3007c5e00080d2bb8"

​
customerEmail
string
​
customerPhone
object
​
orderId
string
Example:

"2468-1668-79485"

​
shipTo
object[]
​
items
object[]
​
shipments
array
​
payments
object[]
​
revision
number
Example:

0

​
totalQuantity
number
Example:

10

​
statusDescriptions
array
​
events
array
​
attributes
array
​
createdAt
string
Example:

"2021-06-01T04:33:52.118Z"

​
updatedAt
string
Example:

"2021-06-01T04:33:52.118Z"