Acknowledge package tracking

Acknowledges package tracking details

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

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

Package tracking acknowledgement object

orderNumber

string

required

Order number generated by fabric OMS

Example:

"order123"

eventType

enum<string>

required

Available options:

ORDER_CREATE_IN_PTS,

ORDER_CANCELLED_IN_PTS,

SHIPMENT_CREATE_IN_PTS,

SHIPMENT_CANCELLED_IN_PTS

Example:

"ORDER_CREATE_IN_PTS"

entity

enum<string>

required

Available options:

ORDER,

SHIPMENT

Example:

"ORDER"

shipmentId

string

Shipment ID generated by fabric OMS

Example:

"shipment123"

Response

200

application/json

OK

• Option 1
• Option 2

Order response body

orderNumber

string

required

Unique order number

Example:

"309019176"

channelId

string

required

Sales channel ID

Example:

"12"

statusCode

string

required

Example:

"ORDER_CREATED"

items

object[]

required

OrderItem Model

Show child attributes

items.lineItemId

string

required

Example:

"b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569"

items.lineItemNumber

integer

required

Example:

1

items.itemId

string

required

Example:

"1234"

items.sku

string

required

Example:

"P1234"

items.shipToId

string

required

Unique ID to link item with its shipping address. If all items of an order are shipped to single address, then all items will have same shipTo id. If multiple items of an order are shipped to multiple shipping address, then corresponding shipTo id is linked to each item.

Example:

"b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569"

items.channelId

string

Example:

"WHBM"

items.segment

string

Example:

"P1234"

items.vendorId

string

Example:

"P1234"

items.title

string

Example:

"Item"

items.type

string

Identify order type whether it's pickup item, or web ship, or international order

Example:

"WEB_SHIP"

items.subType

string

Example:

"Borderfree"

items.backorder

boolean

Identify whether this item has been ordered as backorder

Example:

true

items.orderedQuantity

integer

Example:

60

items.backOrderedQuantity

integer

Example:

10

items.pendingShippedQuantity

integer

Example:

10

items.pendingShippedBackOrderQuantity

integer

Example:

10

items.shippedQuantity

integer

Example:

10

items.deliveredQuantity

integer

Example:

10

items.invoiceQuantity

integer

Example:

10

items.cancelledQuantity

integer

Example:

10

items.pendingReturnQuantity

integer

Example:

10

items.processingReturnQuantity

integer

Example:

10

items.rejectedReturnQuantity

integer

Example:

10

items.returnedQuantity

integer

Example:

10

items.reshippedQuantity

integer

Example:

10

items.uom

string

Example:

"EA"

items.itemUnitPrice

number

Example:

10

items.itemSubTotal

number

Example:

600

items.originalItemSubTotal

number

Example:

600

items.itemFeeTotal

number

Example:

5

items.originalFeeTotal

number

Example:

5

items.itemShippingTotal

number

Example:

5

items.originalShippingTotal

number

Example:

5

items.appeasementTotal

number

Example:

5.5

items.itemDiscountsTotal

number

Example:

55

items.originalDiscounts

number

Example:

55

items.itemTaxTotal

number

Example:

5

items.originalTaxTotal

number

Example:

555

items.itemTotal

number

Example:

555

items.originalItemTotal

number

Example:

555

items.outstandingItemTotal

number

Example:

555

items.originalOutstandingItemTotal

number

Example:

555

items.invoiceTotal

number

Example:

555

items.currency

string

Example:

"USD"

items.employeeId

string

Example:

"5345HJH"

items.associateId

string

Example:

"5345HJH"

items.fees

object[]

OrderInvoiceDetail Model

Show child attributes

items.fees.type

string

Example:

"tax"

items.fees.value

number

Example:

34.56

items.fees.invoiceQuantity

integer

Example:

34

items.fees.refundAmount

number

Example:

10.4

items.fees.quantity

integer

Example:

12

items.appeasements

object[]

Order appeasement detail object

Show child attributes

items.appeasements.appeasementCounter

integer

Counter number where appeasement is processed. It is used for retail transactions

Example:

1

items.appeasements.reasonCode

string

Example:

"Incorrect item"

items.appeasements.subReasonCode

string

Example:

"Late shipping"

items.appeasements.value

number

Appeasement amount

Example:

34.56

items.appeasements.invoiceValue

number

Appeasement invoice value; should be equal to appeasement value

Example:

34.56

items.appeasements.payments

object[]

Array of appeasement payments

Order appeasement payment information object

Show child attributes

items.appeasements.payments.paymentCounter

integer

Counter number where appeasement payment is processed

Example:

1

items.appeasements.payments.refundAmount

number

Example:

40

items.returns

object[]

OrderReturns Model

Show child attributes

items.returns.shipmentId

string

Example:

"12353543"

items.returns.shipmentLineItemId

string

Example:

"2412341"

items.returns.shipmentQuantity

integer

Example:

1

items.returns.refundAmount

number

Example:

11.29

items.returns.invoicedAmount

number

Example:

11.29

items.returns.returnsCreatedAt

string

Example:

"2022-09-14T14:07:36.861Z"

items.taxCode

string

Example:

"FR01"

items.taxDetail

object[]

Show child attributes

items.taxDetail.type

string

Example:

"tax"

items.taxDetail.value

number

Example:

34.56

items.discounts

object[]

Order discount object

Show child attributes

items.discounts.quantity

integer

Example:

2

items.discounts.amount

number

Example:

2.4

items.discounts.unit

string

Example:

"AMOUNT_OFF"

items.discounts.value

integer

Example:

2

items.discounts.promoId

string

Example:

"HNY2022"

items.discounts.promoCode

string

Example:

"HNY2022"

items.discounts.promoTitle

string

Example:

"Happy New Year"

items.discounts.type

string

Example:

"promotion"

items.discounts.invoiceQuantity

integer

Example:

2

items.discounts.returnQuantity

integer

Example:

2

items.discounts.cancelQuantity

integer

Example:

2

items.attributes

object

Show child attributes

items.attributes.{key}

object

Example:

{
  "isDonation": true,
  "isGiftCard": false,
  "isFinalSale": false,
  "returnsLink": true
}

Example:

{
  "isDonation": true,
  "isGiftCard": false,
  "isFinalSale": false,
  "returnsLink": true
}

items.exchangeItem

boolean

Example:

true

items.parentLineItemNumber

integer

Example:

12

items.pendingExchangeQuantity

integer

Example:

12

items.exchangeQuantity

integer

Example:

13

items.refundAmount

number

Example:

12.4

items.lineOrderStatus

string

Example:

"VALID"

