POST
/
allocations
/
{allocationId}
/
actions
/
update-attributes

Authorizations

Authorization
string
headerrequired

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

Headers

x-fabric-tenant-id
string
required

Merchant's 24-character tenant ID

x-fabric-channel-id
string
required

Sales channel ID

x-fabric-request-id
string

Unique request ID

Path Parameters

allocationId
string
required

The allocation ID is a fabric system-generated unique ID generated on allocation creation.

Body

application/json
attributes
object
required

User defined custom attributes. This is a placeholder for additional info in key value pairs.

keysToRemove
string[]

A list of keys to be removed.

Response

200 - application/json
allocationId
string
required

24-character system-generated allocation ID

allocationNumber
integer

Merchant-specified unique number assigned to each allocation. If omitted, is this generated by fabric’s sequence generator using Configuration service

allocationRequestId
string
required

Merchant-specified unique ID. If omitted, this is generated by fabric’s sequence generator using Configuration service.

auditLogs
object[]

Change history details

createdAt
string
required

System-generated time of allocation record creation

currency
string

Currency

decisionContexts
object[]

A list of decision contexts.

items
object[]

List of items to be shipped

itemsType
string

This is an inherited attribute from Orders that pertains to item types such as WEB_SHIP, WEB_PICKUP, WEB_SDD INTERNATIONAL, POS, POS_SHIP, and POS_PICKUP.

locationNumber
string
required

Inventory location number to identify ship-from location or Buy Online Pickup from Store (BOPIS) location. This must be the locationNumber stored in the fabric Location service.

locationType
string

Inventory location type such as, DC or Store from where the order is picked up

notifiedToPPSAt
string

fabric system-generated time when allocation service sent event notification to package tracking service.

orderSubType
string

During allocation creation, this attribute is inherited from fabric Orders and includes subtypes such as IOS, ANDROID, INTERNATIONAL, among others.

parentAllocationId
string

Allocation ID that is generated while creating the allocation for the first time. Initially this will be the same as allocationRequestId. If there is a reallocation, the parentAllocationId will be assigned the same value as the initial allocationRequestId, and will serve as a means of monitoring all subsequent child allocations.

previousAllocatedLocationNums
string[]

In case of reallocation, it keeps track of previously allocated location numbers.

recipients
object[]

Recipient details like name, email address, and phone number

shipToAddress
object

Address details

shipToId
string

System-generated UUID associated with shipInfo, generated from CnC service. <p> Note: An order can have multiple ship-to (delivery) locations and items going to the same location have one shipToId. </p>

shipmentMethod
string

Shipping method. This attribute is inherited from order.shipInfo during allocation creation.

shipmentType
string

This attribute is inherited from order.shipInfo during allocation creation.Acceptable value: SHIP_TO_ADDRESS, CUSTOMER_PICKUP, PICKUP, SDD, SHIP_TO_STORE

shippedAt
string

Time of order shipment, generated by allocation service when shipment service calls allocation after shipment is created.

statusCode
enum<string>

Allocation status

Available options:
ALLOCATED,
PENDING_DROP,
PENDING_ALLOCATION,
PENDING_PICK,
SHIPPED,
PARTIALLY_SHIPPED,
REALLOCATED,
CANCELLED,
PARTIALLY_CANCELLED,
PENDING_REALLOCATION,
PARTIAL_PENDING_REALLOCATION
type
enum<string>

Allocation type ALLOCATED: Order is allocated for fulfillment SCRATCHED: Order is canceled during allocation due to unavailability of inventory RETURNED: Allocation created for the return items

Available options:
ALLOCATED,
SCRATCHED,
RETURNED
updatedAt
string

System-generated time when allocation record was last modified

version
integer
required

Allocation document version. The version number is incremented each time the allocation document undergoes an update. Update to an allocation document happens automatically when the status changes from one state to another based on the statusCode.

Was this page helpful?

Get allocation by IDGetting Started with Shipments