Order service OpenAPI specification (2.0.0)

Download OpenAPI specification:Download

E-mail: support@fabric.inc License: Fabric Privacy Policy Terms of Service

fabric's Order APIs are high performance endpoints built on highly scalable architecture, and include a configurable data model to orchestrate the order fulfillment process. These APIs let merchants create order records, initiate post-order process workflows and manage order related data such as, invoicing, tracking, returns, exchange, cancellation, appeasements, backorders, and other use cases.

Appeasement

Appeasement refers to a goodwill credit applied to a fulfilled order when customer faces difficulties for an order, for example late delivery, received damaged product, and like wise. This endpoint help in creating appeasement for customer orders.

Create appeasement

Creates an appeasement for customer order.

SecurityAuthorization or context
Request
header Parameters
required
object (XSiteContext)

x-site-context value

Request Body schema: application/json
orderNumber
required
string

It is required and used as a primary identifier to apply appeasement on an order.

appeasementType
string

Appeasement at order level

object (OrderCustomer)

Order customer model

userID
required
string

It is used as identifier of the user who initiates the appeasement request

source
required
string

Identifies the system by which the request was initiated

Array of objects (OrderAppeasementInfo)

It represents the order-level appeasements. It is necessary to add at least one of the order-level or item-level appeasements.

Array of objects (OrderLineItemAppeasement)

It represents the wrapper of item-level appeasements. It is necessary to add at least one of the order-level or item-level appeasements

Responses
200

Appeasement Completed

400

Bad Request

404

Not Found

500

Internal Server Error

post/appeasement
Request samples
application/json
{
  • "orderNumber": "123",
  • "appeasementType": "refund",
  • "customer": {
    },
  • "userID": "12",
  • "source": "SFSC",
  • "appeasements": [
    ],
  • "items": [
    ]
}
Response samples
application/json
{
  • "responseCode": "SUCCESS",
  • "responseMessage": "API Operation successfully completed",
  • "responseData": {
    }
}

Package Tracking

Package Tracking endpoint helps in performing package tracking operations

Acknowledge package tracking

Acknowledges package tracking details

SecurityAuthorization or context
Request
header Parameters
required
object (XSiteContext)

x-site-context value

Request Body schema: application/json
orderNumber
required
string

Order number generated by fabric OMS

eventType
required
string
Enum: "ORDER_CREATE_IN_PTS" "ORDER_CANCELLED_IN_PTS" "SHIPMENT_CREATE_IN_PTS" "SHIPMENT_CANCELLED_IN_PTS"
entity
required
string
Enum: "ORDER" "SHIPMENT"
shipmentId
string

Shipment ID generated by fabric OMS

Responses
200

OK

400

Bad Request

404

Not found

500

Internal Server Error

post/package-tracking/acknowledge
Request samples
application/json
{
  • "orderNumber": "order123",
  • "eventType": "ORDER_CREATE_IN_PTS",
  • "entity": "ORDER",
  • "shipmentId": "shipment123"
}
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"
}

Payment Status

This endpoint helps in retrieving payment status for an order

Get payment details for a specific order

Retrieves payment details for a specific order by order number

SecurityAuthorization or context
Request
path Parameters
orderNumber
required
string
Example: 309019176
header Parameters
required
object (XSiteContext)

x-site-context value

Request Body schema: application/json
paymentIdentifier
string

paymentIdentifier

type
string

Payment type

status
string

Payment status

object (OrderUpdatePaymentStatusRequestBalances)
object (OrderUpdatePaymentStatusConnectorInfo)

Payment processing platform details

Responses
200

Payment Status

400

Bad request

404

Not found!

500

Internal server error

post/payment-status/{orderNumber}
Request samples
application/json
{
  • "paymentIdentifier": "62272e917b12209e68751d94",
  • "type": "VISA",
  • "status": "Success",
  • "balances": {
    },
  • "connectorInfo": {
    }
}
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"
}

Order Cancellation

These endpoints help in performing order cancellation operations

Check order-cancellation eligibility

Checks if a specific order is eligible for cancellation.

SecurityAuthorization or context
Request
query Parameters
orderId
required
string

Oder ID

Example: orderId=62f3982438bcab1951be0a19
lineItemIds
Array of strings

Array of line item IDs to check if the line items are eligible for cancellation

Example: lineItemIds=12345
header Parameters
required
object (XSiteContext)

x-site-context value

Responses
200

OK

400

Bad request

404

Not found

500

Internal server error

get/cancel
Response samples
application/json
{
  • "orderId": "62f3982438bcab1951be0a19",
  • "eligibleReasonCodes": [
    ],
  • "policyType": "Exchange or return or cancellation",
  • "period": "30D00H00M",
  • "items": [
    ],
  • "fees": [
    ]
}