items.infiniteConsent

boolean

Example:

true

items.notes

object[]

Notes section to be used for CSR only

Show child attributes

items.notes.timestamp

string

Example:

"2022-05-12T09:30:31.198Z"

items.notes.user

string

Example:

"62272e917b12209e68751d94"

items.notes.notes

string

Example:

"Extra information to be provided"

items.gifting

boolean

Example:

true

shipInfo

object[]

required

Order shipping info

Show child attributes

shipInfo.shipToId

string

required

Unique ID to link item with its shipping address. If all items of an order are shipped to single address, then all items will have same shipTo id. If multiple items of an order are shipped to multiple shipping address, then corresponding shipTo id is linked to each item.

Example:

"5349b4ddd2781d08c09890f4"

shipInfo.taxCode

string

Code for the tax applied for shiping of items to the adress

Example:

"FR01"

shipInfo.locationNum

string

Location number to be used for BOPIS (Buy Online Purchase In Store) to identify the pickup store

Example:

"123"

shipInfo.pickup

object[]

Details of the person who picks up the order

Show child attributes

shipInfo.pickup.name

object

Name for order details

Show child attributes

shipInfo.pickup.name.first

string

Example:

"John"

shipInfo.pickup.name.middle

string

Example:

"Middle"

shipInfo.pickup.name.last

string

Example:

"Doe"

shipInfo.pickup.email

string

Example:

"[e-mail]"

shipInfo.pickup.phone

object

Contact details of customer for the order

Show child attributes

shipInfo.pickup.phone.number

string

Example:

"55555555555"

shipInfo.pickup.phone.type

enum<string>

Available options:

MOBILE,

HOME,

BUSINESS

Example:

"MOBILE"

shipInfo.pickup.pickupType

enum<string>

Available options:

Primary,

Alternate

Example:

"Primary"

shipInfo.shipToAddress

object

Order billing or shipping address

Show child attributes

shipInfo.shipToAddress.address1

string

required

Example:

"First line of address"

shipInfo.shipToAddress.name

object

Name for order details

Show child attributes

shipInfo.shipToAddress.name.first

string

Example:

"John"

shipInfo.shipToAddress.name.middle

string

Example:

"Middle"

shipInfo.shipToAddress.name.last

string

Example:

"Doe"

shipInfo.shipToAddress.email

string

Example:

"[e-mail]"

shipInfo.shipToAddress.phone

object

Contact details of customer for the order

Show child attributes

shipInfo.shipToAddress.phone.number

string

Example:

"55555555555"

shipInfo.shipToAddress.phone.type

enum<string>

Available options:

MOBILE,

HOME,

BUSINESS

Example:

"MOBILE"

shipInfo.shipToAddress.address2

string

Example:

"123 Parking Lot"

shipInfo.shipToAddress.address3

string

Example:

"Third line of address"

shipInfo.shipToAddress.address4

string

Example:

"Fourth line of address"

shipInfo.shipToAddress.city

string

Example:

"Beaumont"

shipInfo.shipToAddress.state

string

Example:

"TX"

shipInfo.shipToAddress.country

string

Example:

"USA"

shipInfo.shipToAddress.postalCode

string

Example:

"77705"

shipInfo.shipToAddress.type

string

Example:

"residence"

shipInfo.shipToAddress.latitude

number

Latitude of the address

Example:

35.294952

shipInfo.shipToAddress.longitude

number

Longitude of the address

Example:

32.294952

shipInfo.taxDetail

object[]

Show child attributes

shipInfo.taxDetail.type

string

Example:

"tax"

shipInfo.taxDetail.value

number

Example:

34.56

shipInfo.shipMethod

string

Example:

"Express Delivery"

shipInfo.shipToType

string

Example:

"SHIP_TO_ADDRESS"

shipInfo.estimatedShipDate

string

Example:

"2022-05-12T09:30:31.198Z"

shipInfo.estimatedDeliveryDate

string

Example:

"2022-05-12T09:30:31.198Z"

shipInfo.shipToPrice

number

Amount applicable for shipping the item to the address

Example:

20

shipInfo.shipToDiscount

number

Discount amount applied for shipping the item to the address

Example:

12.6

shipInfo.shipToTaxTotal

number

Total tax applicable to ship the item to the address

Example:

12.6

shipInfo.shipmentInstructions

string

Additional user instructions

Example:

"User instructions"

shipInfo.attributes

object

Show child attributes

shipInfo.attributes.{key}

object

Example:

{ "isOpenBox": false, "isOTPDElivery": true }

Example:

{ "isOpenBox": false, "isOTPDElivery": true }

version

integer

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

Example:

"5349b4ddd2781d08c09890f4"

orderDate

string

Actual order creation date

Example:

"2022-05-12T09:30:31.198Z"

cancellationDate

string

Order cancellation date if any

Example:

"2022-05-12T09:30:31.198Z"

allocationDate

string

Order allocation date after order is created

Example:

"2022-05-12T09:30:31.198Z"

cartId

string

ID of the cart where order is placed

Example:

"b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569"

type

enum<string>

Platfrom using which order is created

Available options:

WEB,

CSC,

MOBILE_APP,

POS

Example:

"WEB"

subType

enum<string>

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

Available options:

IOS,

Android,

International

Example:

"International"

processName

string

Order process name

Example:

"CANCEL"

employeeId

string

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

Example:

"43278"

retail

object

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

Show child attributes

retail.locationNum

integer

Store number of line item's fulfillment origin.

Example:

123

retail.cashierId

string

Cashier ID in case of retail transaction.

Example:

"C-123"

retail.registerId

string

Registered user ID of the cashier who helps in creating the order. It is applicable for retail transactions.

Example:

"113"

retail.transactionId

string

Transaction ID incase of retail transaction.

Example:

"R123-431-1133-2129"

orderSubTotal

number

Order value after calculating discounts and any applicable fees

Example:

123.45

originalSubTotal

number

Original order total value

Example:

113.45

orderDiscount

number

Final discount value on order amount

Example:

1.23

originalDiscounts

number

Original discount on order value

Example:

1.45

feeTotal

number

Total fees, if any, applicable on order amount

Example:

12.34

originalFeeTotal

number

Original fees appliable on shipping of items

Example:

12.34

taxTotal

number

Total tax amount appliable on shipping of items

Example:

12.34

appeasementTotal

number

Appeasement amount, if any, processed on the order

Example:

12.34

originalTaxTotal

number

Original tax amount on order during fist time order creation

Example:

12.34

returnTotal

number

Return amount incase of order return

Example:

12.34

cancelTotal

number

