Cancel allocation

Cancels allocation by allocation ID

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\"}"

Path Parameters

allocationIds

string[]

required

Response

200

application/json

Cancel Allocation

allocationId

string

required

Unique ID for an allocation document

Example:

"62ff5c0bec0aed3c86202c32"

parentAllocationId

string

required

Same as previous allocation document while creating new allocation

Example:

"62ff5c0bec0aed3c86202c32"

locationNum

string

required

Tenant's ship-from location ID

Example:

"1234B"

items

object[]

required

List of items to be shipped

Details of allocation items

Show child attributes

items.itemId

string

required

Item ID

Example:

"100064"

items.sku

string

required

Item SKU

Example:

"123k4h123k"

items.quantity

number

required

Item quantity

Example:

3

items.allocationLineNumber

number

required

Unique number allocated at each item in an order

Example:

3

items.orderLineId

string

Reference order line ID for tracking purpose

Example:

"134fqfaa532qrf"

items.orderId

string

Order ID

Example:

"123k4h123k"

items.orderDate

string

Time of order creation

Example:

"2022-08-01T18:03:28.483971941Z"

items.estimatedDeliveryDate

string

Estimated delivery time

Example:

"2022-08-01T18:03:28.483971941Z"

items.parentAllocationLineNumber

number

Unique number allocated to each item in parent allocation

Example:

3

items.reallocationRequestId

string

Request ID for re-allocation

Example:

"123k4h123k"

items.shippedQuantity

number

Quantity shipped for the specified line item

Example:

1

items.scratchQuantity

number

Total quantity cancelled for the specified line item

Example:

1

items.scratchedReasonCode

string

Reason code for cancellation

Example:

"Scratched during shipment"

items.reshipReasonCode

string

Reason code for reshipment

Example:

"Reshipping during shipment"

items.reallocationReasonCode

string

Reason code for re-allocation

Example:

"Reallocating due to unavailability of location number"

items.channelId

string

Sales channel ID for tenant

Example:

"12"

items.segment

string

Segment associated with item

Example:

null

items.vendorId

string

Vendor ID

Example:

"56"

items.title

string

Item name

Example:

"Demo"

items.weight

number

Item weight

Example:

5.5

items.cost

number

Total cost of item

Example:

500.2

items.price

number

Total price

Example:

50.2

items.itemStatus

enum<string>

Current status of line item

Available options:

CANCELLED,

REFUNDED,

ALLOCATED,

PARTIALLY_ALLOCATED

Example:

"ALLOCATED"

items.attributes

object

Show child attributes

items.attributes.{key}

object

Custom attributes, if any

items.uom

string

Unit of measure

Example:

"KG"

version

integer

Current version of allocation document

Example:

2

allocationRequestId

string

Allocation request ID used for tracking internal communication. Required to update allocation details.

Example:

"62ff5c0bec0aed3c86202c32"

allocationNum

string

Allocation number for client tracking

Example:

"xxyyzz12345"

sentToPPSDate

string

Time of sending allocation event to PPS

Example:

"2022-08-01T18:03:28.483971941Z"

allocationDate

string

Time of allocation creation and when it was stored in database

Example:

"2022-08-01T18:03:28.483971941Z"

updatedAt

string

Time of allocation update

Example:

"2022-08-01T20:03:28.483971941Z"

type

enum<string>

Allocation type

Available options:

ALLOCATED,

SCRATCHED,

RETURNED

Example:

"ALLOCATED"

previousAllocationLocationNum

number

In reallocation scenarios, keeps track of the previously allocation location numbers

Example:

410

poNumber

string | null

Purchase order number (generally, vendor-generated)

Example:

"1125"

itemsType

enum<string>

Items type

Available options:

WEB_SHIP,

POS,

WEB

Example:

"WEB_SHIP"

orderSubType

enum<string>

Sub-type of order

Available options:

IOS,

Android,

International,

Borderfree

Example:

"BORDERFREE"

vendorId

string | null

Vendor ID

Example:

"56"

shipDate

string

Estimated ship date

Example:

null

shipType

string

Optional field for shipment type

Example:

"SHIP_TO_ADDRESS"

shipMethod

string

Optional field for shipment method

Example:

"Overnight Delivery"

shipToId

string

Unique Id for delivery address

Example:

"98ff5c0bec0aed3c86202c32"

statusCode

enum<string>

Allocation status code

Available options:

ALLOCATED,

PENDING_DROP,

PENDING_PICK,

SHIPPED,

PARTIALLY_SHIPPED,

REALLOCATED,

CANCELLED,

PARTIALLY_CANCELLED

Example:

"PENDING_PICK"

locationType

string

Tenant's ship-from location type

Example:

"1234B"

shipToAddress

object

recipient

object[]

Recipient details such as phone number, email, and name

Order pickup details

Show child attributes

recipient.name

object

Contact name

Show child attributes

recipient.name.first

string

First name of contact

Example:

"John"

recipient.name.middle

string

Middle name of contact

Example:

"Middle"

recipient.name.last

string

Last name of contact

Example:

"Doe"

recipient.email

string

Email address of contact

Example:

"[e-mail]"

recipient.phone

object

Details of contact phone number

Show child attributes

recipient.phone.number

string

Phone number of contact person

Example:

"55555555555"

recipient.phone.type

enum<string>

Phone type

Available options:

MOBILE,

HOME,

BUSINESS

Example:

"MOBILE"

recipient.pickupType

enum<string>

Pickup type

Available options:

Primary,

Alternate

Example:

"Primary"

auditLogs

object[]

Logs with updated fields

Details of order audit log

Show child attributes

auditLogs.lineItemId

string

Line item ID

Example:

"4"

auditLogs.auditId

string

Audit ID

Example:

"62272e917b12209e68751d94"

auditLogs.auditType

enum<string>

Audit Type

Available options:

CREATE,

CANCEL,

RETURN,

RESHIP,

SHIP,

UPDATE,

ORDER,

APPEASEMENT,

ORDER_ADJUSTMENT,

ITEM_ADJUSTMENT

Example:

"UPDATE"

auditLogs.employeeId

string

Employee ID (Store context)

Example:

"62272e917b12209e68751d94"

auditLogs.auditTimestamp

string

Time of audit

Example:

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

auditLogs.source

string

Source of audit

Example:

"POS"

auditLogs.reasonCode

string

Reason code

Example:

"POS"

auditLogs.subReasonCode

string

Sub-reason code

Example:

"POS"

auditLogs.policyCode

string

Policy code

Example:

"POS"

auditLogs.note

string

Additional information, if any

Example:

"Note"

auditLogs.lineItemNumber

integer

Line item number for reference

Example:

1

auditLogs.sku

string

Item SKU

Example:

"F5F"

auditLogs.quantity

integer

Item quantity

Example:

1

auditLogs.amount

number

Total order amount

Example:

2.4

auditLogs.paymentToken

object

Details of order payment token

Show child attributes

auditLogs.paymentToken.token

string

Payment token for reference

Example:

"pi_34tr6787rt"

auditLogs.paymentToken.paymentType

string

Payment type for identification

Example:

"VISA"

auditLogs.success

boolean

true: success <br /> false: failure

Example:

true

auditLogs.paymentResponse

object

auditLogs.updatedFields

object[]

Details of audit log

Show child attributes

auditLogs.updatedFields.fieldName

string

Updated field name for audit trail

Example:

"UOM"

auditLogs.updatedFields.fieldOriginalValue

string

Original field name for audit trail

Example:

"PK"

auditLogs.attributes

object

Show child attributes

auditLogs.attributes.{key}

object