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
Get single order details
Gets the details of a single order by specifying retailer ID and order ID.
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Response
Purchase order number
1
Time of order finalization (UTC format)
Order ID
Customer order number
64
Retailer order number
1
Vendor identifier
64
Retailer name
1 - 64
Retailer code, which is retailer name in lower case and hyphenated
1 - 32
Retailer ID
URL of retailer logo
1
URL of retailer cover image
1
URL of retailer profile image
1
Time 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
100
Retailer status
active
, setup
, ghost
Vendor code, which is vendor name in lower case and underscore
1 - 64
Vendor (brand) ID
Vendor name
1 - 64
Time when vendor joined Dropship (UTC format)
URL of the brand logo
1
URL of the cover image
1
URL of the profile image
1
URL of brand website
100
true: 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
Vendor code, which is vendor name in lower case and underscore
1 - 64
Vendor (brand) ID
Vendor name
1 - 64
Time when vendor joined Dropship (UTC format)
URL of the brand logo
1
URL of the cover image
1
URL of the profile image
1
URL of brand website
100
true: 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
A numeric connection ID
Name of shipping method
1 - 64
Code of shipping method
1 - 64
ID of shipping method
Type of shipping method
small_parcel
, ltl
Name of shipping method
1 - 32
Description of shipping method
1 - 128
ID of shipping method
Type of shipping method
small_parcel
, ltl
ID of the requested shipping method
Name of shipping method
1 - 32
Description of shipping method
1 - 128
ID of shipping method
Type of shipping method
small_parcel
, ltl
Shipment count
Invoice count
Name of the primary contact?
1 - 64
Line 1 of the address
1 - 128
City name
1 - 64
State name
1 - 32
Postal code
1 - 32
Country name
1 - 128
Address ID
Type of address
residential
, commercial
Name of the alternative contact?
64
Line 2 of the address
128
Primary contact number
32
Alternate contact number
32
Fax number
32
Contact email address
128
Federal tax ID
32
Name of the primary contact?
1 - 64
Line 1 of the address
1 - 128
City name
1 - 64
State name
1 - 32
Postal code
1 - 32
Country name
1 - 128
Address ID
Type of address
residential
, commercial
Name of the alternative contact?
64
Line 2 of the address
128
Primary contact number
32
Alternate contact number
32
Fax number
32
Contact email address
128
Federal tax ID
32
Name of the primary contact?
1 - 64
Line 1 of the address
1 - 128
City name
1 - 64
State name
1 - 32
Postal code
1 - 32
Country name
1 - 128
Address ID
Type of address
residential
, commercial
Name of the alternative contact?
64
Line 2 of the address
128
Primary contact number
32
Alternate contact number
32
Fax number
32
Contact email address
128
Federal tax ID
32
Name of the primary contact?
1 - 64
Line 1 of the address
1 - 128
City name
1 - 64
State name
1 - 32
Postal code
1 - 32
Country name
1 - 128
Address ID
Type of address
residential
, commercial
Name of the alternative contact?
64
Line 2 of the address
128
Primary contact number
32
Alternate contact number
32
Fax number
32
Contact email address
128
Federal tax ID
32
Name of the primary contact?
1 - 64
Line 1 of the address
1 - 128
City name
1 - 64
State name
1 - 32
Postal code
1 - 32
Country name
1 - 128
Address ID
Type of address
residential
, commercial
Name of the alternative contact?
64
Line 2 of the address
128
Primary contact number
32
Alternate contact number
32
Fax number
32
Contact email address
128
Federal tax ID
32
true: Automatically generates shipping labels based on the carrier <br /> false: Does not support generation of shipping labels
Subtotal amount excluding shipping
Shipped charged
true: Order is a gift <br /> false: Order is not a gift
Gift fee (if applicable)
true: order is a replacement <br /> false: order is not a replacement
Order status
1
true: Order is acknowledged <br /> false: Order is not acknowledged
Time of order acknowledgement (UTC format)
Time when order will be completely fulfilled (UTC format)
Time of order fulfillment (UTC format)
Time of complete order fulfillment (UTC format)
Time of when order was received (UTC format)
true: Order is on hold <br /> false: Order is not on hold
Time of when order was picked up (UTC format)
Time of when order got placed on hold (UTC format)
Date till when the order will be on hold
Time till when product or order is backordered (UTC format)
Time of backorder acknowledgement (UTC format)
Time of order cancellation (UTC format)
Time of order update (UTC format)
Total products in the order
Time of order finalization (UTC format)
Order line ID
Order line number (auto-incremental number)
Quantity to be shipped
Quantity shipped
Quantity returned
Quantity cancelled
Quantity invoiced
Number of packages per quantity
Discounted price
Net price
Subtotal amount
Estimated price
Shipping cost
Gift fee
Subtotal charged
Tax charged
Total charge
Order status
1
Time all products in the order are expected to be completely fulfilled. Automatically determined based on a combination of item lead time and the connection's SLA.
Time of cancellation (UTC format)
Time till when product is backordered (UTC format)
Details of product variant
Metadata ID
Metadata name
1
Metadata value, depending on the type
Metadata type such as integer, float, etc.
1
Time of metadata creation (UTC format)
Reason ID associated with cancellation
Cancellation ID
Time of cancellation (UTC format)
User that initiated cancellation
retailer
, brand
Order ID
Purchase order number
1
Cancellation reason
1
Time of cancellation acknowledgement (UTC format)
Order ID
Shipment ID
Batch number of shipment
-2147483648 < x < 2147483647
Label reference
30
Time of shipment creation (UTC format)
Customer order number
1
Retailer order number
1
Purchase order number
1
Name of shipping method
1 - 64
Code of shipping method
1 - 64
ID of shipping method
Type of shipping method
small_parcel
, ltl
Name of shipping method
1 - 32
Description of shipping method
1 - 128
ID of shipping method
Type of shipping method
small_parcel
, ltl
Nickname of shipping account
1 - 64
Shipping account ID
Owner of shipping account
true: is first party billed shipment <br /> false Is not first party bill
Tracking number for shipment
128
URL for tracking shipment
Time of order pickup
Time of order delivery
Time of tracking (UTC format)
Tracking status
1 - 32
Status details
1 - 64
Tracking ID
Country of delivery
8
State of delivery
8
City of delivery
32
Postal code for delivery
16
Status of shipment
1
true: 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 - 64
Line 1 of the address
1 - 128
City name
1 - 64
State name
1 - 32
Postal code
1 - 32
Country name
1 - 128
Address ID
Type of address
residential
, commercial
Name of the alternative contact?
64
Line 2 of the address
128
Primary contact number
32
Alternate contact number
32
Fax number
32
Contact email address
128
Federal tax ID
32
Name of the primary contact?
1 - 64
Line 1 of the address
1 - 128
City name
1 - 64
State name
1 - 32
Postal code
1 - 32
Country name
1 - 128
Address ID
Type of address
residential
, commercial
Name of the alternative contact?
64
Line 2 of the address
128
Primary contact number
32
Alternate contact number
32
Fax number
32
Contact email address
128
Federal tax ID
32
Name of the primary contact?
1 - 64
Line 1 of the address
1 - 128
City name
1 - 64
State name
1 - 32
Postal code
1 - 32
Country name
1 - 128
Address ID
Type of address
residential
, commercial
Name of the alternative contact?
64
Line 2 of the address
128
Primary contact number
32
Alternate contact number
32
Fax number
32
Contact email address
128
Federal tax ID
32
Shipment 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
64
Time 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 < 2147483647
Internal only
-2147483648 < x < 2147483647
Freight 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
200
Stock Keeping Unit (SKU), unique identifier of a product
128
Brand identifier
1
Universal product code (UPC) is a 12-digit combination of numbers assigned to each product in your drop-shipping store
64
Retailer ID
Stock Keeping Unit (SKU), unique identifier of a product
256
Retailer name
256
Signature criteria
required
, not_required
, adult
Vendor code, which is vendor name in lower case and underscore
1 - 64
Vendor (brand) ID
Vendor name
1 - 64
Time when vendor joined Dropship (UTC format)
URL of the brand logo
1
URL of the cover image
1
URL of the profile image
1
URL of brand website
100
true: 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
Attachment or document ID
Content type
Attachement object ID
File name
User ID that uploaded the attachment
User permission who can view the attachment
me
, connections
, everyone
Original file name
255
File name used for sharing
255
URL of attachment
1
Memo ID
Memo text
Memo visibility
any
, retailer
, brand
Time memo acknowledgement (UTC format)
true: notify stakeholders <br /> false: do not notify
User ID who accepted or rejected the invoice
First name of user
64
Last name of user
64
User title
64
User status
active
, invited
, locked
User type
standard
, api
URL of the user photo
1
URL of the user's profile photo
1
true: user is me: <br /> false: user is not me
Represents whether memo is created by retailer or brand?
retailer
, brand
Time of memo creation (UTC format)
Time of memo update (UTC format)
Total memos
Number of unread memos
Object tag ID
Object tag
User ID who accepted or rejected the invoice
First name of user
64
Last name of user
64
User title
64
User status
active
, invited
, locked
User type
standard
, api
URL of the user photo
1
<