Cancel amount incase of order cancellation

Example:

12.34

invoiceTotal

number

Invoice value on order

Example:

12.34

orderTotal

number

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

Example:

146.9

originalOrderTotal

number

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

Example:

146.9

currency

string

Example:

"USD"

statusDescription

string

Example:

"Order Created"

attributes

object

Show child attributes

attributes.{key}

object

Example:

{
  "type": "String/Number/JSON",
  "purchaseOrder": "String",
  "salesRepId": "String",
  "approve": "String",
  "fraudCheckSessionId": "aee6d1face0e4d55948d1e30b6240048",
  "fraudCheckStatus": "UPDATED",
  "fraudCheckTransId": "0R12TQ46",
  "fraudScore": "31"
}

Example:

{
  "type": "String/Number/JSON",
  "purchaseOrder": "String",
  "salesRepId": "String",
  "approve": "String",
  "fraudCheckSessionId": "aee6d1face0e4d55948d1e30b6240048",
  "fraudCheckStatus": "UPDATED",
  "fraudCheckTransId": "0R12TQ46",
  "fraudScore": "31"
}

fees

object[]

Order fee detail model

Show child attributes

fees.type

string

Example:

"shipping"

fees.value

number

Example:

34.56

fees.invoiceValue

number

Example:

34.56

appeasements

object[]

Array of appeasements, if any

Order appeasement detail object

Show child attributes

appeasements.appeasementCounter

integer

Counter number where appeasement is processed. It is used for retail transactions

Example:

1

appeasements.reasonCode

string

Example:

"Incorrect item"

appeasements.subReasonCode

string

Example:

"Late shipping"

appeasements.value

number

Appeasement amount

Example:

34.56

appeasements.invoiceValue

number

Appeasement invoice value; should be equal to appeasement value

Example:

34.56

appeasements.payments

object[]

Array of appeasement payments

Order appeasement payment information object

Show child attributes

appeasements.payments.paymentCounter

integer

Counter number where appeasement payment is processed

Example:

1

appeasements.payments.refundAmount

number

Example:

40

discounts

object[]

Order discount object

Show child attributes

discounts.quantity

integer

Example:

2

discounts.amount

number

Example:

2.4

discounts.unit

string

Example:

"AMOUNT_OFF"

discounts.value

integer

Example:

2

discounts.promoId

string

Example:

"HNY2022"

discounts.promoCode

string

Example:

"HNY2022"

discounts.promoTitle

string

Example:

"Happy New Year"

discounts.type

string

Example:

"promotion"

discounts.invoiceQuantity

integer

Example:

2

discounts.returnQuantity

integer

Example:

2

discounts.cancelQuantity

integer

Example:

2

customer

object

Order customer model

Show child attributes

customer.name

object

Name for order details

Show child attributes

customer.name.first

string

Example:

"John"

customer.name.middle

string

Example:

"Middle"

customer.name.last

string

Example:

"Doe"

customer.email

string

Example:

"[e-mail]"

customer.phone

object

Contact details of customer for the order

Show child attributes

customer.phone.number

string

Example:

"55555555555"

customer.phone.type

enum<string>

Available options:

MOBILE,

HOME,

BUSINESS

Example:

"MOBILE"

customer.userId

string

It is shopper's ID who visits company website to purchase products.

Example:

"62272e917b12209e68751d94"

customer.accountId

string

Account ID such as loyalty account ID or memebr account ID. Refers to any external system or fabric's loyalty service that the user has account with.

Example:

"62272e917b12209e68751d94"

customer.employeeId

string

ID of the employee (sales person) who creates an order for shopper.

Example:

"62272e917b12209e68751d94"

customer.company

string

Example:

"fabric"

payments

object[]

OrderPayment Model

Show child attributes

payments.paymentCounter

integer

Example:

1

payments.paymentDate

string

Example:

"2022-01-27T16:15:58-05:00"

payments.billToId

string

Example:

"62272e917b12209e68751d94"

payments.paymentIdentifier

object

OrderPaymentIdentifier Model

Show child attributes

payments.paymentIdentifier.cardIdentifier

string

Last 4 digits from cart number

Example:

"3456"

payments.paymentIdentifier.expirationYear

string

Card expiration year

Example:

"2029"

payments.paymentIdentifier.expirationMonth

string

Card expiration month

Example:

"2029"

payments.paymentIdentifier.paymentId

string

Example:

"62272e917b12209e68751d94"

payments.paymentIdentifier.fabricPaymentReference

string

Example:

"test"

payments.paymentProvider

string

Example:

"stripe"

payments.paymentToken

object

Payment token details

Show child attributes

payments.paymentToken.token

string

Payment token generated by checkout service

Example:

"pi_34tr6787rt"

payments.paymentToken.paymentType

string

Used to identify payment type in case of credit cards

Example:

"VISA"

payments.paymentMethod

string

Example:

"CREDIT_CARD"

payments.authAmount

number

Example:

123.2

payments.chargedAmount

number

Example:

60

payments.refundAmount

number

Example:

40

payments.currency

string

Example:

"USD"

payments.conversion

number

Example:

1

payments.paymentStatus

string

Example:

"OK"

payments.partialCapture

string

Example:

"false"

payments.finalCapture

string

Example:

"false"

payments.paymentLog

object[]

PaymentResponse Model

Show child attributes

payments.paymentLog.paymentId

string

payments.paymentLog.status

string

payments.paymentLog.data

object

PaymentDetails Model

Show child attributes

payments.paymentLog.data.status

string

payments.paymentLog.data.body

object

PaymentDetailsResponseBody Model

Show child attributes

payments.paymentLog.data.body.transactionId

string

payments.paymentLog.data.body.transactionTimestamp

string

payments.paymentLog.data.body.responseCode

string

payments.paymentLog.data.body.status

string

payments.paymentLog.data.body.attributes

object

Show child attributes

payments.paymentLog.data.body.errors

object[]

Show child attributes

Example:

"payment response list"

payments.billToAddress

object

Order billing or shipping address

Show child attributes

payments.billToAddress.address1

string

required

Example:

"First line of address"

payments.billToAddress.name

object

Name for order details

Show child attributes

payments.billToAddress.name.first

string

Example:

"John"

payments.billToAddress.name.middle

string

Example:

"Middle"

payments.billToAddress.name.last

string

Example:

"Doe"

payments.billToAddress.email

string

Example:

"[e-mail]"

payments.billToAddress.phone

object

Contact details of customer for the order

Show child attributes

payments.billToAddress.phone.number

string

Example:

"55555555555"

payments.billToAddress.phone.type

enum<string>

Available options:

