We have a brand new Developer Portal!

This page will be expiring soon; be sure to bookmark the new link.
Take me there

Create an order

Creates an order. After an order is created, Notification APIs of fabric OMS send order notification to customers.

Request
header Parameters
required
object

x-site-context value

Request Body schema: application/json
orderNumber
required
string

Unique order number to be provided by merchant

orderDate
string <date-time>

Actual order creation date when the order was created for the first time.

channelId
required
string

Sales channel ID

cartId
string

ID of the cart for which order is created

type
string

Platform of order creation, for example, website, mobile application, point of sale, and so on.

Enum: "WEB" "CSC" "MOBILE_APP" "POS"
subType
string

Operating system of the platform mentioned in the type field.

Enum: "IOS" "Android" "International"
employeeId
string

ID of the employee who created the order or who helped creating the order.

object

Order retail object for reatil transactions. For non-retail transactions, only location number is provided.

orderSubTotal
number

Base price of the ordered items before discounts. It does not include tax amount.

orderDiscount
number

Discounted amount

feeTotal
number

Order value after discount. Discount value is subtracted from order sub total.

taxTotal
number

Total tax amount applicable on the order subtotal value.

orderTotal
number

Total order value after calculating discount and tax values.

currency
string

Currecy code used for order amount

statusCode
required
string

Order status code

statusDescription
string

Order status description

object
Array of objects
Array of objects

Array of discount objects

object

Order customer model

Array of objects
required
Array of objects [ 1 .. 2147483647 ] items

Array of items for which order is processed

required
Array of objects [ 1 .. 2147483647 ] items
Array of objects

Notes section to be used for CSR only

Responses
200

Order Created

400

Bad Request

404

Not Found

500

Internal Server Error

post/order/
Request samples
application/json
{
  • "orderNumber": "309019176",
  • "orderDate": "2022-05-12T09:30:31.198Z",
  • "channelId": "12",
  • "cartId": "b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569",
  • "type": "WEB",
  • "subType": "International",
  • "employeeId": "43278",
  • "retail": {
    },
  • "orderSubTotal": 123.45,
  • "orderDiscount": 1.23,
  • "feeTotal": 12.34,
  • "taxTotal": 12.34,
  • "orderTotal": 146.9,
  • "currency": "USD",
  • "statusCode": "ORDER_CREATED",
  • "statusDescription": "Order created",
  • "attributes": {
    },
  • "fees": [
    ],
  • "discounts": [
    ],
  • "customer": {
    },
  • "payments": [
    ],
  • "items": [
    ],
  • "shipInfo": [
    ],
  • "notes": [
    ]
}
Response samples
application/json
{
  • "version": 0,
  • "orderId": "5349b4ddd2781d08c09890f4",
  • "orderNumber": "309019176",
  • "orderDate": "2022-05-12T09:30:31.198Z",
  • "cancellationDate": "2022-05-12T09:30:31.198Z",
  • "allocationDate": "2022-05-12T09:30:31.198Z",
  • "channelId": "12",
  • "cartId": "b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569",
  • "type": "WEB",
  • "subType": "International",
  • "processName": "CANCEL",
  • "employeeId": "43278",
  • "retail": {
    },
  • "orderSubTotal": 123.45,
  • "originalSubTotal": 113.45,
  • "orderDiscount": 1.23,
  • "originalDiscounts": 1.45,
  • "feeTotal": 12.34,
  • "originalFeeTotal": 12.34,
  • "taxTotal": 12.34,
  • "appeasementTotal": 12.34,
  • "originalTaxTotal": 12.34,
  • "returnTotal": 12.34,
  • "cancelTotal": 12.34,
  • "invoiceTotal": 12.34,
  • "orderTotal": 146.9,
  • "originalOrderTotal": 146.9,
  • "currency": "USD",
  • "statusCode": "ORDER_CREATED",
  • "statusDescription": "Order Created",
  • "attributes": {
    },
  • "fees": [
    ],
  • "appeasements": [
    ],
  • "discounts": [
    ],
  • "customer": {
    },
  • "payments": [
    ],
  • "items": [
    ],
  • "shipInfo": [
    ],
  • "auditLogs": [
    ],
  • "notes": [
    ],
  • "orderReleaseTimestamp": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}