Name
/products
Method
GET
Request
| 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 |
Response
| 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. |
Products
| 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 |
Related to