MOBILE,

HOME,

BUSINESS

Example:

"MOBILE"

payments.billToAddress.address2

string

Example:

"123 Parking Lot"

payments.billToAddress.address3

string

Example:

"Third line of address"

payments.billToAddress.address4

string

Example:

"Fourth line of address"

payments.billToAddress.city

string

Example:

"Beaumont"

payments.billToAddress.state

string

Example:

"TX"

payments.billToAddress.country

string

Example:

"USA"

payments.billToAddress.postalCode

string

Example:

"77705"

payments.billToAddress.type

string

Example:

"residence"

payments.billToAddress.latitude

number

Latitude of the address

Example:

35.294952

payments.billToAddress.longitude

number

Longitude of the address

Example:

32.294952

payments.attributes

object

Show child attributes

payments.attributes.{key}

object

Example:

{ "expirationMonth": 12 }

Example:

{ "expirationMonth": 12 }

auditLogs

object[]

OrderAuditLog Model

Show child attributes

auditLogs.auditId

string

Example:

"62272e917b12209e68751d94"

auditLogs.auditType

string

auditLogs.employeeId

string

Example:

"62272e917b12209e68751d94"

auditLogs.auditTimestamp

string

Example:

"2022-05-12T09:24:54.804Z"

auditLogs.source

string

Example:

"POS"

auditLogs.reasonCode

string

Example:

"POS"

auditLogs.subReasonCode

string

Example:

"POS"

auditLogs.policyCode

string

Example:

"POS"

auditLogs.note

string

Example:

"Note"

auditLogs.lineItemId

string

Example:

"b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569"

auditLogs.lineItemNumber

integer

Example:

1

auditLogs.sku

string

Example:

"F5F"

auditLogs.quantity

integer

Example:

1

auditLogs.amount

number

Example:

2.4

auditLogs.paymentToken

object

Payment token details

Show child attributes

auditLogs.paymentToken.token

string

Payment token generated by checkout service

Example:

"pi_34tr6787rt"

auditLogs.paymentToken.paymentType

string

Used to identify payment type in case of credit cards

Example:

"VISA"

auditLogs.success

boolean

Example:

true

auditLogs.paymentResponse

object

auditLogs.updatedFields

object[]

OrderAuditLogUpdatedField Model

Show child attributes

auditLogs.updatedFields.fieldName

string

Example:

"UOM"

auditLogs.updatedFields.fieldOriginalValue

string

Example:

"PK"

auditLogs.attributes

object

Show child attributes

auditLogs.attributes.{key}

object

notes

object[]

Show child attributes

notes.timestamp

string

Example:

"2022-05-12T09:30:31.198Z"

notes.user

string

Example:

"62272e917b12209e68751d94"

notes.notes

string

Example:

"Extra information to be provided"

orderReleaseTimestamp

string

Order dispatched date and time

createdAt

string

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

updatedAt

string

Date and time when the exisiting order is updated

Order response body

orderNumber

string

required

Unique order number

Example:

"309019176"

channelId

string

required

Sales channel ID

Example:

"12"

statusCode

string

required

Example:

"ORDER_CREATED"

items

object[]

required

OrderItem Model

Show child attributes

items.lineItemId

string

required

Example:

"b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569"

items.lineItemNumber

integer

required

Example:

1

items.itemId

string

required

Example:

"1234"

items.sku

string

required

Example:

"P1234"

items.shipToId

string

required

Unique ID to link item with its shipping address. If all items of an order are shipped to single address, then all items will have same shipTo id. If multiple items of an order are shipped to multiple shipping address, then corresponding shipTo id is linked to each item.

Example:

"b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569"

items.channelId

string

Example:

"WHBM"

items.segment

string

Example:

"P1234"

items.vendorId

string

Example:

"P1234"

items.title

string

Example:

"Item"

items.type

string

Identify order type whether it's pickup item, or web ship, or international order

Example:

"WEB_SHIP"

items.subType

string

Example:

"Borderfree"

items.backorder

boolean

Identify whether this item has been ordered as backorder

Example:

true

items.orderedQuantity

integer

Example:

60

items.backOrderedQuantity

integer

Example:

10

items.pendingShippedQuantity

integer

Example:

10

items.pendingShippedBackOrderQuantity

integer

Example:

10

items.shippedQuantity

integer

Example:

10

items.deliveredQuantity

integer

Example:

10

items.invoiceQuantity

integer

Example:

10

items.cancelledQuantity

integer

Example:

10

items.pendingReturnQuantity

integer

Example:

10

items.processingReturnQuantity

integer

Example:

10

items.rejectedReturnQuantity

integer

Example:

10

items.returnedQuantity

integer

Example:

10

items.reshippedQuantity

integer

Example:

10

items.uom

string

Example:

"EA"

items.itemUnitPrice

number

Example:

10

items.itemSubTotal

number

Example:

600

items.originalItemSubTotal

number

Example:

600

items.itemFeeTotal

number

Example:

5

items.originalFeeTotal

number

Example:

5

items.itemShippingTotal

number

Example:

5

items.originalShippingTotal

number

Example:

5

items.appeasementTotal

number

Example:

5.5

items.itemDiscountsTotal

number

Example:

55

items.originalDiscounts

number

Example:

55

items.itemTaxTotal

number

Example:

5

items.originalTaxTotal

number

Example:

555

items.itemTotal

number

Example:

555

items.originalItemTotal

number

Example:

555

items.outstandingItemTotal

number

Example:

555

items.originalOutstandingItemTotal

number

Example:

555

items.invoiceTotal

number

Example:

555

items.currency

string

Example:

"USD"

items.employeeId

string

Example:

"5345HJH"

items.associateId

string

Example:

"5345HJH"

items.fees

object[]

OrderInvoiceDetail Model

Show child attributes

items.fees.type

string

Example:

"tax"

items.fees.value

number

Example:

34.56

items.fees.invoiceQuantity

integer

Example:

34

items.fees.refundAmount

number

Example:

10.4

items.fees.quantity

integer

Example:

12

items.appeasements

object[]

Order appeasement detail object

Show child attributes

items.appeasements.appeasementCounter

integer

Counter number where appeasement is processed. It is used for retail transactions

Example:

1

items.appeasements.reasonCode

string

Example:

"Incorrect item"

items.appeasements.subReasonCode

string

Example:

"Late shipping"

items.appeasements.value

number

Appeasement amount

Example:

34.56

items.appeasements.invoiceValue

number

Appeasement invoice value; should be equal to appeasement value

Example:

34.56

items.appeasements.payments

object[]

Array of appeasement payments

