Get details of a single shipment.

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

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

GET

retailers

{retailer_pk}

shipments

{id}

Authorizations

Authorization

string

headerrequired

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

Path Parameters

integer

required

Shipment ID

retailer_pk

number

required

Retailer ID

Response

200 - application/json

order_id

integer

required

Order ID

integer

Shipment ID

batch_number

integer | null

Batch number of shipment

Required range: -2147483648 < x < 2147483647

label_reference

string | null

Label reference

Maximum length: 30

ordered_at

string

Time of shipment creation (UTC format)

customer_order_number

string

Customer order number

Minimum length: 1

retailer_order_number

string

Retailer order number

Minimum length: 1

purchase_order_number

string

Purchase order number

Minimum length: 1

shipping_method

object

shipping_account

object

tracking_number

string | null

Tracking number for shipment

Maximum length: 128

tracking_url

string

URL for tracking shipment

tracking

object

status

string

Status of shipment

Minimum length: 1

is_acknowledged

boolean

true: Shipment is acknowledged <br /> false: Shipment is not acknowledged

has_commercial_invoice

boolean

true: Shipment has commercial invoice <br /> Shipment does not have commercial invoice

canceled_at

string | null

Time of cancellation (UTC format)

sold_to

object

ship_to

object

ship_from

object

ship_weight

number | null

Shipment weight

ship_width

number | null

Shipment width

ship_length

number | null

Shipment length

ship_height

number | null

Shipment height

ship_girth

string

Shipment girth

ship_volume

string

Shipment volume

valid_packing_slip

boolean

true: Shipment has valid packing slip <br /> false: Shipment does not valid packing slip

valid_shipping_label

boolean

true: Shipment has valid shipping label <br /> false: Shipment does not valid valid shipping label

shipping_provider_identifier

string | null

Identifier of the shipping provider

Maximum length: 64

error_logs

object

acknowledged_at

string | null

Time of acknowledgement (UTC format)

closed_at

string | null

Time of shipment closure (UTC format)

delivered_at

string | null

Time of delivery (UTC format)

shipped_at

string | null

Time of shipping (UTC format)

updated_at

string

Time of shipment update (UTC format)

created_at

string

Time of shipment creation (UTC format)

shipment_lines

object[]

shipment_lines.id

integer

Shipment line ID

shipment_lines.order_line_number

string

Order line number

shipment_lines.quantity

integer

Order quantity

Required range: -2147483648 < x < 2147483647

shipment_lines.part

integer

Internal only

Required range: -2147483648 < x < 2147483647

shipment_lines.freight_class

enum<string> | null

Freight class

Available options:

50,

55,

60,

65,

70,

77.5,

85,

92.5,

100,

110,

125,

150,

175,

200,

250,

300,

400,

500

shipment_lines.updated_at

string

Time of last update

shipment_lines.variant

object

shipment_lines.variant.id

integer

Variant ID

shipment_lines.variant.name

string | null

Variant name

Maximum length: 200

shipment_lines.variant.brand

object

shipment_lines.variant.identifier

string | null

Stock Keeping Unit (SKU), unique identifier of a product

Maximum length: 128

shipment_lines.variant.brand_identifier

string

Brand identifier

Minimum length: 1

shipment_lines.variant.upc

string

Universal product code (UPC) is a 12-digit combination of numbers assigned to each product in your drop-shipping store

Maximum length: 64

shipment_lines.variant.retailer_identifiers

object[]

shipment_lines.variant.retailer_identifiers.id

integer

Retailer ID

shipment_lines.variant.retailer_identifiers.retailer

object

shipment_lines.variant.retailer_identifiers.identifier

string | null

Stock Keeping Unit (SKU), unique identifier of a product

Maximum length: 256

shipment_lines.variant.retailer_identifiers.name

string | null

Retailer name

Maximum length: 256

signature

enum<string> | null

Signature criteria

Available options:

required,

not_required,

adult

brand

object

invoice_number

string

Invoice number

Was this page helpful?

Dropship API List fulfillments or shipments from vendors