We have a brand new Developer Portal!

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

Update an order

Updates an order by order number

Request
path Parameters
orderNumber
required
string
Example: 309019176
header Parameters
required
object

x-site-context value

Request Body schema: application/json
version
integer <int64>

Number of updates happened to the order. Order-update refers to replacement, appeasement added, address change or any other order related update to the particular order.

orderId
string

Auto generated ID once the order created successfully

orderNumber
required
string

Unique order number

orderDate
string <date-time>

Actual order creation date

cancellationDate
string <date-time>

Order cancellation date if any

allocationDate
string <date-time>

Order allocation date after order is created

channelId
required
string

Sales channel ID

cartId
string

ID of the cart where order is placed

type
string

Platfrom using which order is created

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

Operating system of the platfom as mentioned in the type field. If you want to configure any custom valuefor this field, contact fabric.

Enum: "IOS" "Android" "International"
processName
string

Order process name

employeeId
string

Employee ID used when an employee places an order on behave of the customer.

object

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

orderSubTotal
number

Order value after calculating discounts and any applicable fees

originalSubTotal
number

Original order total value

orderDiscount
number

Final discount value on order amount

originalDiscounts
number

Original discount on order value

feeTotal
number

Total fees, if any, applicable on order amount

originalFeeTotal
number

Original fees appliable on shipping of items

taxTotal
number

Total tax amount appliable on shipping of items

appeasementTotal
number

Appeasement amount, if any, processed on the order

originalTaxTotal
number

Original tax amount on order during fist time order creation

returnTotal
number

Return amount incase of order return

cancelTotal
number

Cancel amount incase of order cancellation

invoiceTotal
number

Invoice value on order

orderTotal
number

Total order amount after calculating fees, discounts, retrurn and cancellation if any

originalOrderTotal
number

Order amount during first time order creation after calculating all fees, taxes, and discounts

currency
string
statusCode
required
string
statusDescription
string
object
Array of objects
Array of objects

Array of appeasements, if any

Array of objects
object

Order customer model

Array of objects
required
Array of objects [ 1 .. 2147483647 ] items
required
Array of objects [ 1 .. 2147483647 ] items
Array of objects
Array of objects
orderReleaseTimestamp
string <date-time>

Order dispatched date and time

createdAt
string <date-time>

Date and time when the original order is modified for the first time, for example for return, cancellation or replacement

updatedAt
string <date-time>

Date and time when the exisiting order is updated

Responses
200

Order object Updated

400

Bad request

404

Order not found

500

Internal Server Error

put/order/{orderNumber}
Request 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"
}
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"
}