Cancel order

Cancels order

SecurityAuthorization or context
Request
header Parameters
required
object (XSiteContext)

x-site-context value

Request Body schema: application/json
orderId
required
string
reasonCode
required
string

Set to all line items and header audits logs

subReasonCode
string

Set to all line items and header audits logs

source
string

Determine where the request is initialize

employeeId
number

Determine who initiate the request

note
string

Use to add notes

policyCode
string

Set policy code

object

Set attributes to header level audit log's attribute object

Array of objects (OrderCancelLineItem)

Set when doing line item level cancellation other set to null or empty

Responses
200

Order cancelled

400

Bad request

404

Not found

500

Internal server error

post/cancel
Request samples
application/json
{
  • "orderId": "62f3982438bcab1951be0a19",
  • "reasonCode": "wrong item",
  • "subReasonCode": "Ordered item doesn't match",
  • "source": "string",
  • "employeeId": "AD5069",
  • "note": "Wrong item is sent to customer",
  • "policyCode": "Cancel",
  • "attributes": {
    },
  • "items": [
    ]
}
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"
}

Order

An order is a customer's request to purchase one or more products from a shop or from a website. Order endponts let merchants get order details, create, update, and delete orders.

Create an order

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

SecurityAuthorization or context
Request
header Parameters
required
object (XSiteContext)

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 (OrderRetail)

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 (OrderFeeDetail)
Array of objects (OrderDiscountDTO)

Array of discount objects

object (OrderCustomer)

Order customer model

Array of objects (OrderPaymentDTO)
required
Array of objects (OrderItemDTO) [ 1 .. 2147483647 ] items

Array of items for which order is processed

required
Array of objects (OrderShipInfo) [ 1 .. 2147483647 ] items
Array of objects (OrderNote)

Notes section to be used for CSR only

Responses
200

Order Created

400

Bad Request

404

Not Found

500

Internal Server Error

post/
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"
}

Get an order

Retrieves an order by orderId or orderNumber. If orderId or orderNumber is not provided, this endpoint retrieves all orders for a merchant.

SecurityAuthorization or context
Request
query Parameters
orderNumber
string
Example: orderNumber=309019176
orderId
required
string
Example: orderId=5349b4ddd2781d08c09890f4
header Parameters
required
object (XSiteContext)

x-site-context value

Responses
200

Order Found

400

Bad Request

404

Order not found

500

Internal Server Error

get/
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"
}

Update an order

Updates an order by order number

SecurityAuthorization or context
Request
path Parameters
orderNumber
required
string
Example: 309019176
header Parameters
required
object (XSiteContext)

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 (OrderRetail)

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 (OrderFeeDetail)
Array of objects (OrderAppeasementDetail)

Array of appeasements, if any

Array of objects (OrderDiscount)
object (OrderCustomer)

Order customer model

Array of objects (OrderPayment)
required
Array of objects (OrderItem) [ 1 .. 2147483647 ] items
required
Array of objects (OrderShipInfo) [ 1 .. 2147483647 ] items
Array of objects (OrderAuditLog)
Array of objects (OrderNote)
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/{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"
}

Get orders by query

Retrieves orders based on query model passed in the request body.

SecurityAuthorization or context
Request
header Parameters
required
object (XSiteContext)

x-site-context value

Request Body schema: application/json
limit
integer <int32>
Default: 10

Numbers of records to be returned

offset
integer <int64>
Default: 0

Number of records to skipped

sortBy
string
Default: "updatedAt"

Item property on which data needed to be sorted on

sortDirection
string
Default: "desc"

Direction of sorting- ascending or descending

Enum: "asc" "desc"
required
object
Default: {}

JSON to do filtration of records. to filter records json structure should be similar to target entity structure i.e order, shipment etc

Responses
200

Matched orders

400

Bad request

404

Orders not found

500

Internal server error

post/query
Request samples
application/json
{
  • "limit": 10,
  • "offset": 0,
  • "sortBy": "updatedAt",
  • "sortDirection": "desc",
  • "filters": {
    }
}
Response samples
application/json
{
  • "count": 100,
  • "limit": 10,
  • "offset": 1,
  • "orders": [
    ]
}

Update pickup information of an order

Updates pickup information of a specific order by order ID.

SecurityAuthorization or context
Request
path Parameters
orderId
required
string
Example: b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569
shipToId
required
string
Example: 5349b4ddd2781d08c09890f4
header Parameters
required
object (XSiteContext)

x-site-context value

Request Body schema: application/json