Search for allocations by query

Search for inventory allocations based on the matching filter criteria.

Authorizations

Authorization

string

header

required

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

Headers

x-fabric-tenant-id

string

required

A header used by fabric to identify the tenant making the request. You must include tenant id in the authentication header for an API request to access any of fabric’s endpoints. You can retrieve the tenant id , which is also called account id, from Copilot. This header is required.

x-fabric-channel-id

string

required

x-fabric-channel-id identifies the sales channel where the API request is being made; primarily for multichannel use cases. The channel ids are 12 corresponding to US and 13 corresponding to Canada. The default channel id is 12. This field is required.

x-fabric-request-id

string

Unique request ID

Query Parameters

offset

integer

default:

0

Number of records to be skipped before returning all records. Default is 0 when no value is specified.

Example:

0

limit

integer

default:

10

Maximum number of records per page

Required range: 1 <= x <= 100

Example:

10

Body

application/json

Sample request to search allocations

filters

object[]

required

• Option 1
• Option 2

Criteria to find allocations by a single value. Condition between field and value is anything except IN and NIN when valueSearchFilter is used.

Show child attributes

filters.condition

enum<string>

default:

EQ

required

Filter conditions. EQ (Equal to): Searches for exact match. NEQ (Not equal to): Searches by excluding the specified value. IN: Search for multiple values. NIN (Not IN): Excludes the specified values in the search. LT (Less than): Searches for values that are less than the specified value. GT (Greater than): Search for values that are greater than the specified value. LTE (Less than or equal to): Searches for values that are less than or equal to the specified value. GTE (Greater than or equal to): Searches for values that are greater than or equal to the specified value.

Available options:

EQ,

NEQ,

IN,

NIN,

LT,

GT,

LTE,

GTE

Example:

"EQ"

filters.field

string

required

Field name

Example:

"allocation.type"

filters.group

string

default:

Default

The name of the group.

Example:

"GroupA"

filters.value

A single value for field using which allocation details are searched

Example:

"SHIPPING"

sort

string

default:

-allocation.createdAt

Property by which data is sorted

Example:

"+allocation.createdAt"

stats

object

The stats filter resource.

Show child attributes

stats.groupBy

string

required

A list of fields for the stats type.

Example:

"allocation.channelId, allocation.statusCode"

stats.type

enum<string>

required

The stats type.

Available options:

COUNT,

SUM,

AVG

Example:

"COUNT"

stats.unwindOn

string

A field used to UnwindOn/Flatten a resource.

Example:

"allocation.items"

Response

200

application/json

OK

Allocation search response details

data

object[]

Allocation response details

Show child attributes

data.allocationId

string

required

24-character system-generated allocation ID

Example:

"62ff5c0bec0aed3c86202c32"

data.allocationRequestId

string

required

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

Example:

"62ff5c0bec0aed3c86202c32"

data.createdAt

string

required

System-generated time of allocation record creation

Example:

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

data.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.

Example:

"1234B"

data.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.

Example:

2

data.allocationNumber

integer

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

Example:

13000004

data.auditLogs

object[]

Change history details

Audit log to capture change history

Show child attributes

data.auditLogs.amount

number

Amount for which audit's done

Example:

2.4

data.auditLogs.auditId

string

System-generated audit ID (UUID format)

Example:

"a05b72dc-78d8-4ea4-90fc-2fe6a1fe1111"

data.auditLogs.auditType

string

Audit type such as cancel, return, etc.

Example:

"CANCEL"

data.auditLogs.auditedAt

string

Audit time (UTC)

Example:

"2023-03-12T09:24:54.804Z"

data.auditLogs.employeeId

string

Employee (ID or name) who made the last update

Example:

"6227"

data.auditLogs.isSuccess

boolean

default:

false

true: Update operation (any update to the service) is successful. false: Update operation has failed.

Example:

true

data.auditLogs.lineItemId

string

Merchant-defined unique identifier for each item in an order. When omitted, fabric will generate it during order creation, in UUID format.

Example:

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

data.auditLogs.lineItemNumber

integer

Item identifier

Example:

1

data.auditLogs.note

string

Additional info, if any

Example:

"Note"

data.auditLogs.paymentToken

object

Order payment token details

Show child attributes

data.auditLogs.paymentToken.paymentType

string

Payment type, for example, credit card payment providers can be Visa, Mastercard, American express, etc.

Example:

"VISA"

data.auditLogs.paymentToken.token

string

Payment token provided by payment provider

Example:

"pi_34tr6787rt"

data.auditLogs.policyCode

string

Configurable in Copilot as per requirement. If omitted, default policy is used.

Example:

"POS"

