Inventory transfer search

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

fetchOnlyIds

boolean

default:

false

Body

application/json

An object containing the sort and filter criteria for a transfer shipment search.

filters

object[]

required

• Option 1
• Option 2

The criteria used to find shipments 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:

"LT"

filters.field

string

required

Field name

Example:

"shipment.shipmentNum"

filters.group

string

default:

Default

Group name

Example:

"GroupA"

filters.value

Search criteria using a single value

Example:

"ORDER_CREATE"

sort

string

default:

-transferShipment.shipDate

Property name on which response needed to be sorted. <p> Note: - refers to descending and + refers to ascending order

Example:

"-transferShipment.shipDate"

Response

200

application/json

OK

The search response.

data

object[]

An object containing information and properties of the transfer shipment response.

Show child attributes

data.shipFrom

object

required

An object containing information and properties for the transfers ship from location.

Show child attributes

data.shipFrom.locationNumber

string

required

Location number

Example:

"132412"

data.shipFrom.locationName

string

Location name

Example:

"Store1"

data.shipFrom.locationType

string

Location type

Example:

"STORE"

data.shipFrom.shipFromAddress

object

Order address model

Show child attributes

data.shipFrom.shipFromAddress.address1

string

required

The first address line.

Example:

"House No 129"

data.shipFrom.shipFromAddress.address2

string

The second address line.

Example:

"10 Downing Street"

data.shipFrom.shipFromAddress.address3

string

The third address line.

Example:

"Bakers Colony"

data.shipFrom.shipFromAddress.address4

string

The fourth address line.

Example:

"Near ABC School"

data.shipFrom.shipFromAddress.city

string

City

Example:

"Beaumont"

data.shipFrom.shipFromAddress.country

string

Country

Example:

"USA"

data.shipFrom.shipFromAddress.email

string

A valid email address.

Example:

"[e-mail]"

data.shipFrom.shipFromAddress.latitude

number

Latitude

Example:

35.294952

data.shipFrom.shipFromAddress.longitude

number

Longitude

Example:

32.294952

data.shipFrom.shipFromAddress.name

object

Order contact name model

Show child attributes

data.shipFrom.shipFromAddress.name.first

string

First name

Example:

"John"

data.shipFrom.shipFromAddress.name.last

string

Last name

Example:

"Doe"

data.shipFrom.shipFromAddress.name.middle

string

Middle name

Example:

"M"

data.shipFrom.shipFromAddress.phone

object

The contact phone number provided by the order.

Show child attributes

data.shipFrom.shipFromAddress.phone.number

string

Phone number

Example:

"[phone]"

data.shipFrom.shipFromAddress.phone.type

enum<string>

The phone number type. For example, MOBILE, HOME, or BUSINESS.

Available options:

MOBILE,

HOME,

BUSINESS

Example:

"MOBILE"

data.shipFrom.shipFromAddress.postalCode

string

Postal code

Example:

"77705"

data.shipFrom.shipFromAddress.state

string

State

Example:

"TX"

data.shipFrom.shipFromAddress.type

string

The type of address provided. For example, home or residence.

Example:

"residence"

data.shipTo

object

required

An object containing information and properties for the transfers ship to location.

Show child attributes

data.shipTo.locationNumber

string

required

Location number

Example:

"132412"

data.shipTo.locationName

string

Location name

Example:

"Store1"

data.shipTo.locationType

string

Location type

Example:

"STORE"

data.shipTo.shipToAddress

object

ShipmentShipToAddress Model

Show child attributes

data.shipTo.shipToAddress.addressLine1

string

Address line 1

Example:

"254 House number"

data.shipTo.shipToAddress.addressLine2

string

Address line 2

Example:

"888 Broadway"

data.shipTo.shipToAddress.addressLine3

string

Address line 3

Example:

"17th street"

data.shipTo.shipToAddress.addressLine4

string

Address line 4

Example:

"Pearl"

data.shipTo.shipToAddress.city

string

City

Example:

"New York"

data.shipTo.shipToAddress.country

string

