Authentication v1
- Identity APIs
- User
- Address
- Auth
User Self Service APIs
- Introduction
- User Self Service APIs
- Authentication APIs
Experiences v2 (XM v2)
- XM
- Pages
- Global Components
- Menu
Experiences v1 (XM v1)
- XM
- Pages
- Global Components
- Menu
Product Catalog
- Product Catalog
- Category
- Product
- Attributes
- Bulk Import
Orders v2 (OMS v2)
- Order Management System
- Order
- Order Attribute
- Developer Guide
- Order Return
- Payment Status
- Package Tracking
- Cross Border
- Order Cancellation
- Appeasement
- Allocation
- Configuration
- Fraud Configuration
- Target Configuration
- Location
- Location Attribute
- Inventory Network
- Inventory
- Inventory Counter
- Inventory Bulk Operation
- Inventory Attribute
- Inventory Upload Log
- Shipment
- Shipping Method
- Webhook
- Notification
- Export
- Invoice
- Fraud
- Backorder Preorder Reservation
- List
Orders v1 (OMS v1)
- Order Management System
- Cart
- Bill To
- Ship To
- Wishlist
- Cart Decoupled
- Warehouse
- Inventory
- Attributes
- List
- Tax/Address Validate
- Shipping
- Payments
- Order
Offers v2
- Offers
- Developer Guide
- Promotion
- Price Kind
- Dynamic Pricing Engine
- Segment
- Coupon
- Coupon Codes
- Product
- Price List
- Attributes
- Item
- Price Guard
- Global Exclusion
- Upload Price CSV
- Pricing
- Redemption
- Exports
Offers v1
- Offers
- Login API
- Promotions
- Pricing
Subscriptions (SMT API)
- Subscriptions API
- Cancellation Reasons
- Subscription Discounts
- Subscriptions
- Subscribers
- Orders
Loyalty (Member)
- Member APIs
- Inquire
- Discounts
- Redeem
- Earn
- Members
Dropship
- Dropship API
- Shipments
- Products
- Invoices
- Connections
- Inventory
- Developer Guide
- Returns
- Orders
Cart API
- Cart
- Order Draft
- Attribute
- Adjustments
- Shipping
- Cart
Checkout API
- Checkout
- Checkout
Customer
- Core Concepts
- Customer Service
- Organization
- User Party
- Organization Group Addresses
- User Internal Party
- Organization Contracts
- Party
- Party Contracts
- Contracts
- User
- Search
- User Trait
- Organization Users
- Address
- User Address
- Trait
- Party Address
- Party Trait
- Organization Group Users
- Internal Party
- Contract Pricelist
- Internal Parties Party
- Account
- Party Account
- Organization Addresses
- Organization Groups
- Individual Addresses
- Users Organization
- Individual
Get a list of returns
Gets a list of returns. RMAs are issued when merchandise needs to be, or has already been, returned to the vendor. Either party (vendor or retailer) can initiate the return. Once created, the return’s status is set to pending while the vendor awaits the delivery of the items to the return address. Upon receipt, the vendor will inspect the items, and if all is well, close the return.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Retailer ID
Query Parameters
Search by RMA status or identifier
RMA status
Purchase order number
RMA number
Reason IDs associated with RMAs. Multiple values may be separated by commas.
RMA reason
From a past date till current time (Unix epoch format)
Vendor ID. Multiple values may be separated by commas.
Connection IDs. Multiple values may be separated by commas.
Sorting criteria
Page number within the paginated response
Number of records per page
Response
Total number of records
Order ID
ID associated with return reason
Time of RMA acknowledgement (UTC format)
Time of RMA approval (UTC format)
Content type
File name
File name used for sharing
255Attachment or document ID
Attachement object ID
Original file name
255User ID that uploaded the attachment
URL of attachment
1User permission who can view the attachment
me, connections, everyone Vendor code, which is vendor name in lower case and underscore
1 - 64URL of the cover image
1Time 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
1Vendor name
1 - 64URL of the profile image
1Represents 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
100User that initiated RMA
retailer, brand Time of credit acknowledgement
Vendor code, which is vendor name in lower case and underscore
1 - 64URL of the cover image
1Time 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
1Vendor name
1 - 64URL of the profile image
1Represents 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
100Time of creation (UTC format)
Credit amount
Quantity
-2147483648 < x < 2147483647Credit line ID
Credit line net price
Unique SKU assigned by the Brand
1Color of the item (from attributes.color)
128Variant ID
Identifier assigned by the retailer (if set). Otherwise, returns the unique SKU assigned by the Brand.
128true: variant meets requirement <br /> false: variant doesn not meet requirement
Variant Name
200Number of items that are passed and failed in rule validation.
Size of the item (will be the same value as attributes.size)
128Style of the item (will be the same value as attributes.style)
128UPC or other GTIN
64Credit number
32Time of credit (UTC format)
Credit ID
Invoice number
1 - 32Time of retailer acknowledgement (UTC format)
Description of allowance
1 - 128Allowance price
Allowance ID
Vendor code, which is vendor name in lower case and underscore
1 - 64URL of the cover image
1Time 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
1Vendor name
1 - 64URL of the profile image
1Represents 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
100Time of order cancellation (UTC format)
Time of complete invoice payment (UTC format)
Connection ID
Customer order number (for enduser)
64Pending amount
Expected due amount (excluding allowances and charges)
Invoice ID
Time of invoice acceptance (UTC format)
Vendor acceptanc
Invoice acceptance ID
Reason for invoice rejection
128Time of invoice rejection (UTC format)
Discounted price
Product quantity
-2147483648 < x < 2147483647Time of cancellation (UTC format)
Product description
128Invoice 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 name
128Retail price
Time of invoice creation (UTC format)
Total invoice amount (exluding taxes)
Addition info adding to shipping
Order ID related to invoice
Time of order finalization (UTC format)
Time of payment (UTC format)
Purchase order number (for retailer)
64City name
1 - 64Country name
1 - 128Name of the primary contact?
1 - 64Postal code
1 - 32State name
1 - 32Line 1 of the address
1 - 128Contact email address
128Fax number
32Federal tax ID
32Address ID
Name of the alternative contact?
64Primary contact number
32Alternate contact number
32Line 2 of the address
128Type of address
residential, commercial Retailer code, which is retailer name in lower case and hyphenated
1 - 32Retailer name
1 - 64true: Platform allows creation of brand permit <br /> false: Platform doesn't require creation of brand permit
URL of retailer cover image
1Retailer 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
1Platform on which retailer is onboarded
fabric URL of retailer profile image
1Represent whether retailer requires subscription to use the platform
disabled, enabled, upcoming Retailer status
active, setup, ghost Website URL
100City name
1 - 64Country name
1 - 128Name of the primary contact?
1 - 64Postal code
1 - 32State name
1 - 32Line 1 of the address
1 - 128Contact email address
128Fax number
32Federal tax ID
32Address ID
Name of the alternative contact?
64Primary contact number
32Alternate contact number
32Line 2 of the address
128Type of address
residential, commercial City name
1 - 64Country name
1 - 128Name of the primary contact?
1 - 64Postal code
1 - 32State name
1 - 32Line 1 of the address
1 - 128Contact email address
128Fax number
32Federal tax ID
32Address ID
Name of the alternative contact?
64Primary contact number
32Alternate contact number
32Line 2 of the address
128Type of address
residential, commercial Time of shipping (UTC format)
Shipping account number
32Code of shipping carrier
32Name of shipping carrier
32Code of shipping method
32Name of shipping method
32Shipping tracking number
32Shipping weight
City name
1 - 64Country name
1 - 128Name of the primary contact?
1 - 64Postal code
1 - 32State name
1 - 32Line 1 of the address
1 - 128Contact email address
128Fax number
32Federal tax ID
32Address ID
Name of the alternative contact?
64Primary contact number
32Alternate contact number
32Line 2 of the address
128Type of address
residential, commercial Invoice status
closed, open Sub-total
Total tax on the invoice
Payment expected date
Description of invoice terms
Discount percentage on selected term
Number of days to pay invoice
-2147483648 < x < 2147483647Types 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 Order details
Retailer code, which is retailer name in lower case and hyphenated
1 - 32Retailer name
1 - 64true: Platform allows creation of brand permit <br /> false: Platform doesn't require creation of brand permit
URL of retailer cover image
1Retailer 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
1Platform on which retailer is onboarded
fabric URL of retailer profile image
1Represent whether retailer requires subscription to use the platform
disabled, enabled, upcoming Retailer status
active, setup, ghost Website URL
100Order ID
ID associated with return reason
Time of RMA acknowledgement (UTC format)
Time of RMA approval (UTC format)
Content type
File name
File name used for sharing
255Attachment or document ID
Attachement object ID
Original file name
255User ID that uploaded the attachment
URL of attachment
1User permission who can view the attachment
me, connections, everyone Vendor code, which is vendor name in lower case and underscore
1 - 64URL of the cover image
1Time 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
1Vendor name
1 - 64URL of the profile image
1Represents 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
100User that initiated RMA
retailer, brand Time of credit acknowledgement
Time of creation (UTC format)
Credit amount
Credit number
32Time of credit (UTC format)
Credit ID
Order details
Subtotal amount
RMA ID. This ID is required in subsequent endpoints related to RMA.
Time memo acknowledgement (UTC format)
Time of memo creation (UTC format)
Represents whether memo is created by retailer or brand?
retailer, brand Memo ID
true: notify stakeholders <br /> false: do not notify
Memo text
Time of memo update (UTC format)
Memo visibility
any, retailer, brand Time of order finalization (UTC format)
Purchase order number
1Reason for return
1Time of RMA rejection(UTC format)
Retailer code, which is retailer name in lower case and hyphenated
1 - 32Retailer name
1 - 64true: Platform allows creation of brand permit <br /> false: Platform doesn't require creation of brand permit
URL of retailer cover image
1Retailer 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
1Platform on which retailer is onboarded
fabric URL of retailer profile image
1Represent whether retailer requires subscription to use the platform
disabled, enabled, upcoming Retailer status
active, setup, ghost Website URL
100RMA line ID
Net price
Total quantity
-2147483648 < x < 2147483647Quantity shipped
RMA number
32Time of RMA creation (UTC format)
RMA status. Default is Pending.
pending, approved, rejected Total amount
Subtotal amount
RMA ID. This ID is required in subsequent endpoints related to RMA.
Time memo acknowledgement (UTC format)
Time of memo creation (UTC format)
First name of user
64User ID who accepted or rejected the invoice
true: user is me: <br /> false: user is not me
Last name of user
64URL of the user photo
1URL of the user's profile photo
1User status
active, invited, locked User title
64User type
standard, api Represents whether memo is created by retailer or brand?
retailer, brand Memo ID
true: notify stakeholders <br /> false: do not notify
Memo text
Time of memo update (UTC format)
Memo visibility
any, retailer, brand Time of order finalization (UTC format)
Purchase order number
1Reason for return
1Time of RMA rejection(UTC format)
Retailer code, which is retailer name in lower case and hyphenated
1 - 32Retailer name
1 - 64true: Platform allows creation of brand permit <br /> false: Platform doesn't require creation of brand permit
URL of retailer cover image
1Retailer 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
1Platform on which retailer is onboarded
fabric URL of retailer profile image
1Represent whether retailer requires subscription to use the platform
disabled, enabled, upcoming Retailer status
active, setup, ghost Website URL
100RMA line ID
Net price
Total quantity
-2147483648 < x < 2147483647Quantity shipped
Time of acknowledgement (UTC format)
Time of permit end (UTC format)
Permit ID
true: permit is acknowledged <br /> false: permit is not acknowledged
true: permit is in effect <br /> false: permit is not in effect
Retailer cost of variant
Retailer price of the variant
Time when permit got revoked (UTC format)
Time of permit start (UTC format)
Attribute code
1 - 200Attribute name
1 - 200Attribute type
boolean, date, list, media, money, number, percent, string, text, url Attribute description
User permission to edit attribute
retailer, brand, any, none Criteria to group attribute
description, general, images, inventory, misc, retailer, shipping, identifiers, pricing Attribute ID
Unit of the selected attribute type. If the attribute type is money, the unit is USD.
32Vendor code, which is vendor name in lower case and underscore
1 - 64URL of the cover image
1Time 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
1Vendor name
1 - 64URL of the profile image
1Represents 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
100Unique SKU assigned by the Brand
1Carton height
Unit of height
Carton ID
Carton length
Unit of length
Carton number
-2147483648 < x < 2147483647Girth of the package, in inches
Size of the package, in inches
Carton weight
Unit of weight
Carton width
Unit of width
Color of the item (from attributes.color)
128Variant ID
Identifier assigned by the retailer (if set). Otherwise, returns the unique SKU assigned by the Brand.
128Time of vendor inventory update (UTC format)
Estimated delivery date (UTC format)
1Time of inventory submit (UTC format)
Time of inventory update (UTC format)
Time when product or variant was marked sellable (UTC format)
true: Product is discontinued <br /> false: Product is active
Time of when product inventory was discontinued (UTC format)
Inventory of variant
true: product is replenishable <br /> false: product is not replenishable
yes: Variant is sellable <br /> No: Variant is not sellable
true: variant meets requirement <br /> false: variant doesn not meet requirement
Time of variant image creation (UTC format)
Height of variant image
-2147483648 < x < 2147483647Variant ID
Variant images
Order in which the vendor prefers the images to be shown image 1 is shown first.
-2147483648 < x < 2147483647Time of variant image update (UTC format)
URL of variant image
Width of variant image
-2147483648 < x < 2147483647Variant Name
200Time of acknowledgement (UTC format)
Time of permit end (UTC format)
Permit ID
true: permit is acknowledged <br /> false: permit is not acknowledged
true: permit is in effect <br /> false: permit is not in effect
Retailer cost of variant
Retailer price of the variant
Time when permit got revoked (UTC format)
Time of permit start (UTC format)
true: proposal is approved <br /> false: proposal is not approved
Time of approval (UTC format)
Time of creation (UTC format)
true: proposal is deleted <br /> false: proposal is not deleted
Proposal variant ID
Pricing of variant
true: proposal is rejected <br /> false: proposal is not rejected
Rejection reason
32Time of proposal rejection (UTC format)
Time of last update (UTC format)
Variant ID
Retailer ID
Stock Keeping Unit (SKU), unique identifier of a product
256Retailer name
256Number of items that are passed and failed in rule validation.
Time of creation (UTC format)
ID of ruleset variant
Response
Status of ruleset variant
processing, passed, failed Time of last update (UTC format)
Size of the item (will be the same value as attributes.size)
128Style of the item (will be the same value as attributes.style)
128UPC or other GTIN
64RMA number
32Time of RMA creation (UTC format)
RMA status. Default is Pending.
pending, approved, rejected Total amount
Next page (applicable in a paginated response)
Previous page (applicable in a paginated response)
Was this page helpful?