Activate gift card

Authentication v1

Identity APIs
User
Address
Auth

User Self Service APIs

Introduction
User Self Service APIs
Authentication APIs

Experiences v2 (XM v2)

XM
Pages
Global Components
Menu

Experiences v1 (XM v1)

XM
Pages
Global Components
Menu

Product Catalog

Product Catalog
Category
Product
Attributes
Bulk Import

Orders v2 (OMS v2)

Order Management System
Order
Order Attribute
Developer Guide
Order Return
Payment Status
Package Tracking
Cross Border
Order Cancellation
Appeasement
Allocation
Configuration
Fraud Configuration
Target Configuration
Location
Location Attribute
Inventory Network
Inventory
Inventory Counter
Inventory Bulk Operation
Inventory Attribute
Inventory Upload Log
Shipment
- Overview
- POST
  Create Shipment
- GET
  Get Shipment
- POST
  Create reshipment
- PUT
  Update shipment
- POST
  Update package tracking
- POST
  Filter shipments
- POST
  Activate gift card
- POST
  Acknowledge gift card activation
- POST
  Acknowledge Shipment
Shipping Method
Webhook
Notification
Export
Invoice
Fraud
Backorder Preorder Reservation
List

Orders v1 (OMS v1)

Order Management System
Cart
Bill To
Ship To
Wishlist
Cart Decoupled
Warehouse
Inventory
Attributes
List
Tax/Address Validate
Shipping
Payments
Order

Offers v2

Offers
Developer Guide
Promotion
Price Kind
Dynamic Pricing Engine
Segment
Coupon
Coupon Codes
Product
Price List
Attributes
Item
Price Guard
Global Exclusion
Upload Price CSV
Pricing
Redemption
Exports

Offers v1

Offers
Login API
Promotions
Pricing

Subscriptions (SMT API)

Subscriptions API
Cancellation Reasons
Subscription Discounts
Subscriptions
Subscribers
Orders

Loyalty (Member)

Member APIs
Inquire
Discounts
Redeem
Earn
Members

Dropship

Dropship API
Shipments
Products
Invoices
Connections
Inventory
Developer Guide
Returns
Orders

Cart API

Cart
Order Draft
Attribute
Adjustments
Shipping
Cart

Checkout API

Checkout
Checkout

Customer

Core Concepts
Customer Service
Organization
User Party
Organization Group Addresses
User Internal Party
Organization Contracts
Party
Party Contracts
Contracts
User
Search
User Trait
Organization Users
Address
User Address
Trait
Party Address
Party Trait
Organization Group Users
Internal Party
Contract Pricelist
Internal Parties Party
Account
Party Account
Organization Addresses
Organization Groups
Individual Addresses
Users Organization
Individual

POST

shipment

gift-card

activation

Authorizations

Authorization

string

header

required

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

items

object[]

shipmentId

string

Shipment ID

Response

200 - application/json

Shipment details

allocationId

string

Allocation ID for an order, generated from allocation service

attributes

object

Attribute details for additional information

auditLogs

object[]

Details of audit logs

cartons

object[]

cartons.cartonNum

string

Carton number to identify packages

cartons.cartonType

string

Cartoon type

cartons.estimatedDeliveryDate

string

Estimated delivery date

cartons.estimatedShipDate

string

Estimated shipping date

cartons.items

object[]

Item details

cartons.promisedDeliveryDate

string

Promised delivery date

cartons.shipmentCarrier

string

Shipment carrier

cartons.shipmentMethod

string

Shipment method

cartons.trackingDetails

object[]

Shipment tracking details

cartons.trackingNumber

string

Courier tracking number for the carton

cartons.trackingURL

string

Shipment tracking URL

cartons.weight

string

Shipment weight

createdAt

string

Time of shipment creation

invoiceId

string

fabric-generated Invoice ID

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)

masterTrackingNumber

string

Main tracking number, to track fulfillment of all the orders

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)

recipient

object[]

reshipmentReasonCode

string

Reason code for reshipment

scratchedItems

object[]

details of scratched items

shipDate

string

Time of shipping

shipmentId

string

24-character fabric-generated unique ID of shipment

shipmentNum

string

Shipment number (external)

shipToAddress

object

Details of delivery address

shipToId

string

Ship-to ID refers to item's delivery address

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

totalCartons

integer

Total number of cartons

type

enum<string>

shipment type

Available options:

STANDARD,

RESHIP,

RETURN,

SCRATCH,

PICKUP

updatedAt

string

Time of last update

vendorId

string

Vendor ID

Was this page helpful?

Filter shipments Acknowledge gift card activation