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 receipt of a new permit
Retailers, generally, include is_acknowledged=0 as a query parameter to get only new permits. Then, for each permit returned, retailers should process the permit and update any necessary internal systems, such as Product Catalog. After processing a permit successfully, they should acknowledge the permit using this endpoint so that subsequent queries to the /shipments/?is_acknowledged=0 endpoint does not return the processed shipment.
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Permit ID
Retailer ID
Retailer name
Retailer code, which is retailer name in lower case and hyphenated
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
Represent whether retailer requires subscription to use the platform
true: Platform allows creation of brand permit <br /> false: Platform doesn't require creation of brand permit
Website URL
Retailer status
Variant name
Vendor code. Same as vendor name in lower case and hyphenated
Vendor name
Stock Keeping Unit (SKU), unique identifier of a product
Universal product code (UPC) is a 12-digit combination of numbers assigned to each product in your drop-shipping store
Payment model
Payment terms
Method used to calculate net price
Internal only
Internal only
Internal only
Internal only
Internal only
Vendor percentage of order fee
Retailer price
Retailer cost
Time of permit beginning
Time of permit ending
Time of when permit got revoked
Time of permit acknowledgement (UTC format)
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
Retailer name
1 - 64Retailer code, which is retailer name in lower case and hyphenated
1 - 32true: 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 Variant name
200Stock Keeping Unit (SKU), unique identifier of a product
128Universal product code (UPC) is a 12-digit combination of numbers assigned to each product in your drop-shipping store
64Retailer name
1 - 64Retailer code, which is retailer name in lower case and hyphenated
1 - 32true: 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
256Payment model
direct, managed Payment terms
net15, net30, net45, net60, net90 Method used to calculate net price
estimated_commission, product_cost, specified_in_order, revshare, permit_cost Internal only
Internal only
1Internal only
1Internal only
1Internal only
Vendor percentage of order fee
Retailer price
Retailer cost
Time of permit beginning
Time of permit ending
Time of when permit got revoked
Time of permit acknowledgement (UTC format)
Response
Permit 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 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
256Connection permit ID
Connection fee ID
Payment model
direct, managed Payment terms
net15, net30, net45, net60, net90 Method used to calculate net price
estimated_commission, product_cost, specified_in_order, revshare, permit_cost Internal only
Internal only
1Internal only
1Internal only
1Internal only
Vendor percentage of order fee
Time connection fee became effective (UTC format)
Retailer price
Retailer cost
Time of permit beginning
Time of permit ending
true: Permit is in effect <br /> false: Permit is not in effect
Time of when permit got revoked
true: Permit is acknowledged <br /> false: Permit is not acknowledged
Time of permit acknowledgement (UTC format)
Was this page helpful?