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)
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Customer order number
Purchase order number
Retailer order number
Vendor identifier
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
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
A numeric connection ID
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
ID of the requested shipping method
Name of shipping method
Description of shipping method
Type of shipping method
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
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
true: Automatically generates shipping labels based on the carrier <br /> false: Does not support generation of shipping labels
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
Currency name
Currency symbol
Time of order finalization (UTC format)
Time of order acknowledgement (UTC format)
Time of order fulfillment (UTC format)
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)
Fill time
Represents whether signature is required
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
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
Connection status
Connection type
Option name
Option code
Connection description
User who can view the connection details
User who can edit connection
Integration type
Variant identifier specific to retailer
Name of shipping provider
Name of shipping method
Code of shipping method
Type of shipping method
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
true: Priority order <br /> false: Not a priority order
First name of user
Last name of user
User title
User status
User type
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
Purchase order number
1Time of order finalization (UTC format)
Customer order number
64Retailer order number
1Vendor identifier
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 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 A numeric connection ID
Name 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 ID of the requested shipping method
Name of shipping method
1 - 32Description of shipping method
1 - 128Type of shipping method
small_parcel, ltl 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
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
32true: Automatically generates shipping labels based on the carrier <br /> false: Does not support generation of shipping labels
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
Time of order acknowledgement (UTC format)
Time of order fulfillment (UTC format)
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)
Fill time
Represents whether signature is required
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 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 Connection status
active, suspended, pending, onboarding Connection type
basic, full Option name
1 - 64Option code
1 - 64Connection description
User who can view the connection details
retailer, brand, all, none User who can edit connection
retailer, brand, staff Integration type
console, edi, api, storefront, console-print-labels, console-register-tracking-numbers, shopify, bigcommerce, shipstation Variant identifier specific to retailer
32Name of shipping provider
32Name 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 Name 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 true: Priority order <br /> false: Not a priority order
First name of user
64Last name of user
64User title
64User status
active, invited, locked User type
standard, api Response
Purchase order number
1Time of order finalization (UTC format)
Order ID
Customer order number
64Retailer order number
1Vendor identifier
64Retailer 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 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 Vendor (brand) ID
Vendor name
1 - 64Vendor code, which is vendor name in lower case and underscore
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 A numeric connection ID
Name 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 ID of the requested shipping method
Name of shipping method
1 - 32Description of shipping method
1 - 128ID of shipping method
Type of shipping method
small_parcel, ltl Shipment count
Invoice count
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
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
32true: 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
1true: 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)
Order line ID
Order line number (auto-incremental number)
Total products in the order
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
1Time 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 of order finalization (UTC format)
Time till when product is backordered (UTC format)
Details of product variant
Metadata ID
Metadata name
1Metadata value, depending on the type
Metadata type such as integer, float, etc.
1Time of metadata creation (UTC format)
Cancellation ID
Time of cancellation (UTC format)
User that initiated cancellation
retailer, brand Reason ID associated with cancellation
Order ID
Purchase order number
1Cancellation reason
1Time of cancellation acknowledgement (UTC format)
Shipment ID
Order 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
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
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
255File name used for sharing
255URL of attachment
1Memo 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
64Last name of user
64User title
64User status
active, invited, locked User type
standard, api URL of the user photo
1URL of the user's profile photo
1true: 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
64Last name of user
64User title
64User status
active, invited, locked User type
standard, api URL of the user photo
1URL of the user's profile photo
1true: user is me: <br /> false: user is not me
Time of object tag creation (UTC format)
Time of last update (UTC format)
Gift message
Fill time
Invoice 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 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 Connection ID
Invoice number
1 - 32Types of invoice terms
End of Month (EOM), No Charge, Consignment, 10 Days After End of Month (10 EOM), Cash Discount Terms Apply, Basic, Fixed Date, Late Payment Penalty Applies, Extended, Discount Not Applicable, Fixed Date, Previously agreed upon Description of invoice terms
Number of days to pay invoice
-2147483648 < x < 2147483647Payment expected date
Discount percentage on selected term
Order ID related to invoice
Customer order number (for enduser)
64Purchase order number (for retailer)
64Invoice status
closed, open 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
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 shipping carrier
32Code of shipping carrier
32Shipping account number
32Name of shipping method
32Code of shipping method
32Shipping tracking number
32Shipping weight
Addition info adding to shipping
Time of invoice creation (UTC format)
Time of order finalization (UTC format)
Time of shipping (UTC format)
Time of retailer acknowledgement (UTC format)
Time of payment (UTC format)
Time of complete invoice payment (UTC format)
Time of order cancellation (UTC format)
Allowance ID
Adjustment type
allowance, charge Adjustment code
1 - 64Description of adjustment
1 - 128Adjustment ID
Description of allowance
1 - 128Allowance price
Invoice ID
Adjustment type
allowance, charge Adjustment code
1 - 64Description of adjustment
1 - 128Adjustment ID
Invoice description
1 - 128Invoice price
Invoice line ID
Variant ID
Variant Name
200Vendor 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 Unique SKU assigned by the Brand
1Identifier assigned by the retailer (if set). Otherwise, returns the unique SKU assigned by the Brand.
128UPC or other GTIN
64Carton ID
Carton number
-2147483648 < x < 2147483647Carton length
Unit of length
Carton width
Unit of width
Carton height
Unit of height
Carton weight
Unit of weight
Girth of the package, in inches
Size of the package, in inches
Color of the item (from attributes.color)
128Style of the item (will be the same value as attributes.style)
128Size of the item (will be the same value as attributes.size)
128Variant ID
Width of variant image
-2147483648 < x < 2147483647Height of variant image
-2147483648 < x < 2147483647Variant images
Order in which the vendor prefers the images to be shown image 1 is shown first.
-2147483648 < x < 2147483647URL of variant image
Time of variant image update (UTC format)
Time of variant image creation (UTC format)
Attribute ID
Attribute code
1 - 200Attribute name
1 - 200User permission to edit attribute
retailer, brand, any, none Criteria to group attribute
description, general, images, inventory, misc, retailer, shipping, identifiers, pricing Attribute description
Attribute type
boolean, date, list, media, money, number, percent, string, text, url Unit of the selected attribute type. If the attribute type is money, the unit is USD.
32ID of ruleset variant
Status of ruleset variant
processing, passed, failed Response
Time of creation (UTC format)
Time of last update (UTC format)
Number of items that are passed and failed in rule validation.
Permit ID
Retailer price of the variant
Retailer cost of variant
Time of permit start (UTC format)
Time of permit end (UTC format)
true: permit is in effect <br /> false: permit is not in effect
Time when permit got revoked (UTC format)
true: permit is acknowledged <br /> false: permit is not acknowledged
Time of acknowledgement (UTC format)
Permit ID
Retailer price of the variant
Retailer cost of variant
Time of permit start (UTC format)
Time of permit end (UTC format)
true: permit is in effect <br /> false: permit is not in effect
Time when permit got revoked (UTC format)
true: permit is acknowledged <br /> false: permit is not acknowledged
Time of acknowledgement (UTC format)
true: variant meets requirement <br /> false: variant doesn not meet requirement
Proposal variant ID
Pricing of variant
Variant ID
Time of approval (UTC format)
Time of creation (UTC format)
Time of last update (UTC format)
Time of proposal rejection (UTC format)
Rejection reason
32true: proposal is rejected <br /> false: proposal is not rejected
true: proposal is approved <br /> false: proposal is not approved
true: proposal is deleted <br /> false: proposal is not deleted
Retailer ID
Stock Keeping Unit (SKU), unique identifier of a product
256Retailer name
256Time of inventory update (UTC format)
Time of inventory submit (UTC format)
Time of vendor inventory update (UTC format)
Time when product or variant was marked sellable (UTC format)
Estimated delivery date (UTC format)
1true: Product is discontinued <br /> false: Product is active
Time of when product inventory was discontinued (UTC format)
Inventory of variant
yes: Variant is sellable <br /> No: Variant is not sellable
true: product is replenishable <br /> false: product is not replenishable
Invoice line number
-2147483648 < x < 2147483647Vendor identifier of product
128Universal product code (UPC) is a 12-digit combination of numbers assigned to each product in your dropshipping store
32Product quantity
-2147483648 < x < 2147483647Product name
128Product description
128Time of cancellation (UTC format)
Discounted price
Retail price
Total invoice amount (exluding taxes)
Pending amount
Expected due amount (excluding allowances and charges)
Sub-total
Total tax on the invoice
Invoice acceptance ID
Vendor acceptanc
User ID who accepted or rejected the invoice
First name of user
64Last name of user
64User title
64User status
active, invited, locked User type
standard, api URL of the user photo
1URL of the user's profile photo
1true: user is me: <br /> false: user is not me
User ID who accepted or rejected the invoice
First name of user
64Last name of user
64User title
64User status
active, invited, locked User type
standard, api URL of the user photo
1URL of the user's profile photo
1true: user is me: <br /> false: user is not me
Reason for invoice rejection
128Time of invoice acceptance (UTC format)
Time of invoice rejection (UTC format)
Represents whether signature is required
required, not_required, adult RMA ID. This ID is required in subsequent endpoints related to RMA.
Order ID
Purchase order number
1RMA number
32RMA status. Default is Pending.
pending, approved, rejected User that initiated RMA
retailer, brand Time of RMA creation (UTC format)
Time of RMA approval (UTC format)
Time of RMA rejection(UTC format)
Time of order finalization (UTC format)
Time of RMA acknowledgement (UTC format)
RMA line ID
Variant ID
Variant Name
200Vendor 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 Unique SKU assigned by the Brand
1Identifier assigned by the retailer (if set). Otherwise, returns the unique SKU assigned by the Brand.
128UPC or other GTIN
64Carton ID
Carton number
-2147483648 < x < 2147483647Carton length
Unit of length
Carton width
Unit of width
Carton height
Unit of height
Carton weight
Unit of weight
Girth of the package, in inches
Size of the package, in inches
Color of the item (from attributes.color)
128Style of the item (will be the same value as attributes.style)
128Size of the item (will be the same value as attributes.size)
128Variant ID
Width of variant image
-2147483648 < x < 2147483647Height of variant image
-2147483648 < x < 2147483647Variant images
Order in which the vendor prefers the images to be shown image 1 is shown first.
-2147483648 < x < 2147483647URL of variant image
Time of variant image update (UTC format)
Time of variant image creation (UTC format)
Attribute ID
Attribute code
1 - 200Attribute name
1 - 200User permission to edit attribute
retailer, brand, any, none Criteria to group attribute
description, general, images, inventory, misc, retailer, shipping, identifiers, pricing Attribute description
Attribute type
boolean, date, list, media, money, number, percent, string, text, url Unit of the selected attribute type. If the attribute type is money, the unit is USD.
32ID of ruleset variant
Status of ruleset variant
processing, passed, failed Response
Time of creation (UTC format)
Time of last update (UTC format)
Number of items that are passed and failed in rule validation.
Permit ID
Retailer price of the variant
Retailer cost of variant
Time of permit start (UTC format)
Time of permit end (UTC format)
true: permit is in effect <br /> false: permit is not in effect
Time when permit got revoked (UTC format)
true: permit is acknowledged <br /> false: permit is not acknowledged
Time of acknowledgement (UTC format)
Permit ID
Retailer price of the variant
Retailer cost of variant
Time of permit start (UTC format)
Time of permit end (UTC format)
true: permit is in effect <br /> false: permit is not in effect
Time when permit got revoked (UTC format)
true: permit is acknowledged <br /> false: permit is not acknowledged
Time of acknowledgement (UTC format)
true: variant meets requirement <br /> false: variant doesn not meet requirement
Proposal variant ID
Pricing of variant
Variant ID
Time of approval (UTC format)
Time of creation (UTC format)
Time of last update (UTC format)
Time of proposal rejection (UTC format)
Rejection reason
32true: proposal is rejected <br /> false: proposal is not rejected
true: proposal is approved <br /> false: proposal is not approved
true: proposal is deleted <br /> false: proposal is not deleted
Retailer ID
Stock Keeping Unit (SKU), unique identifier of a product
256Retailer name
256Time of inventory update (UTC format)
Time of inventory submit (UTC format)
Time of vendor inventory update (UTC format)
Time when product or variant was marked sellable (UTC format)
Estimated delivery date (UTC format)
1true: Product is discontinued <br /> false: Product is active
Time of when product inventory was discontinued (UTC format)
Inventory of variant
yes: Variant is sellable <br /> No: Variant is not sellable
true: product is replenishable <br /> false: product is not replenishable
Total quantity
-2147483648 < x < 2147483647Quantity shipped
Net price
Reason for return
1ID associated with return reason
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
64Last name of user
64User title
64User status
active, invited, locked User type
standard, api URL of the user photo
1URL of the user's profile photo
1true: 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)
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
255File name used for sharing
255URL of attachment
1Retailer 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 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 Total amount
Credit ID
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 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 Order ID
ID associated with return reason
RMA ID. This ID is required in subsequent endpoints related to RMA.
Purchase order number
1RMA number
32RMA status. Default is Pending.
pending, approved, rejected User that initiated RMA
retailer, brand Time of RMA creation (UTC format)
Time of RMA approval (UTC format)
Time of RMA rejection(UTC format)
Time of order finalization (UTC format)
Time of RMA acknowledgement (UTC format)
RMA line ID
Total quantity
-2147483648 < x < 2147483647Quantity shipped
Net price
Reason for return
1Memo ID
Memo text
Memo visibility
any, retailer, brand Time memo acknowledgement (UTC format)
true: notify stakeholders <br /> false: do not notify
Represents whether memo is created by retailer or brand?
retailer, brand Time of memo creation (UTC format)
Time of memo update (UTC format)
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
255File name used for sharing
255URL of attachment
1Retailer 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 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 Total amount
Credit ID
Order details
Credit number
32Time of credit acknowledgement
Time of credit (UTC format)
Time of creation (UTC format)
Subtotal amount
Credit amount
Invoice number
1 - 32Invoice 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 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 Connection ID
Types of invoice terms
End of Month (EOM), No Charge, Consignment, 10 Days After End of Month (10 EOM), Cash Discount Terms Apply, Basic, Fixed Date, Late Payment Penalty Applies, Extended, Discount Not Applicable, Fixed Date, Previously agreed upon Description of invoice terms
Number of days to pay invoice
-2147483648 < x < 2147483647Payment expected date
Discount percentage on selected term
Order ID related to invoice
Customer order number (for enduser)
64Purchase order number (for retailer)
64Invoice status
closed, open 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
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 shipping carrier
32Code of shipping carrier
32Shipping account number
32Name of shipping method
32Code of shipping method
32Shipping tracking number
32Shipping weight
Addition info adding to shipping
Time of invoice creation (UTC format)
Time of order finalization (UTC format)
Time of shipping (UTC format)
Time of retailer acknowledgement (UTC format)
Time of payment (UTC format)
Time of complete invoice payment (UTC format)
Time of order cancellation (UTC format)
Invoice line ID
Invoice line number
-2147483648 < x < 2147483647Vendor identifier of product
128Universal product code (UPC) is a 12-digit combination of numbers assigned to each product in your dropshipping store
32Product quantity
-2147483648 < x < 2147483647Product name
128Product description
128Time of cancellation (UTC format)
Discounted price
Retail price
Total invoice amount (exluding taxes)
Pending amount
Expected due amount (excluding allowances and charges)
Sub-total
Total tax on the invoice
Invoice acceptance ID
Vendor acceptanc
Reason for invoice rejection
128Time of invoice acceptance (UTC format)
Time of invoice rejection (UTC format)
Order details
Credit number
32Credit line ID
Variant ID
Variant Name
200Unique SKU assigned by the Brand
1Identifier assigned by the retailer (if set). Otherwise, returns the unique SKU assigned by the Brand.
128UPC or other GTIN
64Color of the item (from attributes.color)
128Style of the item (will be the same value as attributes.style)
128Size of the item (will be the same value as attributes.size)
128Number of items that are passed and failed in rule validation.
true: variant meets requirement <br /> false: variant doesn not meet requirement
Quantity
-2147483648 < x < 2147483647Credit line net price
Time of credit acknowledgement
Time of credit (UTC format)
Time of creation (UTC format)
Subtotal amount
Credit amount
Credit ID
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 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 Order ID
ID associated with return reason
RMA ID. This ID is required in subsequent endpoints related to RMA.
Purchase order number
1RMA number
32RMA status. Default is Pending.
pending, approved, rejected User that initiated RMA
retailer, brand Time of RMA creation (UTC format)
Time of RMA approval (UTC format)
Time of RMA rejection(UTC format)
Time of order finalization (UTC format)
Time of RMA acknowledgement (UTC format)
RMA line ID
Variant ID
Variant Name
200Unique SKU assigned by the Brand
1Identifier assigned by the retailer (if set). Otherwise, returns the unique SKU assigned by the Brand.
128UPC or other GTIN
64Color of the item (from attributes.color)
128Style of the item (will be the same value as attributes.style)
128Size of the item (will be the same value as attributes.size)
128Number of items that are passed and failed in rule validation.
true: variant meets requirement <br /> false: variant doesn not meet requirement
Total quantity
-2147483648 < x < 2147483647Quantity shipped
Net price
Reason for return
1Memo 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
64Last name of user
64User title
64User status
active, invited, locked User type
standard, api URL of the user photo
1URL of the user's profile photo
1true: 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)
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
255File name used for sharing
255URL of attachment
1Retailer 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 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 Total amount
Credit ID
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 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 Order ID
ID associated with return reason
RMA ID. This ID is required in subsequent endpoints related to RMA.
Purchase order number
1RMA number
32RMA status. Default is Pending.
pending, approved, rejected User that initiated RMA
retailer, brand Time of RMA creation (UTC format)
Time of RMA approval (UTC format)
Time of RMA rejection(UTC format)
Time of order finalization (UTC format)
Time of RMA acknowledgement (UTC format)
Reason for return
1Total amount
Invoice number
1 - 32Invoice ID
Connection ID
Types of invoice terms
End of Month (EOM), No Charge, Consignment, 10 Days After End of Month (10 EOM), Cash Discount Terms Apply, Basic, Fixed Date, Late Payment Penalty Applies, Extended, Discount Not Applicable, Fixed Date, Previously agreed upon Description of invoice terms
Number of days to pay invoice
-2147483648 < x < 2147483647Payment expected date
Discount percentage on selected term
Order ID related to invoice
Customer order number (for enduser)
64Purchase order number (for retailer)
64Invoice status
closed, open Name of shipping carrier
32Code of shipping carrier
32Shipping account number
32Name of shipping method
32Code of shipping method
32Shipping tracking number
32Shipping weight
Addition info adding to shipping
Time of invoice creation (UTC format)
Time of order finalization (UTC format)
Time of shipping (UTC format)
Time of retailer acknowledgement (UTC format)
Time of payment (UTC format)
Time of complete invoice payment (UTC format)
Time of order cancellation (UTC format)
Total invoice amount (exluding taxes)
Pending amount
Expected due amount (excluding allowances and charges)
Sub-total
Total tax on the invoice
Order details
Credit number
32Time of credit acknowledgement
Time of credit (UTC format)
Time of creation (UTC format)
Subtotal amount
Credit amount
Invoice number
1 - 32Invoice 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 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 Connection ID
Types of invoice terms
End of Month (EOM), No Charge, Consignment, 10 Days After End of Month (10 EOM), Cash Discount Terms Apply, Basic, Fixed Date, Late Payment Penalty Applies, Extended, Discount Not Applicable, Fixed Date, Previously agreed upon Description of invoice terms
Number of days to pay invoice
-2147483648 < x < 2147483647Payment expected date
Discount percentage on selected term
Order ID related to invoice
Customer order number (for enduser)
64Purchase order number (for retailer)
64Invoice status
closed, open 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
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 shipping carrier
32Code of shipping carrier
32Shipping account number
32Name of shipping method
32Code of shipping method
32Shipping tracking number
32Shipping weight
Addition info adding to shipping
Time of invoice creation (UTC format)
Time of order finalization (UTC format)
Time of shipping (UTC format)
Time of retailer acknowledgement (UTC format)
Time of payment (UTC format)
Time of complete invoice payment (UTC format)
Time of order cancellation (UTC format)
Allowance ID
Adjustment type
allowance, charge Adjustment code
1 - 64Description of adjustment
1 - 128Adjustment ID
Description of allowance
1 - 128Allowance price
Invoice ID
Adjustment type
allowance, charge Adjustment code
1 - 64Description of adjustment
1 - 128Adjustment ID
Invoice description
1 - 128Invoice price
Invoice line ID
Variant ID
Variant Name
200Unique SKU assigned by the Brand
1Identifier assigned by the retailer (if set). Otherwise, returns the unique SKU assigned by the Brand.
128UPC or other GTIN
64Color of the item (from attributes.color)
128Style of the item (will be the same value as attributes.style)
128Size of the item (will be the same value as attributes.size)
128Number of items that are passed and failed in rule validation.
true: variant meets requirement <br /> false: variant doesn not meet requirement
Invoice line number
-2147483648 < x < 2147483647Vendor identifier of product
128Universal product code (UPC) is a 12-digit combination of numbers assigned to each product in your dropshipping store
32Product quantity
-2147483648 < x < 2147483647Product name
128Product description
128Time of cancellation (UTC format)
Discounted price
Retail price
Total invoice amount (exluding taxes)
Pending amount
Expected due amount (excluding allowances and charges)
Sub-total
Total tax on the invoice
Invoice acceptance ID
Vendor acceptanc
User ID who accepted or rejected the invoice
First name of user
64Last name of user
64User title
64User status
active, invited, locked User type
standard, api URL of the user photo
1URL of the user's profile photo
1true: user is me: <br /> false: user is not me
User ID who accepted or rejected the invoice
First name of user
64Last name of user
64User title
64User status
active, invited, locked User type
standard, api URL of the user photo
1URL of the user's profile photo
1true: user is me: <br /> false: user is not me
Reason for invoice rejection
128Time of invoice acceptance (UTC format)
Time of invoice rejection (UTC format)
Order details
Credit number
32Credit line ID
Variant ID
Variant Name
200Vendor 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 Unique SKU assigned by the Brand
1Identifier assigned by the retailer (if set). Otherwise, returns the unique SKU assigned by the Brand.
128UPC or other GTIN
64Carton ID
Carton number
-2147483648 < x < 2147483647Carton length
Unit of length
Carton width
Unit of width
Carton height
Unit of height
Carton weight
Unit of weight
Girth of the package, in inches
Size of the package, in inches
Color of the item (from attributes.color)
128Style of the item (will be the same value as attributes.style)
128Size of the item (will be the same value as attributes.size)
128Variant ID
Width of variant image
-2147483648 < x < 2147483647Height of variant image
-2147483648 < x < 2147483647Variant images
Order in which the vendor prefers the images to be shown image 1 is shown first.
-2147483648 < x < 2147483647URL of variant image
Time of variant image update (UTC format)
Time of variant image creation (UTC format)
Attribute ID
Attribute code
1 - 200Attribute name
1 - 200User permission to edit attribute
retailer, brand, any, none Criteria to group attribute
description, general, images, inventory, misc, retailer, shipping, identifiers, pricing Attribute description
Attribute type
boolean, date, list, media, money, number, percent, string, text, url Unit of the selected attribute type. If the attribute type is money, the unit is USD.
32ID of ruleset variant
Status of ruleset variant
processing, passed, failed Response
Time of creation (UTC format)
Time of last update (UTC format)
Number of items that are passed and failed in rule validation.
Permit ID
Retailer price of the variant
Retailer cost of variant
Time of permit start (UTC format)
Time of permit end (UTC format)
true: permit is in effect <br /> false: permit is not in effect
Time when permit got revoked (UTC format)
true: permit is acknowledged <br /> false: permit is not acknowledged
Time of acknowledgement (UTC format)
Permit ID
Retailer price of the variant
Retailer cost of variant
Time of permit start (UTC format)
Time of permit end (UTC format)
true: permit is in effect <br /> false: permit is not in effect
Time when permit got revoked (UTC format)
true: permit is acknowledged <br /> false: permit is not acknowledged
Time of acknowledgement (UTC format)
true: variant meets requirement <br /> false: variant doesn not meet requirement
Proposal variant ID
Pricing of variant
Variant ID
Time of approval (UTC format)
Time of creation (UTC format)
Time of last update (UTC format)
Time of proposal rejection (UTC format)
Rejection reason
32true: proposal is rejected <br /> false: proposal is not rejected
true: proposal is approved <br /> false: proposal is not approved
true: proposal is deleted <br /> false: proposal is not deleted
Retailer ID
Stock Keeping Unit (SKU), unique identifier of a product
256Retailer name
256Time of inventory update (UTC format)
Time of inventory submit (UTC format)
Time of vendor inventory update (UTC format)
Time when product or variant was marked sellable (UTC format)
Estimated delivery date (UTC format)
1true: Product is discontinued <br /> false: Product is active
Time of when product inventory was discontinued (UTC format)
Inventory of variant
yes: Variant is sellable <br /> No: Variant is not sellable
true: product is replenishable <br /> false: product is not replenishable
Quantity
-2147483648 < x < 2147483647Credit line net price
Time of credit acknowledgement
Time of credit (UTC format)
Time of creation (UTC format)
Subtotal amount
Credit amount
Shipping carrier account ID
Connection ID
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 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 Connection status
active, suspended, pending, onboarding Time of connection creation
Connection type
basic, full Option name
1 - 64Option code
1 - 64Option ID
Connection description
User who can view the connection details
retailer, brand, all, none User who can edit connection
retailer, brand, staff Metadata
Connection adjustment ID, used for monetary adjustments
Adjustment type
allowance, charge Adjustment code
1 - 64Description of adjustment
1 - 128Adjustment ID
Description of adjustment
1 - 256Adjustment type
Adjustment type - dollar amount or percentage
percent, flat Adjustment amount
Content type
1Object ID
0 < x < 4294967295Integration type
console, edi, api, storefront, console-print-labels, console-register-tracking-numbers, shopify, bigcommerce, shipstation Variant identifier specific to retailer
32Account ID of shipping provider
Shipping provider ID
Name of shipping provider
32Credentials for shipping provider
Shipping methods
Time of shipping provider creation (UTC format)
Time of shipping provider update (UTC format)
Name of shipping method
1 - 64Code of shipping method
1 - 64ID of shipping method
Type of shipping method
small_parcel, ltl Carrier ID
Carrier name
1 - 64Carrier code
1 - 64Name of shipping method
1 - 32Description of shipping method
1 - 128ID of shipping method
Type of shipping method
small_parcel, ltl Credentials ID
Credentials code
1 - 64Credentials code
1 - 64Data type of credentials
text, boolean Credentials ID
1: Credentials are required <br /> 0: Credentials are not required
-2147483648 < x < 21474836471: Credentials are encrypted <br /> 0: Credentials are not encrypted
-2147483648 < x < 2147483647Time of credentials creation (UTC format)
Time of credentials update (UTC format)
Credentials value
Time of credentials creation (UTC format)
Time of credentials update (UTC format)
Time of account (UTC format)
Time of account update (UTC format)
Name of shipping method
1 - 64Code of shipping method
1 - 64ID of shipping method
Type of shipping method
small_parcel, ltl Carrier ID
Carrier name
1 - 64Carrier code
1 - 64Name of shipping method
1 - 32Description of shipping method
1 - 128ID of shipping method
Type of shipping method
small_parcel, ltl Time of creation (UTC format)
Time of last update (UTC format)
true: Priority order <br /> false: Not a priority order
User ID who accepted or rejected the invoice
First name of user
64Last name of user
64User title
64User status
active, invited, locked User type
standard, api URL of the user photo
1URL of the user's profile photo
1true: user is me: <br /> false: user is not me
Envelop ID
Unique identifier of EDI account
1 - 32Secondary identifier of EDI account
32EDI account ID
EDI account status
setup, testing, active, disabled, suspended 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 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 Type of identifier used by EDI account. 01 means EDI account is using DUNS number as identifier
ZZ, 01, 02, 08, 09, 12, 13, 14, 15, 16 Unique identifier of EDI account
1 - 32Secondary identifier of EDI account
32EDI account ID
EDI account status
setup, testing, active, disabled, suspended 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 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 Type of identifier used by EDI account. 01 means EDI account is using DUNS number as identifier
ZZ, 01, 02, 08, 09, 12, 13, 14, 15, 16 Electronic data exchange (EDI)
Interchange control number
0 < x < 4294967295Data interchange control number
0 < x < 4294967295Direction of envelop
incoming, outgoing true: Request is acknowledged <br /> false: Request is not acknowledged.
Functional identifier
PO, IN, SH, IB, FA, PR, PC Sub element delimiter
1 - 12Segment delimited
1 - 12Element delimiter
1 - 12Time of envelope acceptance (UTC format)
Time of envelope creation (UTC format)
Time of envelope rejection (UTC format)
Time of envelope transmittance (UTC format)
Document ID
Job ID
Content type
Object ID
0 < x < 4294967295Connection ID
Connection status
active, suspended, pending, onboarding Time of connection creation
Connection type
basic, full Metadata
Integration type
console, edi, api, storefront, console-print-labels, console-register-tracking-numbers, shopify, bigcommerce, shipstation Variant identifier specific to retailer
32Runtime ID
1 - 64Module name
1 - 64Time of job creation (UTC format)
Time of job beginning (UTC format)
Time of job ending (UTC format)
Bried description of job, for future reference
Successful completion of job
Unsuccessful completion of job
Error count
Transaction set
810, 846, 850, 855, 856, 860, 997 Transaction set control number related to EDI
0 < x < 4294967295Time of document acceptance (UTC format)
Time of document rejection (UTC format)
Envelop entity ID
Interchange control number
0 < x < 4294967295Data interchange control number
0 < x < 4294967295Direction of envelop
incoming, outgoing Functional identifier
PO, IN, SH, IB, FA, PR, PC Envelop ID
Unique identifier of EDI account
1 - 32Secondary identifier of EDI account
32EDI account ID
EDI account status
setup, testing, active, disabled, suspended Type of identifier used by EDI account. 01 means EDI account is using DUNS number as identifier
ZZ, 01, 02, 08, 09, 12, 13, 14, 15, 16 Unique identifier of EDI account
1 - 32Secondary identifier of EDI account
32EDI account ID
EDI account status
setup, testing, active, disabled, suspended Type of identifier used by EDI account. 01 means EDI account is using DUNS number as identifier
ZZ, 01, 02, 08, 09, 12, 13, 14, 15, 16 Electronic data exchange (EDI)
true: Request is acknowledged <br /> false: Request is not acknowledged.
Sub element delimiter
1 - 12Segment delimited
1 - 12Element delimiter
1 - 12Time of envelope acceptance (UTC format)
Time of envelope creation (UTC format)
Time of envelope rejection (UTC format)
Time of envelope transmittance (UTC format)
Document ID
Transaction set
810, 846, 850, 855, 856, 860, 997 Transaction set control number related to EDI
0 < x < 4294967295Time of document acceptance (UTC format)
Time of document rejection (UTC format)
Envelop entity ID
Content type
Object ID associated with the content type
0 < x < 4294967295Content type
Object ID associated with the content type
0 < x < 4294967295Was this page helpful?