Order appeasement payment information object

Show child attributes

items.appeasements.payments.paymentCounter

integer

Counter number where appeasement payment is processed

Example:

1

items.appeasements.payments.refundAmount

number

Example:

40

items.returns

object[]

OrderReturns Model

Show child attributes

items.returns.shipmentId

string

Example:

"12353543"

items.returns.shipmentLineItemId

string

Example:

"2412341"

items.returns.shipmentQuantity

integer

Example:

1

items.returns.refundAmount

number

Example:

11.29

items.returns.invoicedAmount

number

Example:

11.29

items.returns.returnsCreatedAt

string

Example:

"2022-09-14T14:07:36.861Z"

items.taxCode

string

Example:

"FR01"

items.taxDetail

object[]

Show child attributes

items.taxDetail.type

string

Example:

"tax"

items.taxDetail.value

number

Example:

34.56

items.discounts

object[]

Order discount object

Show child attributes

items.discounts.quantity

integer

Example:

2

items.discounts.amount

number

Example:

2.4

items.discounts.unit

string

Example:

"AMOUNT_OFF"

items.discounts.value

integer

Example:

2

items.discounts.promoId

string

Example:

"HNY2022"

items.discounts.promoCode

string

Example:

"HNY2022"

items.discounts.promoTitle

string

Example:

"Happy New Year"

items.discounts.type

string

Example:

"promotion"

items.discounts.invoiceQuantity

integer

Example:

2

items.discounts.returnQuantity

integer

Example:

2

items.discounts.cancelQuantity

integer

Example:

2

items.attributes

object

Show child attributes

items.attributes.{key}

object

Example:

{
  "isDonation": true,
  "isGiftCard": false,
  "isFinalSale": false,
  "returnsLink": true
}

Example:

{
  "isDonation": true,
  "isGiftCard": false,
  "isFinalSale": false,
  "returnsLink": true
}

items.exchangeItem

boolean

Example:

true

items.parentLineItemNumber

integer

Example:

12

items.pendingExchangeQuantity

integer

Example:

12

items.exchangeQuantity

integer

Example:

13

items.refundAmount

number

Example:

12.4

items.lineOrderStatus

string

Example:

"VALID"

items.infiniteConsent

boolean

Example:

true

items.notes

object[]

Notes section to be used for CSR only

Show child attributes

items.notes.timestamp

string

Example:

"2022-05-12T09:30:31.198Z"

items.notes.user

string

Example:

"62272e917b12209e68751d94"

items.notes.notes

string

Example:

"Extra information to be provided"

items.gifting

boolean

Example:

true

shipInfo

object[]

required

Order shipping info

Show child attributes

shipInfo.shipToId

string

required

Unique ID to link item with its shipping address. If all items of an order are shipped to single address, then all items will have same shipTo id. If multiple items of an order are shipped to multiple shipping address, then corresponding shipTo id is linked to each item.

Example:

"5349b4ddd2781d08c09890f4"

shipInfo.taxCode

string

Code for the tax applied for shiping of items to the adress

Example:

"FR01"

shipInfo.locationNum

string

Location number to be used for BOPIS (Buy Online Purchase In Store) to identify the pickup store

Example:

"123"

shipInfo.pickup

object[]

Details of the person who picks up the order

Show child attributes

shipInfo.pickup.name

object

Name for order details

Show child attributes

shipInfo.pickup.name.first

string

Example:

"John"

shipInfo.pickup.name.middle

string

Example:

"Middle"

shipInfo.pickup.name.last

string

Example:

"Doe"

shipInfo.pickup.email

string

Example:

"[e-mail]"

shipInfo.pickup.phone

object

Contact details of customer for the order

Show child attributes

shipInfo.pickup.phone.number

string

Example:

"55555555555"

shipInfo.pickup.phone.type

enum<string>

Available options:

MOBILE,

HOME,

BUSINESS

Example:

"MOBILE"

shipInfo.pickup.pickupType

enum<string>

Available options:

Primary,

Alternate

Example:

"Primary"

shipInfo.shipToAddress

object

Order billing or shipping address

Show child attributes

shipInfo.shipToAddress.address1

string

required

Example:

"First line of address"

shipInfo.shipToAddress.name

object

Name for order details

Show child attributes

shipInfo.shipToAddress.name.first

string

Example:

"John"

shipInfo.shipToAddress.name.middle

string

Example:

"Middle"

shipInfo.shipToAddress.name.last

string

Example:

"Doe"

shipInfo.shipToAddress.email

string

Example:

"[e-mail]"

shipInfo.shipToAddress.phone

object

Contact details of customer for the order

Show child attributes

shipInfo.shipToAddress.phone.number

string

Example:

"55555555555"

shipInfo.shipToAddress.phone.type

enum<string>

Available options:

MOBILE,

HOME,

BUSINESS

Example:

"MOBILE"

shipInfo.shipToAddress.address2

string

Example:

"123 Parking Lot"

shipInfo.shipToAddress.address3

string

Example:

"Third line of address"

shipInfo.shipToAddress.address4

string

Example:

"Fourth line of address"

shipInfo.shipToAddress.city

string

Example:

"Beaumont"

shipInfo.shipToAddress.state

string

Example:

"TX"

shipInfo.shipToAddress.country

string

Example:

"USA"

shipInfo.shipToAddress.postalCode

string

Example:

"77705"

shipInfo.shipToAddress.type

string

Example:

"residence"

shipInfo.shipToAddress.latitude

number

Latitude of the address

Example:

35.294952

shipInfo.shipToAddress.longitude

number

Longitude of the address

Example:

32.294952

shipInfo.taxDetail

object[]

Show child attributes

shipInfo.taxDetail.type

string

Example:

"tax"

shipInfo.taxDetail.value

number

Example:

34.56

shipInfo.shipMethod

string

Example:

"Express Delivery"

shipInfo.shipToType

string

Example:

"SHIP_TO_ADDRESS"

shipInfo.estimatedShipDate

string

Example:

"2022-05-12T09:30:31.198Z"

shipInfo.estimatedDeliveryDate

string

Example:

"2022-05-12T09:30:31.198Z"

shipInfo.shipToPrice

number

Amount applicable for shipping the item to the address

Example:

20

shipInfo.shipToDiscount

number

Discount amount applied for shipping the item to the address

Example:

12.6

shipInfo.shipToTaxTotal

number

Total tax applicable to ship the item to the address

Example:

12.6

shipInfo.shipmentInstructions

string

Additional user instructions

Example:

"User instructions"

shipInfo.attributes

object

Show child attributes

shipInfo.attributes.{key}

object