Country

Example:

"USA"

data.shipTo.shipToAddress.latitude

number

Latitude

Example:

134.13413

data.shipTo.shipToAddress.longitude

number

Longitude

Example:

757.0435

data.shipTo.shipToAddress.postalCode

string

Postal code

Example:

"1003"

data.shipTo.shipToAddress.state

string

State

Example:

"NY"

data.shipTo.shipToAddress.type

string

The type of address that was provided.

Example:

"home"

data.shipTo.shipToId

string

Used to link item with it's shipping address in shipment

Example:

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

data.shipmentNumber

string

required

Shipment's unique identification number

Example:

"78974156816152"

data.transferId

string

required

Transfer ID for this shipment

Example:

"112345678912340"

data.transferNumber

string

required

Transfer number for this shipment

Example:

"112345678912340"

data.attributes

object

Attributes to save any additional info

Show child attributes

data.attributes.{key}

object

Attributes to save any additional info

Example:

{ "attribute1": "value" }

Example:

{ "attribute1": "value" }

data.auditLogs

object[]

Audit logs list

Details for updating shipment

Show child attributes

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

string

Additional info, if any

Example:

"Note"

data.auditLogs.reasonCode

string

Merchant-defined reason code, varies from merchant to merchant

Example:

"Scratched item"

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

object[]

Carton list

An object containing information and properties of the transfer shipment carton.

Show child attributes

data.cartons.attributes

object

Attributes to save any additional info

Show child attributes

data.cartons.attributes.{key}

object

Attributes to save any additional info

Example:

{ "attribute1": "value" }

Example:

{ "attribute1": "value" }

data.cartons.cartonNumber

string

Carton number

Example:

"1"

data.cartons.cartonType

string

Carton type

Example:

"Package"

data.cartons.estimatedDeliveryDate

string

Estimated delivery date

Example:

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

data.cartons.estimatedShipmentDate

string

Estimated ship date

Example:

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

data.cartons.items

object[]

List of item to be shipped

An object containing information and properties of the transfer shipment item.

Show child attributes

data.cartons.items.adjustments

object[]

Adjustment

An object containing all the transfer item adjustment properties.

Show child attributes

data.cartons.items.adjustments.adjustmentQuantity

integer

default:

0

The total adjustment quantity. The default value is 0.

Example:

2

data.cartons.items.adjustments.attributes

object

Attributes to save any additional info

Show child attributes

Example:

{ "attribute1": "value" }

data.cartons.items.adjustments.reasonCode

string

The primary reason code for the item adjustment.

Example:

"DAMAGED"

data.cartons.items.adjustments.subReasonCode

string

The sub reason code for the item adjustment.

Example:

"DAMAGED"

data.cartons.items.attributes

object

Customized attributes

Show child attributes

data.cartons.items.attributes.{key}

object

Customized attributes

Example:

{ "attribute1": "value" }

Example:

{ "attribute1": "value" }

data.cartons.items.channelId

string

Channel id

Example:

"12"

data.cartons.items.deliveredQuantity

integer

default:

0

Delivered quantity

Example:

2

data.cartons.items.itemId

string

Item id

Example:

"100023"

data.cartons.items.lineItemId

string

Line item ID

Example:

"1"

data.cartons.items.packedQuantity

integer

default:

0

Packed quantity

Example:

2

data.cartons.items.quantityType

enum<string>

Transfer quantity type

Available options:

INCREMENT,

DECREMENT,

ABSOLUTE

data.cartons.items.receivedQuantity

integer

default:

0

Received quantity

Example:

2

data.cartons.items.segment

string

Segment

data.cartons.items.shipmentLineItemId

string

System generated shipment line item ID

Example:

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

data.cartons.items.shippedQuantity

integer

default:

0

Shipped quantity

Example:

2

data.cartons.items.sku

string

Sku

Example:

"SKU0023"

data.cartons.items.stockedQuantity

integer

default:

0

Stocked quantity

Example:

2

data.cartons.items.uom

string

Unit of measurement

Example:

"EA"

