POST
/
shipment
/
gift-card
/
activation-acknowledge

Authorizations

Authorization
string
headerrequired

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

Headers

x-site-context
string
required

The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.

Body

application/json

Details of gift card associated with shipment

shipmentId
string

Shipment ID

items
object[]

Response

200 - application/json

Shipment details

shipmentId
string

24-character fabric-generated unique ID of shipment

shipmentNum
string

Shipment number (external)

invoiceId
string

fabric-generated Invoice ID

allocationId
string

Allocation ID for an order, generated from allocation service

orderNumber
string[]

Order number. It's usually generated by another system, such as an external checkout system.

poNumber
string

Purchase order number (generally, vendor-generated)

vendorId
string

Vendor ID

statusCode
enum<string>

Shipment status code

Available options:
SHIPMENT_CREATED,
SHIPMENT_CANCELLED,
PICKUP_CREATED,
PICKUP_COMPLETED,
SHIPMENT_RETURN_PENDING,
SHIPMENT_RETURN_RECEIVED,
SHIPMENT_PARTIALLY_DELIVERED,
SHIPMENT_DELIVERED
type
enum<string>

shipment type

Available options:
STANDARD,
RESHIP,
RETURN,
SCRATCH,
PICKUP
reshipmentReasonCode
string

Reason code for reshipment

shipDate
string

Time of shipping

locationNum
string

location number from location service to get exact address.

locationType
string

Location type based on location service such as store, distribution center (DC)

totalCartons
integer

Total number of cartons

masterTrackingNumber
string

Main tracking number, to track fulfillment of all the orders

shipToId
string

Ship-to ID refers to item's delivery address

shipToAddress
object

Details of delivery address

recipient
object[]
cartons
object[]
scratchedItems
object[]

details of scratched items

createdAt
string

Time of shipment creation

updatedAt
string

Time of last update

auditLogs
object[]

Details of audit logs

attributes
object

Attribute details for additional information

Was this page helpful?

Activate gift cardAcknowledge Shipment