POST
/
shipments
/
inventory-transfer
/
{transferShipmentId}
/
action
/
cancel

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

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

Path Parameters

transferShipmentId
string
required

Response

200 - application/json

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

shipFrom
object
required

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

shipTo
object
required

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

shipmentNumber
string
required

Shipment's unique identification number

transferId
string
required

Transfer ID for this shipment

transferNumber
string
required

Transfer number for this shipment

attributes
object

Attributes to save any additional info

auditLogs
object[]

Audit logs list

cartons
object[]

Carton list

createdAt
string

Created date

deliveredAt
string

Delivered date of shipment

masterTrackingNumber
string

Master tracking number

poNumber
string

Optional purchase order number

receivedAt
string

Received date of shipment

recipient
object[]

Recipient list

shipmentId
string

Shipment's autogenerated unique id

shippedAt
string

Ship date

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
stockReleaseTimeStamp
string

Stock release time stamp date

subtype
enum<string>

Shipment subtype

Available options:
COD
totalCartons
integer

Total number of cartons

type
enum<string>

Shipment types

Available options:
STANDARD,
RESHIP,
RETURN,
SCRATCH,
PENDING_RETURN,
PICKUP,
TRANSFER
updatedAt
string

Updated date

vendorId
string

Vendor ID

Was this page helpful?

Receive inventory trackingOverview