POST
/
shipments
/
inventory-transfer

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

Body

application/json
attributes
object

Attributes to save any additional info

cartons
object[]

Carton list

masterTrackingNumber
string

Master tracking number

poNumber
string

Optional purchase order number

recipient
object[]

Recipient list

shipFrom
object
required

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

shipTo
object
required

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

shipmentNumber
string
required

Shipment's unique identification number

shippedAt
string

Ship date

subtype
enum<string>

Shipment subtype

Available options:
COD
totalCartons
integer

Total number of cartons

transferId
string

Transfer ID for this shipment

transferNumber
string
required

Transfer number for this shipment

type
enum<string>

Shipment types

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

Vendor ID

Response

200 - application/json
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

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.

shipmentId
string

Shipment's autogenerated unique id

shipmentNumber
string
required

Shipment's unique identification number

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

transferId
string
required

Transfer ID for this shipment

transferNumber
string
required

Transfer number for this shipment

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?

Update shipment trackingGet inventory transfer by transfershipmentid