Example:

{ "isOpenBox": false, "isOTPDElivery": true }

Example:

{ "isOpenBox": false, "isOTPDElivery": true }

version

integer

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

Example:

"5349b4ddd2781d08c09890f4"

orderDate

string

Actual order creation date

Example:

"2022-05-12T09:30:31.198Z"

cancellationDate

string

Order cancellation date if any

Example:

"2022-05-12T09:30:31.198Z"

allocationDate

string

Order allocation date after order is created

Example:

"2022-05-12T09:30:31.198Z"

cartId

string

ID of the cart where order is placed

Example:

"b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569"

type

enum<string>

Platfrom using which order is created

Available options:

WEB,

CSC,

MOBILE_APP,

POS

Example:

"WEB"

subType

enum<string>

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

Available options:

IOS,

Android,

International

Example:

"International"

processName

string

Order process name

Example:

"CANCEL"

employeeId

string

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

Example:

"43278"

retail

object

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

Show child attributes

retail.locationNum

integer

Store number of line item's fulfillment origin.

Example:

123

retail.cashierId

string

Cashier ID in case of retail transaction.

Example:

"C-123"

retail.registerId

string

Registered user ID of the cashier who helps in creating the order. It is applicable for retail transactions.

Example:

"113"

retail.transactionId

string

Transaction ID incase of retail transaction.

Example:

"R123-431-1133-2129"

orderSubTotal

number

Order value after calculating discounts and any applicable fees

Example:

123.45

originalSubTotal

number

Original order total value

Example:

113.45

orderDiscount

number

Final discount value on order amount

Example:

1.23

originalDiscounts

number

Original discount on order value

Example:

1.45

feeTotal

number

Total fees, if any, applicable on order amount

Example:

12.34

originalFeeTotal

number

Original fees appliable on shipping of items

Example:

12.34

taxTotal

number

Total tax amount appliable on shipping of items

Example:

12.34

appeasementTotal

number

Appeasement amount, if any, processed on the order

Example:

12.34

originalTaxTotal

number

Original tax amount on order during fist time order creation

Example:

12.34

returnTotal

number

Return amount incase of order return

Example:

12.34

cancelTotal

number

Cancel amount incase of order cancellation

Example:

12.34

invoiceTotal

number

Invoice value on order

Example:

12.34

orderTotal

number

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

Example:

146.9

originalOrderTotal

number

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

Example:

146.9

currency

string

Example:

"USD"

statusDescription

string

Example:

"Order Created"

attributes

object

Show child attributes

attributes.{key}

object

Example:

{
  "type": "String/Number/JSON",
  "purchaseOrder": "String",
  "salesRepId": "String",
  "approve": "String",
  "fraudCheckSessionId": "aee6d1face0e4d55948d1e30b6240048",
  "fraudCheckStatus": "UPDATED",
  "fraudCheckTransId": "0R12TQ46",
  "fraudScore": "31"
}

Example:

{
  "type": "String/Number/JSON",
  "purchaseOrder": "String",
  "salesRepId": "String",
  "approve": "String",
  "fraudCheckSessionId": "aee6d1face0e4d55948d1e30b6240048",
  "fraudCheckStatus": "UPDATED",
  "fraudCheckTransId": "0R12TQ46",
  "fraudScore": "31"
}

fees

object[]

Order fee detail model

Show child attributes

fees.type

string

Example:

"shipping"

fees.value

number

Example:

34.56

fees.invoiceValue

number

Example:

34.56

appeasements

object[]

Array of appeasements, if any

Order appeasement detail object

Show child attributes

appeasements.appeasementCounter

integer

Counter number where appeasement is processed. It is used for retail transactions

Example:

1

appeasements.reasonCode

string

Example:

"Incorrect item"

appeasements.subReasonCode

string

Example:

"Late shipping"

appeasements.value

number

Appeasement amount

Example:

34.56

appeasements.invoiceValue

number

Appeasement invoice value; should be equal to appeasement value

Example:

34.56

appeasements.payments

object[]

Array of appeasement payments

Order appeasement payment information object

Show child attributes

appeasements.payments.paymentCounter

integer

Counter number where appeasement payment is processed

Example:

1

appeasements.payments.refundAmount

number

Example:

40

discounts

object[]

Order discount object

Show child attributes

discounts.quantity

integer

Example:

2

discounts.amount

number

Example:

2.4

discounts.unit

string

Example:

"AMOUNT_OFF"

discounts.value

integer

Example:

2

discounts.promoId

string

Example:

"HNY2022"

discounts.promoCode

string

Example:

"HNY2022"

discounts.promoTitle

string

Example:

"Happy New Year"

discounts.type

string

Example:

"promotion"

discounts.invoiceQuantity

integer

Example:

2

discounts.returnQuantity

integer

Example:

2

discounts.cancelQuantity

integer

Example:

2

customer

object

Order customer model

Show child attributes

customer.name

object

Name for order details

Show child attributes

customer.name.first

string

Example:

"John"

customer.name.middle

string

Example:

"Middle"

customer.name.last

string

Example:

"Doe"

customer.email

string

Example:

"[e-mail]"

customer.phone

object

Contact details of customer for the order

Show child attributes

customer.phone.number

string

Example:

"55555555555"

customer.phone.type

enum<string>

Available options:

MOBILE,

HOME,

BUSINESS

Example:

"MOBILE"

customer.userId

string

It is shopper's ID who visits company website to purchase products.

Example:

"62272e917b12209e68751d94"

customer.accountId

string

Account ID such as loyalty account ID or memebr account ID. Refers to any external system or fabric's loyalty service that the user has account with.

Example:

"62272e917b12209e68751d94"

customer.employeeId

string

ID of the employee (sales person) who creates an order for shopper.

Example:

"62272e917b12209e68751d94"

customer.company

string

Example:

"fabric"

payments

object[]

OrderPayment Model

Show child attributes

payments.paymentCounter

integer

Example:

1

payments.paymentDate

string

Example:

"2022-01-27T16:15:58-05:00"

payments.billToId

string

Example:

"62272e917b12209e68751d94"

payments.paymentIdentifier

object

OrderPaymentIdentifier Model

Show child attributes

payments.paymentIdentifier.cardIdentifier

string

Last 4 digits from cart number

Example:

"3456"

payments.paymentIdentifier.expirationYear

string

Card expiration year

Example:

"2029"

payments.paymentIdentifier.expirationMonth

string

Card expiration month

Example:

"2029"

payments.paymentIdentifier.paymentId

string

Example:

"62272e917b12209e68751d94"

payments.paymentIdentifier.fabricPaymentReference

