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
- 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
Acknowledge shipment receipt
After successfully processing a shipment, the shipment should be acknowledged so that it does not appear in subsequent requests to /shipments/?is_acknowledged=0.
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Shipment ID
Retailer ID
Order ID
Batch number of shipment
Label reference
Name of shipping method
Code of shipping method
Type of shipping method
Carrier name
Carrier code
Name of shipping method
Description of shipping method
Type of shipping method
Nickname of shipping account
Carrier name
Carrier code
true: is first party billed shipment <br /> false Is not first party bill
Tracking number for shipment
Time of order pickup
Time of order delivery
true: Shipment has commercial invoice <br /> Shipment does not have commercial invoice
Time of cancellation (UTC format)
Type of address
Name of the primary contact?
Name of the alternative contact?
Line 1 of the address
Line 2 of the address
City name
State name
Postal code
Country name
Primary contact number
Alternate contact number
Fax number
Contact email address
Federal tax ID
Type of address
Name of the primary contact?
Name of the alternative contact?
Line 1 of the address
Line 2 of the address
City name
State name
Postal code
Country name
Primary contact number
Alternate contact number
Fax number
Contact email address
Federal tax ID
Type of address
Name of the primary contact?
Name of the alternative contact?
Line 1 of the address
Line 2 of the address
City name
State name
Postal code
Country name
Primary contact number
Alternate contact number
Fax number
Contact email address
Federal tax ID
Shipment weight
Shipment width
Shipment length
Shipment height
Identifier of the shipping provider
Message in error log
Time of acknowledgement (UTC format)
Time of shipment closure (UTC format)
Time of delivery (UTC format)
Time of shipping (UTC format)
Signature criteria
Vendor name
Vendor code, which is vendor name in lower case and underscore
URL of brand website
true: is on Dropship network <br /> false: not on Dropship network
Represents whether subscription is required
Subscription expiry Time (UTC format)
Time of grace period expiration (UTC format)
Inventory policy
Vendor status
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
Order ID
Batch number of shipment
-2147483648 < x < 2147483647Label reference
30Name of shipping method
1 - 64Code of shipping method
1 - 64Type of shipping method
small_parcel, ltl Name of shipping method
1 - 32Description of shipping method
1 - 128Type of shipping method
small_parcel, ltl Nickname of shipping account
1 - 64true: is first party billed shipment <br /> false Is not first party bill
Tracking number for shipment
128true: Shipment has commercial invoice <br /> Shipment does not have commercial invoice
Time of cancellation (UTC format)
Name of the primary contact?
1 - 64Line 1 of the address
1 - 128City name
1 - 64State name
1 - 32Postal code
1 - 32Country name
1 - 128Type of address
residential, commercial Name of the alternative contact?
64Line 2 of the address
128Primary contact number
32Alternate contact number
32Fax number
32Contact email address
128Federal tax ID
32Name of the primary contact?
1 - 64Line 1 of the address
1 - 128City name
1 - 64State name
1 - 32Postal code
1 - 32Country name
1 - 128Type of address
residential, commercial Name of the alternative contact?
64Line 2 of the address
128Primary contact number
32Alternate contact number
32Fax number
32Contact email address
128Federal tax ID
32Name of the primary contact?
1 - 64Line 1 of the address
1 - 128City name
1 - 64State name
1 - 32Postal code
1 - 32Country name
1 - 128Type of address
residential, commercial Name of the alternative contact?
64Line 2 of the address
128Primary contact number
32Alternate contact number
32Fax number
32Contact email address
128Federal tax ID
32Shipment weight
Shipment width
Shipment length
Shipment height
Identifier of the shipping provider
64Time of acknowledgement (UTC format)
Time of shipment closure (UTC format)
Time of delivery (UTC format)
Time of shipping (UTC format)
Signature criteria
required, not_required, adult Vendor code, which is vendor name in lower case and underscore
1 - 64Vendor name
1 - 64URL of brand website
100true: is on Dropship network <br /> false: not on Dropship network
Represents whether subscription is required
disabled, enabled, upcoming Subscription expiry Time (UTC format)
Time of grace period expiration (UTC format)
Inventory policy
unmanaged, managed, use_variant_policy Vendor status
active, pending, inactive Response
Order ID
Shipment ID
Batch number of shipment
-2147483648 < x < 2147483647Label reference
30Time of shipment creation (UTC format)
Customer order number
1Retailer order number
1Purchase order number
1Name of shipping method
1 - 64Code of shipping method
1 - 64ID of shipping method
Type of shipping method
small_parcel, ltl Name of shipping method
1 - 32Description of shipping method
1 - 128ID of shipping method
Type of shipping method
small_parcel, ltl Nickname of shipping account
1 - 64Shipping account ID
Owner of shipping account
true: is first party billed shipment <br /> false Is not first party bill
Tracking number for shipment
128URL for tracking shipment
Time of order pickup
Time of order delivery
Tracking ID
Time of tracking (UTC format)
Tracking status
1 - 32Status details
1 - 64Country of delivery
8State of delivery
8City of delivery
32Postal code for delivery
16Status of shipment
1true: Shipment is acknowledged <br /> false: Shipment is not acknowledged
true: Shipment has commercial invoice <br /> Shipment does not have commercial invoice
Time of cancellation (UTC format)
Name of the primary contact?
1 - 64Line 1 of the address
1 - 128City name
1 - 64State name
1 - 32Postal code
1 - 32Country name
1 - 128Address ID
Type of address
residential, commercial Name of the alternative contact?
64Line 2 of the address
128Primary contact number
32Alternate contact number
32Fax number
32Contact email address
128Federal tax ID
32Name of the primary contact?
1 - 64Line 1 of the address
1 - 128City name
1 - 64State name
1 - 32Postal code
1 - 32Country name
1 - 128Address ID
Type of address
residential, commercial Name of the alternative contact?
64Line 2 of the address
128Primary contact number
32Alternate contact number
32Fax number
32Contact email address
128Federal tax ID
32Name of the primary contact?
1 - 64Line 1 of the address
1 - 128City name
1 - 64State name
1 - 32Postal code
1 - 32Country name
1 - 128Address ID
Type of address
residential, commercial Name of the alternative contact?
64Line 2 of the address
128Primary contact number
32Alternate contact number
32Fax number
32Contact email address
128Federal tax ID
32Shipment weight
Shipment width
Shipment length
Shipment height
Shipment girth
Shipment volume
true: Shipment has valid packing slip <br /> false: Shipment does not valid packing slip
true: Shipment has valid shipping label <br /> false: Shipment does not valid valid shipping label
Identifier of the shipping provider
64Time of acknowledgement (UTC format)
Time of shipment closure (UTC format)
Time of delivery (UTC format)
Time of shipping (UTC format)
Time of shipment update (UTC format)
Time of shipment creation (UTC format)
Shipment line ID
Order line number
Order quantity
-2147483648 < x < 2147483647Internal only
-2147483648 < x < 2147483647Freight class
50, 55, 60, 65, 70, 77.5, 85, 92.5, 100, 110, 125, 150, 175, 200, 250, 300, 400, 500 Time of last update
Variant ID
Variant name
200Stock Keeping Unit (SKU), unique identifier of a product
128Brand identifier
1Universal product code (UPC) is a 12-digit combination of numbers assigned to each product in your drop-shipping store
64Retailer ID
Retailer name
1 - 64Retailer code, which is retailer name in lower case and hyphenated
1 - 32Retailer ID
URL of retailer logo
1URL of retailer cover image
1URL of retailer profile image
1Time of retailer joining Dropship (UTC format)
true: Retailer is in Dropship network; Retailer is not in Dropship network
true: Retailer is onboarded <br /> false: Retailer is not onboarded
Platform on which retailer is onboarded
fabric Represent whether retailer requires subscription to use the platform
disabled, enabled, upcoming true: Platform allows creation of brand permit <br /> false: Platform doesn't require creation of brand permit
Website URL
100Retailer status
active, setup, ghost Stock Keeping Unit (SKU), unique identifier of a product
256Retailer name
256Signature criteria
required, not_required, adult Vendor code, which is vendor name in lower case and underscore
1 - 64Vendor (brand) ID
Vendor name
1 - 64Time when vendor joined Dropship (UTC format)
URL of the brand logo
1URL of the cover image
1URL of the profile image
1URL of brand website
100true: Vendor is onboarded <br /> false: Vendor is not onboarded
true: is on Dropship network <br /> false: not on Dropship network
Represents whether subscription is required
disabled, enabled, upcoming Subscription expiry Time (UTC format)
Time of grace period expiration (UTC format)
true: subscription is expired <br /> false: subscription is active
true: subscription is on grace period <br /> false: subscription is not on grace period
true: subscription is overdue <br /> false: subscription is paid
Inventory policy
unmanaged, managed, use_variant_policy Vendor status
active, pending, inactive Invoice number
Was this page helpful?