Swap

___________________________________________________________

/products (version 2)

Find answers and get help from Intercom Support and Community Experts

This site employs cookies and other technologies that we and our third party vendors use to monitor and record personal information about you and your interactions with the site (including content viewed, cursor movements, screen recordings, and chat contents) for the purposes described in our Cookie Policy. By continuing to visit our site, you agree to our {websiteTermsLink}, {privacyPolicyLink} and {cookiePolicyLink}.

This site uses cookies and similar technologies ("cookies") as strictly necessary for site operation. We and our partners also would like to set additional cookies to enable site performance analytics, functionality, advertising and social media features. See our {cookiePolicyLink} for details. You can change your cookie preferences in our Cookie Settings.

We use cookies to make our site work and also for analytics and advertising purposes. You can enable or disable optional cookies as desired. See our {cookiePolicyLink} for more details.

Advertising cookies are set by our advertising partners to collect information about your use of the site, our communications, and other online services over time and with different browsers and devices. They use this information to show you ads online that they think will interest you and measure the ads' performance. Social media cookies are set by social media platforms to enable you to share content on those platforms, and are capable of tracking information about your activity across other online services for use as described in their privacy policies.

These cookies enable the website to provide enhanced functionality and personalisation. They may be set by us or by third party providers whose services we have added to our pages. If you do not allow these cookies then some or all of these services may not function properly.

These cookies are necessary for the website to function and cannot be switched off in our systems.

These cookies allow us to count visits and traffic sources so we can measure and improve the performance of our site. They help us to know which pages are the most and least popular and see how visitors move around the site.

You have the right to opt out of the sale of your personal information. See our {cookiePolicyLink} for more details about how we use your data.

Your Privacy Choices

We use cookies to enhance your experience. You can customize your cookie preferences below. See our {cookiePolicyLink} for more details.

Cookie Settings

Link, Press control-option-right-arrow to exit

Empty Help Center

Uh oh. That page doesn’t exist.

Disappointed

Neutral

Smiley

Thinking...

Searching through sources...

Analyzing...

Tickets submitted through the messenger or by a support agent in your conversation will appear here.

Name	Mandatory	Type	Description
api_token	yes	string	API key provided by SWAP. Must be provided in the url as a query string parameter.
store	yes	string	The store id that the products belong to.
return_type	no	string	The endpoint will return products whose return contains this type of return. Can be one of the following: - Refund - Shop Now Credit - Shop Later Credit - Additional Payment - Recycle - Warranty
approved	no	boolean	If true, returns products whose returns have been approved
from_date	yes	date	Only products that were created or modified on or after this date will be returned. ISO date format (for example, 2023-07-29T12:07:58.565Z).
to_date	no	date	Only products that were created and modified before or on this date will be returned. ISO date format.
return_status	no	string	The status of the orders these products are assigned to. Possible values are: - Open - Needs Review - Closed - Expired - On Hold - Cancelled
condition	no	string	The condition of the product. Possible values are: - Sellable - Missing - Damaged - Wrong Item
version	yes	number	2

Name	Type	Description
from_date	date	The same from_date value sent in the request
to_date	date	The same to_date value sent in the request
next_from_date	date	This is the modified_date of the last product returned. Pagination is achieved by sending this value in the from_date in the request. Null value means there are no more products that match the request.
version	number	2
products	List	List of products that match the filters in the request.

Name	Type	Description
rma	number	The RMA number
creation_date	date	The date the product was created
modified_date	date	The date the product was modified
order_number	string	The order number the product is assigned to
customer_name	string	The name of the customer who created the return
sku_id	string	The SKU of the product
sku_description	string	The description of the product
sku_ean	string	The barcode of the product
quantity	number	The number of items
shopify_order_id	string	The Shopify order id
image	string	The URL to an image of the product
carrier	string	The carrier shipping this product
tracking_number	string	The tracking number provided by the carrier
amount	number	The price of this product
condition	string	The condition of the product. Possible values are: - Sellable - Missing - Damaged - Wrong Item
return_status	string	The status of the orders these products are assigned to. Possible values are: - Open - Needs Review - Closed - Expired - On Hold - Cancelled
approved	boolean	Whether the product has been approved or not
carton_id	string	The carton id provided by Synergy
return_type	string	The type of return. Can be one of the following: - Refund - Shop Now Credit - Shop Later Credit - Additional Payment - Recycle - Warranty

/products (version 2)

Name

Method

Request

Response

Products