string

Example:

"test"

payments.paymentProvider

string

Example:

"stripe"

payments.paymentToken

object

Payment token details

Show child attributes

payments.paymentToken.token

string

Payment token generated by checkout service

Example:

"pi_34tr6787rt"

payments.paymentToken.paymentType

string

Used to identify payment type in case of credit cards

Example:

"VISA"

payments.paymentMethod

string

Example:

"CREDIT_CARD"

payments.authAmount

number

Example:

123.2

payments.chargedAmount

number

Example:

60

payments.refundAmount

number

Example:

40

payments.currency

string

Example:

"USD"

payments.conversion

number

Example:

1

payments.paymentStatus

string

Example:

"OK"

payments.partialCapture

string

Example:

"false"

payments.finalCapture

string

Example:

"false"

payments.paymentLog

object[]

PaymentResponse Model

Show child attributes

payments.paymentLog.paymentId

string

payments.paymentLog.status

string

payments.paymentLog.data

object

PaymentDetails Model

Show child attributes

payments.paymentLog.data.status

string

payments.paymentLog.data.body

object

PaymentDetailsResponseBody Model

Show child attributes

payments.paymentLog.data.body.transactionId

string

payments.paymentLog.data.body.transactionTimestamp

string

payments.paymentLog.data.body.responseCode

string

payments.paymentLog.data.body.status

string

payments.paymentLog.data.body.attributes

object

Show child attributes

payments.paymentLog.data.body.errors

object[]

Show child attributes

Example:

"payment response list"

payments.billToAddress

object

Order billing or shipping address

Show child attributes

payments.billToAddress.address1

string

required

Example:

"First line of address"

payments.billToAddress.name

object

Name for order details

Show child attributes

payments.billToAddress.name.first

string

Example:

"John"

payments.billToAddress.name.middle

string

Example:

"Middle"

payments.billToAddress.name.last

string

Example:

"Doe"

payments.billToAddress.email

string

Example:

"[e-mail]"

payments.billToAddress.phone

object

Contact details of customer for the order

Show child attributes

payments.billToAddress.phone.number

string

Example:

"55555555555"

payments.billToAddress.phone.type

enum<string>

Available options:

MOBILE,

HOME,

BUSINESS

Example:

"MOBILE"

payments.billToAddress.address2

string

Example:

"123 Parking Lot"

payments.billToAddress.address3

string

Example:

"Third line of address"

payments.billToAddress.address4

string

Example:

"Fourth line of address"

payments.billToAddress.city

string

Example:

"Beaumont"

payments.billToAddress.state

string

Example:

"TX"

payments.billToAddress.country

string

Example:

"USA"

payments.billToAddress.postalCode

string

Example:

"77705"

payments.billToAddress.type

string

Example:

"residence"

payments.billToAddress.latitude

number

Latitude of the address

Example:

35.294952

payments.billToAddress.longitude

number

Longitude of the address

Example:

32.294952

payments.attributes

object

Show child attributes

payments.attributes.{key}

object

Example:

{ "expirationMonth": 12 }

Example:

{ "expirationMonth": 12 }

auditLogs

object[]

OrderAuditLog Model

Show child attributes

auditLogs.auditId

string

Example:

"62272e917b12209e68751d94"

auditLogs.auditType

string

auditLogs.employeeId

string

Example:

"62272e917b12209e68751d94"

auditLogs.auditTimestamp

string

Example:

"2022-05-12T09:24:54.804Z"

auditLogs.source

string

Example:

"POS"

auditLogs.reasonCode

string

Example:

"POS"

auditLogs.subReasonCode

string

Example:

"POS"

auditLogs.policyCode

string

Example:

"POS"

auditLogs.note

string

Example:

"Note"

auditLogs.lineItemId

string

Example:

"b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569"

auditLogs.lineItemNumber

integer

Example:

1

auditLogs.sku

string

Example:

"F5F"

auditLogs.quantity

integer

Example:

1

auditLogs.amount

number

Example:

2.4

auditLogs.paymentToken

object

Payment token details

Show child attributes

auditLogs.paymentToken.token

string

Payment token generated by checkout service

Example:

"pi_34tr6787rt"

auditLogs.paymentToken.paymentType

string

Used to identify payment type in case of credit cards

Example:

"VISA"

auditLogs.success

boolean

Example:

true

auditLogs.paymentResponse

object

auditLogs.updatedFields

object[]

OrderAuditLogUpdatedField Model

Show child attributes

auditLogs.updatedFields.fieldName

string

Example:

"UOM"

auditLogs.updatedFields.fieldOriginalValue

string

Example:

"PK"

auditLogs.attributes

object

Show child attributes

auditLogs.attributes.{key}

object

notes

object[]

Show child attributes

notes.timestamp

string

Example:

"2022-05-12T09:30:31.198Z"

notes.user

string

Example:

"62272e917b12209e68751d94"

notes.notes

string

Example:

"Extra information to be provided"

orderReleaseTimestamp

string

Order dispatched date and time

createdAt

string

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

updatedAt

string

Date and time when the exisiting order is updated

Shipment object

shipmentId

string

Shipment ID generated by fabric OMS

Example:

"627963716b19511e8a3a631b"

shipmentNum

string

Shipment number generated by fabric OMS

Example:

"78974156816152"

invoiceId

string

Invoice ID generated by fabric OMS

Example:

"5674156816152"

allocationId

string

Allocation ID generated by fabric OMS

Example:

"112345678912340"

orderNumber

string[]

Order number

Order number

Example:

112345678912340

poNumber

string

Purchase order number

Example:

1125

vendorId

string

Vendor ID

Example:

56

statusCode

string

Shipment status code

Example:

"SHIPPED"

type

string

Shipment type

Example:

"STANDARD"

reshipmentReasonCode

string

Re-shipment reason code, if any

Example:

"Order went missing"

shipDate

string

Shipping date

Example:

"2022-06-06T07:58:30.996Z"

locationNum

string

Location number

Example:

"132412"

locationType

string

Location type

Example:

"DC"

totalCartons

integer

Total number of cartons

Example:

2

masterTrackingNumber

string

Master tracking number

Example:

"TX112345678"

shipToId

string

Unique ID to link item with its shipping address. If all items of an order are shipped to single address, then all items will have same shipTo id. If multiple items of an order are shipped to multiple shipping address, then corresponding shipTo id is linked to each item.

Example:

"1"

shipToAddress

object

ShipmentShipToAddress Model

Show child attributes

shipToAddress.addressLine1

string

address line 1

Example:

"888 Broadway"

shipToAddress.addressLine2

string

