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
Create a new order (for a single vendor)
Accepts orders from retailers for a single vendor. When an order is created by a retailer, the order is immediately distributed to the vendor however the vendor is connected to fabric (example: EDI, API, or portal)
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Body
Time of order finalization (UTC format)
Purchase order number
1
Time of order acknowledgement (UTC format)
true: Automatically generates shipping labels based on the carrier <br /> false: Does not support generation of shipping labels
Time of backorder acknowledgement (UTC format)
Time till when product or order is backordered (UTC format)
City name
1 - 64
Country name
1 - 128
Name of the primary contact?
1 - 64
Postal code
1 - 32
State name
1 - 32
Line 1 of the address
1 - 128
Contact email address
128
Fax number
32
Federal tax ID
32
Name of the alternative contact?
64
Primary contact number
32
Alternate contact number
32
Line 2 of the address
128
Type of address
residential
, commercial
Vendor code, which is vendor name in lower case and underscore
1 - 64
Time of grace period expiration (UTC format)
Inventory policy
unmanaged
, managed
, use_variant_policy
true: is on Dropship network <br /> false: not on Dropship network
Vendor name
1 - 64
Represents whether subscription is required
disabled
, enabled
, upcoming
Vendor status
active
, pending
, inactive
Subscription expiry Time (UTC format)
URL of brand website
100
Vendor identifier
64
Time of order cancellation (UTC format)
A numeric connection ID
Vendor code, which is vendor name in lower case and underscore
1 - 64
Time of grace period expiration (UTC format)
Inventory policy
unmanaged
, managed
, use_variant_policy
true: is on Dropship network <br /> false: not on Dropship network
Vendor name
1 - 64
Represents whether subscription is required
disabled
, enabled
, upcoming
Vendor status
active
, pending
, inactive
Subscription expiry Time (UTC format)
URL of brand website
100
Integration type
console
, edi
, api
, storefront
, console-print-labels
, console-register-tracking-numbers
, shopify
, bigcommerce
, shipstation
Connection type
basic
, full
Option code
1 - 64
Option name
1 - 64
Connection description
User who can edit connection
retailer
, brand
, staff
User who can view the connection details
retailer
, brand
, all
, none
Retailer code, which is retailer name in lower case and hyphenated
1 - 32
Retailer name
1 - 64
true: Platform allows creation of brand permit <br /> false: Platform doesn't require creation of brand permit
true: Retailer is onboarded <br /> false: Retailer is not onboarded
true: Retailer is in Dropship network; Retailer is not in Dropship network
Platform on which retailer is onboarded
fabric
Represent whether retailer requires subscription to use the platform
disabled
, enabled
, upcoming
Retailer status
active
, setup
, ghost
Website URL
100
Variant identifier specific to retailer
32
Connection status
active
, suspended
, pending
, onboarding
Code of shipping method
1 - 64
Name of shipping method
1 - 64
Description of shipping method
1 - 128
Name of shipping method
1 - 32
Type of shipping method
small_parcel
, ltl
Type of shipping method
small_parcel
, ltl
Code of shipping method
1 - 64
Name of shipping method
1 - 64
Description of shipping method
1 - 128
Name of shipping method
1 - 32
Type of shipping method
small_parcel
, ltl
Type of shipping method
small_parcel
, ltl
Customer order number
64
Fill time
Time of order fulfillment (UTC format)
Gift fee (if applicable)
true: Order is a gift <br /> false: Order is not a gift
true: Priority order <br /> false: Not a priority order
true: order is a replacement <br /> false: order is not a replacement
Time of when order got placed on hold (UTC format)
Date till when the order will be on hold
Time of when order was picked up (UTC format)
First name of user
64
Last name of user
64
User status
active
, invited
, locked
User title
64
User type
standard
, api
Description of shipping method
1 - 128
Name of shipping method
1 - 32
Type of shipping method
small_parcel
, ltl
ID of the requested shipping method
Retailer code, which is retailer name in lower case and hyphenated
1 - 32
Retailer name
1 - 64
true: Platform allows creation of brand permit <br /> false: Platform doesn't require creation of brand permit
true: Retailer is onboarded <br /> false: Retailer is not onboarded
true: Retailer is in Dropship network; Retailer is not in Dropship network
Platform on which retailer is onboarded
fabric
Represent whether retailer requires subscription to use the platform
disabled
, enabled
, upcoming
Retailer status
active
, setup
, ghost
Website URL
100
Retailer order number
1
City name
1 - 64
Country name
1 - 128
Name of the primary contact?
1 - 64
Postal code
1 - 32
State name
1 - 32
Line 1 of the address
1 - 128
Contact email address
128
Fax number
32
Federal tax ID
32
Name of the alternative contact?
64
Primary contact number
32
Alternate contact number
32
Line 2 of the address
128
Type of address
residential
, commercial
City name
1 - 64
Country name
1 - 128
Name of the primary contact?
1 - 64
Postal code
1 - 32
State name
1 - 32
Line 1 of the address
1 - 128
Contact email address
128
Fax number
32
Federal tax ID
32
Name of the alternative contact?
64
Primary contact number
32
Alternate contact number
32
Line 2 of the address
128
Type of address
residential
, commercial
City name
1 - 64
Country name
1 - 128
Name of the primary contact?
1 - 64
Postal code
1 - 32
State name
1 - 32
Line 1 of the address
1 - 128
Contact email address
128
Fax number
32
Federal tax ID
32
Name of the alternative contact?
64
Primary contact number
32
Alternate contact number
32
Line 2 of the address
128
Type of address
residential
, commercial
Shipped charged
Code of shipping method
1 - 64
Name of shipping method
1 - 64
Description of shipping method
1 - 128
Name of shipping method
1 - 32
Type of shipping method
small_parcel
, ltl
Type of shipping method
small_parcel
, ltl
Represents whether signature is required
required
, not_required
, adult
City name
1 - 64
Country name
1 - 128
Name of the primary contact?
1 - 64
Postal code
1 - 32
State name
1 - 32
Line 1 of the address
1 - 128
Contact email address
128
Fax number
32
Federal tax ID
32
Name of the alternative contact?
64
Primary contact number
32
Alternate contact number
32
Line 2 of the address
128
Type of address
residential
, commercial
Response
Time of order finalization (UTC format)
Purchase order number
1
Time of order acknowledgement (UTC format)
true: Automatically generates shipping labels based on the carrier <br /> false: Does not support generation of shipping labels
Content type
File name
File name used for sharing
255
Attachment or document ID
Attachement object ID
Original file name
255
User ID that uploaded the attachment
URL of attachment
1
User permission who can view the attachment
me
, connections
, everyone
Time of backorder acknowledgement (UTC format)
Time till when product or order is backordered (UTC format)
City name
1 - 64
Country name
1 - 128
Name of the primary contact?
1 - 64
Postal code
1 - 32
State name
1 - 32
Line 1 of the address
1 - 128
Contact email address
128
Fax number
32
Federal tax ID
32
Address ID
Name of the alternative contact?
64
Primary contact number
32
Alternate contact number
32
Line 2 of the address
128
Type of address
residential
, commercial
Vendor code, which is vendor name in lower case and underscore
1 - 64
URL of the cover image
1
Time of grace period expiration (UTC format)
Vendor (brand) ID
Inventory policy
unmanaged
, managed
, use_variant_policy
true: is on Dropship network <br /> false: not on Dropship network
true: Vendor is onboarded <br /> false: Vendor is not onboarded
Time when vendor joined Dropship (UTC format)
URL of the brand logo
1
Vendor name
1 - 64
URL of the profile image
1
Represents whether subscription is required
disabled
, enabled
, upcoming
Vendor status
active
, pending
, inactive
Subscription expiry Time (UTC format)
true: subscription is overdue <br /> false: subscription is paid
true: subscription is expired <br /> false: subscription is active
true: subscription is on grace period <br /> false: subscription is not on grace period
URL of brand website
100
Vendor identifier
64
Vendor code, which is vendor name in lower case and underscore
1 - 64
URL of the cover image
1
Time of grace period expiration (UTC format)
Vendor (brand) ID
Inventory policy
unmanaged
, managed
, use_variant_policy
true: is on Dropship network <br /> false: not on Dropship network
true: Vendor is onboarded <br /> false: Vendor is not onboarded
Time when vendor joined Dropship (UTC format)
URL of the brand logo
1
Vendor name
1 - 64
URL of the profile image
1
Represents whether subscription is required
disabled
, enabled
, upcoming
Vendor status
active
, pending
, inactive
Subscription expiry Time (UTC format)
true: subscription is overdue <br /> false: subscription is paid
true: subscription is expired <br /> false: subscription is active
true: subscription is on grace period <br /> false: subscription is not on grace period
URL of brand website
100
Time of order cancellation (UTC format)
Reason ID associated with cancellation
Time of cancellation acknowledgement (UTC format)
Time of cancellation (UTC format)
User that initiated cancellation
retailer
, brand
Cancellation ID
Order ID
Purchase order number
1
Cancellation reason
1
Time of complete order fulfillment (UTC format)
A numeric connection ID
Vendor code, which is vendor name in lower case and underscore
1 - 64
URL of the cover image
1
Time of grace period expiration (UTC format)
Vendor (brand) ID
Inventory policy
unmanaged
, managed
, use_variant_policy
true: is on Dropship network <br /> false: not on Dropship network
true: Vendor is onboarded <br /> false: Vendor is not onboarded
Time when vendor joined Dropship (UTC format)
URL of the brand logo
1
Vendor name
1 - 64
URL of the profile image
1
Represents whether subscription is required
disabled
, enabled
, upcoming
Vendor status
active
, pending
, inactive
Subscription expiry Time (UTC format)
true: subscription is overdue <br /> false: subscription is paid
true: subscription is expired <br /> false: subscription is active
true: subscription is on grace period <br /> false: subscription is not on grace period
URL of brand website
100
Description of adjustment
1 - 256
Adjustment amount
Adjustment type - dollar amount or percentage
percent
, flat
Adjustment type
allowance
, charge
Adjustment code
1 - 64
Description of adjustment
1 - 128
Adjustment ID
Adjustment type
Content type
1
Connection adjustment ID, used for monetary adjustments
Object ID
0 < x < 4294967295
Time of connection creation
Connection ID
Integration type
console
, edi
, api
, storefront
, console-print-labels
, console-register-tracking-numbers
, shopify
, bigcommerce
, shipstation
Connection type
basic
, full
Metadata
Option code
1 - 64
Option name
1 - 64
Connection description
User who can edit connection
retailer
, brand
, staff
Option ID
User who can view the connection details
retailer
, brand
, all
, none
Retailer code, which is retailer name in lower case and hyphenated
1 - 32
Retailer name
1 - 64
true: Platform allows creation of brand permit <br /> false: Platform doesn't require creation of brand permit
URL of retailer cover image
1
Retailer ID
true: Retailer is onboarded <br /> false: Retailer is not onboarded
true: Retailer is in Dropship network; Retailer is not in Dropship network
Time of retailer joining Dropship (UTC format)
URL of retailer logo
1
Platform on which retailer is onboarded
fabric
URL of retailer profile image
1
Represent whether retailer requires subscription to use the platform
disabled
, enabled
, upcoming
Retailer status
active
, setup
, ghost
Website URL
100
Variant identifier specific to retailer
32
Connection status
active
, suspended
, pending
, onboarding
Time of creation (UTC format)
Shipping carrier account ID
Code of shipping method
1 - 64
Name of shipping method
1 - 64
Carrier code
1 - 64
Carrier ID
Carrier name
1 - 64
Description of shipping method
1 - 128
Name of shipping method
1 - 32
ID of shipping method
Type of shipping method
small_parcel
, ltl
ID of shipping method
Type of shipping method
small_parcel
, ltl
Time of account (UTC format)
Time of credentials creation (UTC format)
Credentials code
1 - 64
Data type of credentials
text
, boolean
Credentials code
1 - 64
Time of credentials creation (UTC format)
Credentials ID
1: Credentials are encrypted <br /> 0: Credentials are not encrypted
-2147483648 < x < 2147483647
1: Credentials are required <br /> 0: Credentials are not required
-2147483648 < x < 2147483647
Time of credentials update (UTC format)
Credentials ID
Time of credentials update (UTC format)
Credentials value
Account ID of shipping provider
Code of shipping method
1 - 64
Name of shipping method
1 - 64
Carrier code
1 - 64
Carrier ID
Carrier name
1 - 64
Description of shipping method
1 - 128
Name of shipping method
1 - 32
ID of shipping method
Type of shipping method
small_parcel
, ltl
ID of shipping method
Type of shipping method
small_parcel
, ltl
Time of shipping provider creation (UTC format)
Credentials for shipping provider
Shipping provider ID
Name of shipping provider
32
Shipping methods
Time of shipping provider update (UTC format)
Time of account update (UTC format)
Time of last update (UTC format)
Time of credit acknowledgement