data.cartons.items.vendorId

string

Vendor ID

Example:

"vend12346667"

data.cartons.promisedDeliveryDate

string

Promised delivery date

Example:

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

data.cartons.shipmentCarrier

string

Shipment carrier

Example:

"FEDEX"

data.cartons.shipmentMethod

string

Shipment method

Example:

"ground"

data.cartons.tracking

object[]

Tracking detail list

Shipment tracking details

Show child attributes

data.cartons.tracking.event

string

Shipment-specific event. Mandatory in the request body of Update shipment tracking - POST /shipments/actions/update-tracking endpoint

Example:

"picked up"

data.cartons.tracking.eventId

string

Event ID provided by carrier

Example:

"627963716b19511e8a3a631b"

data.cartons.tracking.eventRecordedAt

string

Time event was recorded (UTC)

Example:

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

data.cartons.tracking.location

string

Delivery location

Example:

"Reno, NV"

data.cartons.tracking.notes

object

Attributes to save any additional info

Show child attributes

data.cartons.tracking.notes.{key}

string

Attributes to save any additional info

Example:

"{\"description\":\"Shipment picked up\"}"

Example:

{ "description": "Shipment picked up" }

data.cartons.tracking.shipmentCarrier

string

Shipment carrier

Example:

"FEDEX"

data.cartons.trackingNumber

string

Tracking number

Example:

"1Z999AA10123456784"

data.cartons.trackingURL

string

Tracking URL

Example:

"https://example.com/tracking"

data.cartons.weight

string

Weight

Example:

"500 gram"

data.createdAt

string

Created date

Example:

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

data.deliveredAt

string

Delivered date of shipment

Example:

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

data.masterTrackingNumber

string

Master tracking number

Example:

"TX112345678"

data.poNumber

string

Optional purchase order number

Example:

"1125"

data.receivedAt

string

Received date of shipment

Example:

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

data.recipient

object[]

Recipient list

Shipment recipient details

Show child attributes

data.recipient.email

string

Recipient's email

Example:

"[e-mail]"

data.recipient.name

object

Contact person's name

Show child attributes

data.recipient.name.firstName

string

Contact person's first name

Example:

"Alex"

data.recipient.name.lastName

string

Contact person's last name

Example:

"Doe"

data.recipient.name.middleName

string

Contact person's middle name or initial

Example:

"E"

data.recipient.phone

object

Contact person's phone details

Show child attributes

data.recipient.phone.number

string

Contact person's phone number

Example:

"123-456-7890"

data.recipient.phone.type

enum<string>

Contact number type

Available options:

MOBILE,

HOME,

BUSINESS

Example:

"MOBILE"

data.shipmentId

string

Shipment's autogenerated unique id

Example:

"627963716b19511e8a3a631b"

data.shippedAt

string

Ship date

Example:

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

data.statusCode

enum<string>

Transfer Shipment Status

Available options:

TRANSFER_SHIPMENT_PACKED,

TRANSFER_SHIPMENT_SENT,

TRANSFER_SHIPMENT_CREATED,

TRANSFER_SHIPMENT_DRAFT,

TRANSFER_SHIPMENT_DELIVERED,

TRANSFER_SHIPMENT_RECEIVED,

TRANSFER_SHIPMENT_STOCKED,

TRANSFER_SHIPMENT_CANCELLED,

TRANSFER_SHIPMENT_ERROR

Example:

"TRANSFER_SHIPMENT_CREATED"

data.stockReleaseTimeStamp

string

Stock release time stamp date

Example:

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

data.subtype

enum<string>

Shipment subtype

Available options:

COD

Example:

"COD"

data.totalCartons

integer

Total number of cartons

Example:

2

data.type

enum<string>

Shipment types

Available options:

STANDARD,

RESHIP,

RETURN,

SCRATCH,

PENDING_RETURN,

PICKUP,

TRANSFER

Example:

"TRANSFER"

data.updatedAt

string

Updated date

Example:

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

data.vendorId

string

Vendor ID

Example:

"56"

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

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