address line 2

shipToAddress.addressLine3

string

address line 3

shipToAddress.addressLine4

string

address line 4

shipToAddress.city

string

city

Example:

"New York"

shipToAddress.state

string

state

Example:

"NY"

shipToAddress.country

string

country

Example:

"USA"

shipToAddress.postalCode

string

postal code

Example:

"1003"

shipToAddress.type

string

address type

Example:

"home"

shipToAddress.latitude

number

latitude

Example:

134.13413

shipToAddress.longitude

number

longitude

Example:

757.0435

recipient

object[]

Recipient list

ShipmentRecipient Model

Show child attributes

recipient.name

object

ShipmentName Model

Show child attributes

recipient.name.first

string

first name

Example:

"John"

recipient.name.middle

string

middle name

recipient.name.last

string

last name

Example:

"Doe"

recipient.email

string

email

Example:

"wa"

recipient.phone

object

ShipmentPhone Model

Show child attributes

recipient.phone.number

string

phone number

Example:

"[phone]"

recipient.phone.type

string

type

Example:

"MOBILE"

cartons

object[]

Cartons list

Shipment carton object

Show child attributes

cartons.cartonNum

string

carton number

Example:

"1"

cartons.cartonType

string

Cartoon type

Example:

"Package"

cartons.promisedDeliveryDate

string

Promised delivery date

Example:

"2022-05-26T07:58:30.996Z"

cartons.estimatedShipDate

string

Estimated ship date

Example:

"2022-05-25T07:58:30.996Z"

cartons.estimatedDeliveryDate

string

Estimated delivery date

Example:

"2022-05-26T07:58:30.996Z"

cartons.shipmentMethod

string

Shipment method

Example:

"ground"

cartons.shipmentCarrier

string

Shipment carrier

Example:

"FEDEX"

cartons.weight

string

weight

Example:

"500 gram"

cartons.trackingNumber

string

Tracking number

Example:

"1Z999AA10123456784"

cartons.trackingURL

string

Tracking URL

Example:

"https://fedex.com/tracking"

cartons.trackingDetails

object[]

Tracking detail list

ShipmentTrackingDetail Model

Show child attributes

cartons.trackingDetails.event

string

event

Example:

"picked up"

cartons.trackingDetails.eventId

string

unique event id

Example:

"627963716b19511e8a3a631b"

cartons.trackingDetails.timestamp

string

timestamp

Example:

"2019-09-30T07:58:30.996Z"

cartons.trackingDetails.shipmentCarrier

string

shipment carrier, in case of different carrier

Example:

"FEDEX"

cartons.trackingDetails.location

string

location

Example:

"Reno, NV"

cartons.trackingDetails.notes

object

shipment notes

Show child attributes

cartons.trackingDetails.notes.{key}

string

shipment notes

cartons.items

object[]

Item list

ShipmentItem Model

Show child attributes

cartons.items.shipmentLineItemId

string

shipment line item id

Example:

"607f1f77bcf86cd799439011"

cartons.items.orderId

string

order id

Example:

"317736896"

cartons.items.orderNumber

string

order number

Example:

"507f1f77bcf86cd799439011"

cartons.items.lineItemId

string

line item id

Example:

"1"

cartons.items.itemId

string

item id

Example:

"100023"

cartons.items.sku

string

sku

Example:

"SKU0023"

cartons.items.channelId

string

channel id

Example:

"12"

cartons.items.segment

string

segment

cartons.items.vendorId

string

vendor id

cartons.items.orderedQuantity

integer

ordered quantity

Example:

2

cartons.items.shippedQuantity

integer

shipped quantity

Example:

2

cartons.items.returnQuantity

integer

return quantity

Example:

1

cartons.items.returnAmount

number

return amount

Example:

10

cartons.items.fees

object[]

ShipmentFeeDetail Model

Show child attributes

cartons.items.fees.type

string

Example:

"tax"

cartons.items.fees.value

number

Example:

34.56

cartons.items.fees.quantity

integer

quantity

Example:

12

cartons.items.fees.refundAmount

number

refund amount

Example:

10.4

cartons.items.giftCard

object[]

ShipmentGiftCardDetail Model

Show child attributes

cartons.items.giftCard.giftCardNum

string

gift card number

Example:

"453456765"

cartons.items.giftCard.amount

number

gift card amount

Example:

50

cartons.items.giftCard.giftCardStatus

string

gift card status

Example:

"ACTIVE"

cartons.items.giftCard.giftCardActiveRequestDate

string

gift card activation request date

Example:

"2022-05-26T07:58:30.996Z"

cartons.items.giftCard.giftCardActiveDate

string

gift card activate date

Example:

"2022-06-26T07:58:30.996Z"

cartons.items.attributes

object

Show child attributes

cartons.items.attributes.{key}

object

cartons.items.uom

string

scratchedItems

object[]

Scratched items list

Shipment scratched item object

Show child attributes

scratchedItems.orderId

string

Order ID

Example:

"507f1f77bcf86cd799439012"

scratchedItems.lineItemId

string

Line item ID

Example:

"2"

scratchedItems.itemId

string

Item ID

Example:

"100043"

scratchedItems.sku

string

sku

Example:

"SKU00043"

scratchedItems.quantity

integer

Quantity

Example:

1

scratchedItems.reasonCode

string

Reason code

scratchedItems.subReasonCode

string

Sub reason code

scratchedItems.attributes

object

Scratch item attributes

Show child attributes

scratchedItems.attributes.{key}

object

Scratch item attributes

scratchedItems.uom

string

Example:

"EA"

createdAt

string

Created date

Example:

"2022-06-06T07:58:30.996Z"

updatedAt

string

Updated date

Example:

"2022-06-06T07:58:30.996Z"

auditLogs

object[]

Audit logs list

ShipmentAuditLog Model

Show child attributes

auditLogs.auditType

string

Example:

"create"

auditLogs.employeeId

string

Example:

"62272e917b12209e68751d94"

auditLogs.auditTimestamp

string

Example:

"2022-05-12T09:24:54.804Z"

auditLogs.source

string

Example:

"POS"

auditLogs.note

string

Example:

"Note"

auditLogs.attributes

object

Show child attributes

auditLogs.attributes.{key}

object

auditLogs.updatedFields

object[]

ShipmentAuditLogUpdatedAttribute Model

Show child attributes

auditLogs.updatedFields.attributeName

string

Example:

"UOM"

auditLogs.updatedFields.attributeOriginalValue

string

Example:

"PK"

attributes

object

Attributes to save any additional information

Show child attributes

attributes.{key}

object

Attributes to save any additional information