data.auditLogs.quantity

integer

Ordered quantity of given item

Example:

1

data.auditLogs.reasonCode

string

Merchant-defined reason code, varies from merchant to merchant

Example:

"Scratched item"

data.auditLogs.sku

string

Stock keeping unit (SKU), unique item identifier

Example:

"SKU0023"

data.auditLogs.source

string

Merchant-defined source from where the update was initiated. There are no predefined values; possible values could be Customer Service Representative (CSR), Point-of-Sale (POS), etc.

Example:

"POS"

data.auditLogs.subReasonCode

string

Merchant-defined sub reason code; provides more clarity to audit reason

Example:

"Scratched item"

data.auditLogs.updatedFields

object[]

Audit log for change history

Audit log for change history

Show child attributes

data.auditLogs.updatedFields.fieldName

string

Field or property name that was updated

Example:

"UOM"

data.auditLogs.updatedFields.fieldOriginalValue

string

Original value of fieldName before it was updated

Example:

"PK"

data.currency

string

Currency

Example:

"USD"

data.decisionContexts

object[]

A list of decision contexts.

Show child attributes

data.decisionContexts.allocatedOrderLineIds

string[]

data.decisionContexts.methodConfigs

object

Show child attributes

data.decisionContexts.methodConfigs.{key}

object

data.decisionContexts.methodName

string

data.decisionContexts.ruleName

string

data.decisionContexts.ruleSetId

string

data.decisionContexts.ruleSetVersion

string

data.items

object[]

List of items to be shipped

The details of the allocation item.

Show child attributes

data.items.allocationLineNumber

integer

required

A unique number assigned by merchant to identify an item in an allocation. When this value is not provided, fabric auto generates it in a UUID format during the allocation creation.

Example:

3

data.items.itemId

integer

required

System-generated unique identifier of item from fabric Products (previously called PIM) service

Example:

100064

data.items.quantity

integer

required

Requested quantity of the item

Example:

3

data.items.sku

string

required

Stock Keeping Unit (SKU), unique identifier of item

Example:

"123k4h123k"

data.items.uom

string

required

Unit in which a product is sold or measured. It's important for accurately fulfilling orders and ensuring customers receive the correct quantity of products they have ordered. The possible values are EA (Each) or GAL (Gallon), DZ (Dozen), etc.

Example:

"EA"

data.items.channelId

string

Sales channel ID

Example:

"4a35cc1b-4e15-46df-96c9-38a697d88dfe"

data.items.cost

number

The total cost of all the items. This value is calculated based on the unit price and requested quantity.

Example:

150.6

data.items.estimatedDeliveryDate

string

Estimated delivery date of the item

Example:

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

data.items.itemStatus

enum<string>

Current status of item

Available options:

CANCELLED,

REFUNDED,

ALLOCATED,

REALLOCATED,

SHIPPED,

PENDING_ALLOCATION,

PARTIALLY_ALLOCATED,

PARTIALLY_SHIPPED,

PARTIALLY_CANCELLED,

PENDING_REALLOCATION

Example:

"PARTIALLY_ALLOCATED"

data.items.notes

object[]

An optional notes section. This section can be used by a customer service representative (CSR) to record notes on an allocation.

An order note added by a CSR.

Show child attributes

data.items.notes.createdAt

string

The time the note was created in UTC format.

Example:

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

data.items.notes.notes

string

Optional additional info about the order.

Example:

"Fragile - handle with care"

data.items.notes.user

string

The Customer Service Representative or Employee (ID or name) who created the note.

Example:

"62272e917b12209e68751d94"

data.items.orderId

string

24-character system-generated order ID

Example:

"62f3982438bcab1951be0a19"

data.items.orderLineId

string

Order line ID for tracking purpose

Example:

"134fqfaa532qrf"

data.items.orderLineNumber

integer

Reference order line number for tracking purpose

Example:

1

data.items.orderNumber

string

Merchant-defined order identifier. If omitted, this is generated by fabric’s sequence generator using Configuration service.

Example:

"123k4h123k"

data.items.orderedAt

string

Merchant-specified order creation time (UTC) of the item

Example:

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

data.items.parentAllocationLineNumber

integer

Unique number allocated to each item of the parent allocation (the very first allocation)

Example:

3

data.items.price

number

Unite price of the item

Example:

50.2

data.items.reallocationReasonCode

string

Reason for reallocation

Example:

"Reallocating due to unavailability of location number"

data.items.reallocationRequestId

string

Reference ID of allocationRequestId that's being reallocated

Example:

"123k4h123k"

data.items.reshipReasonCode

string

A valid predefined reason code for reshipping the item

Example:

"Stock refilled"

data.items.scratchQuantity

integer

Total number of line items scratched or canceled

Example:

1

data.items.scratchedReasonCode

string

A valid predefined reason code for scratching or canceling the item

Example:

"Out of stock"

data.items.shippedQuantity

integer

Total number of line items shipped

Example:

1

data.items.weight

number

Item weight during shipment

Example:

5.5

data.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.

Example:

"WEB_SHIP"

data.locationType

string

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

Example:

"DC"

data.notifiedToPPSAt

string

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

Example:

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

data.orderSubType

string

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

Example:

"ANDROID"

data.parentAllocationId

string

Allocation ID that's 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.

Example:

"62ff5c0bec0aed3c86202c32"

data.previousAllocatedLocationNums

string[]

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

Previously allocated location numbers

data.recipients

object[]

Recipient details like name, email address, and phone number

Order pickup details

Show child attributes

data.recipients.email

string

Contact person's email

Example:

"[e-mail]"

data.recipients.name

object

Contact person's name

Show child attributes

data.recipients.name.firstName

string

Contact person's first name

Example:

"Alex"

data.recipients.name.lastName

string

Contact person's last name

Example:

"Doe"

data.recipients.name.middleName

string

Contact person's middle name or initial

Example:

"E"

data.recipients.phone

object

Contact person's phone details

Show child attributes

data.recipients.phone.number

string

Contact person's phone number

Example:

"123-456-7890"

data.recipients.phone.type

enum<string>

Contact number type

Available options:

MOBILE,

HOME,

BUSINESS

Example:

"MOBILE"

data.recipients.pickupType

enum<string>

Order pickup type

Available options:

PRIMARY,

ALTERNATE

Example:

"PRIMARY"

data.shipToAddress

object

Address details

Show child attributes

data.shipToAddress.addressLine1

string

required

Address line 1

Example:

"123 Main St."

data.shipToAddress.city

string

required

City name

Example:

"Seattle"

data.shipToAddress.countryCode

string

required

ISO 3166-1 alpha-2 based country code

Example:

"US"

data.shipToAddress.latitude

number

required

Address latitude, used with longitude to specify the address location. Decimal degrees format; negative is degrees South. **Note:**Value must be between -90 and 90, both inclusive.

Example:

47.6205

data.shipToAddress.longitude

number

required

Address longitude, used with latitude to specify the address location. Decimal degrees format; negative is degrees South. **Note:**Value must be between -180 and 180, both inclusive.

Example:

-122.3493

data.shipToAddress.postalCode

string

required

Postal or ZIP code

Example:

"98121"

data.shipToAddress.region

string

required

Region or state

Example:

"WA"

data.shipToAddress.type

string

required

Address type

Example:

"Home"

data.shipToAddress.addressLine2

string

Address line 2

Example:

"Suite 100"

data.shipToAddress.addressLine3

string

Address line 3

Example:

"Seventh floor"

data.shipToAddress.addressLine4

string

Address line 4

Example:

"Attention: Pat E. Kake"

data.shipToAddress.email

string

Contact person's email

Example:

"[e-mail]"

data.shipToAddress.name

object

Contact person's name

Show child attributes

data.shipToAddress.name.firstName

string

Contact person's first name

Example:

"Alex"

data.shipToAddress.name.lastName

string

Contact person's last name

Example:

"Doe"

data.shipToAddress.name.middleName

string

Contact person's middle name or initial

Example:

"E"

data.shipToAddress.phone

object

Contact person's phone details

Show child attributes

data.shipToAddress.phone.number

string

Contact person's phone number

Example:

"123-456-7890"

data.shipToAddress.phone.type

enum<string>

Contact number type

Available options:

MOBILE,

HOME,

BUSINESS

Example:

"MOBILE"

data.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>

Example:

"98ff5c0bec0aed3c86202c32"

data.shipmentMethod

string

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

Example:

"Parcel Post Delivery"

data.shipmentType

string

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

Example:

"SHIP_TO_ADDRESS"

data.shippedAt

string

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

Example:

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

data.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

Example:

"ALLOCATED"

data.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

Example:

"ALLOCATED"

data.updatedAt

string

System-generated time when allocation record was last modified

Example:

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

pagination

object

Pagination response

Show child attributes

pagination.count

integer

Total number of search results

Example:

1000

pagination.limit

integer

default:

10

Maximum number of records per page

Required range: 1 <= x <= 100

Example:

10

pagination.offset

integer

default:

0

Number of records to skip before returning all records. For example, offset=20, limit=10 returns records 21-30.

Required range: x >= 0

Example:

1

stats

string[]

A list of stats.

The stats details.