Name
/quality-control-expected-return
Method
POST
URL parameters
| Name | Mandatory | Type | Description |
|---|---|---|---|
| api_token | yes | string | API key provided by SWAP. |
Request
| Name | Mandatory | Type | Description |
|---|---|---|---|
| provider | yes | string | The id of the provider sending the condition update (provided by SWAP) |
| store_id | yes | string | The store id that the item belong to (provided by SWAP). |
| shopify_order_id | yes | string | The order id from Shopify |
| sku | yes | string | The item’s SKU |
| condition | yes | string | The item’s condition |
| return_qty | yes | number | Number of items returned |
| order_date | no | date | Date the order was made |
| receipt_date | no | date | Date the item was received |
| carton_id | no | string | The id of the carton |
Sample request
{
"provider": "1709139766938x413449287930836914",
"store_id": "1635427666272x611125723156784178",
"shopify_order_id": "5517725335772",
"sku": "ABBA-STRAIGHT-LEG-TROUSER-XS",
"condition": "damage",
"return_qty": 1,
"receipt_date": "29-feb-2024"
}
Response
| Name | Type | Description |
|---|---|---|
| status | string | "success" if request was successful. |
| response | json | Empty |
| statusCode | number | If error, returns an error code. If request is successful, it's not returned. |
| body | json | If error, returns the following parameters: - status: Error key - message: Error description |
Sample response
{
"status": "success",
"response": {}
}
Related to