POST

https://prod01-apigw.{customer_name}.fabric.zone

/
api-order
/
subscriptions
/
orders
{
  "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": "ino@fabric.inc",
  "customerPhone": {
    "number": "555-555-5555",
    "kind": "mobile"
  },
  "orderId": "2468-1668-79485",
  "shipTo": [
    {
      "address": {
        "name": {
          "first": "Mark",
          "middle": "p",
          "last": "styler"
        },
        "phone": {
          "number": "555-555-5555",
          "kind": "mobile"
        },
        "email": "mark@google.com",
        "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": [
        "<any>"
      ],
      "attributes": [
        "<any>"
      ]
    }
  ],
  "shipments": [
    "<any>"
  ],
  "payments": [
    {
      "billToAddress": {
        "name": {
          "first": "Marl",
          "middle": "p",
          "last": "styler"
        },
        "phone": {
          "number": "555-555-5555",
          "kind": "mobile"
        },
        "email": "mark@google.com",
        "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": [
    "<any>"
  ],
  "events": [
    "<any>"
  ],
  "attributes": [
    "<any>"
  ],
  "createdAt": "2021-06-01T04:33:52.118Z",
  "updatedAt": "2021-06-01T04:33:52.118Z"
}

Headers

x-api-key
string
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.

Body

application/json
cartId
string
required
orderReference
string
channel
number
required
orderTotal
number
required
taxTotal
number
required
orderCurrency
string
required
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
statusLog
string
customerUserId
string
required
customerAccountId
string
customerEmail
string
customerPhone
object
notes
string
tags
string[]
events
object[]
shipTo
object[]
required

Response

200 - application/json
tags
string[]
_id
string
channel
number
orderTotal
number
taxTotal
number
orderCurrency
string
status
string
statusLog
string
customerUserId
string
customerAccountId
string
customerEmail
string
customerPhone
object
orderId
string
shipTo
object[]
items
object[]
shipments
any[]
payments
object[]
revision
number
totalQuantity
number
statusDescriptions
any[]
events
any[]
attributes
any[]
createdAt
string
updatedAt
string

Was this page helpful?

Add shipment to orderOrder checkout (v4)