POST
/
api-order
/
orders
/
bulk-return
curl --request POST \
  --url https://prod01-apigw.{customer_name}.fabric.zone/api-order/orders/bulk-return \
  --header 'Content-Type: application/json' \
  --header 'x-site-context: <x-site-context>' \
  --data '[
  {
    "returnCode": "123",
    "orderId": "2947-5955-82579",
    "returnMessage": "Customer not interested",
    "sugarRefund": true
  }
]'
[
  {
    "orderId": "4719-4940-97474",
    "status": "Error",
    "code": "ORDER_RETURN_INVALID",
    "message": "Order status must be ORDER_SHIPPED or ORDER_FULFILLED or ORDER_DELIVERD"
  },
  {
    "orderId": "7579-4892-68436",
    "status": "Successfully Returned order"
  }
]

Headers

​
x-api-key
string
Example:

"0LybWR49k95cCwYh3cu0waCYoh4H2Eux2J52wn4k"

​
x-site-context
string
required

The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.

Example:

"{\"date\": \"2023-01-01T00:00:00.000Z\", \"channel\": 12, \"account\": \"1234abcd5678efgh9ijklmno\",\"stage\":\"production\"}"

Body

application/json · object[]
​
returnCode
string
Example:

"123"

​
orderId
string
Required string length: 15
Example:

"2947-5955-82579"

​
returnMessage
string
Example:

"Customer not interested"

​
sugarRefund
boolean
Example:

true

Response

200
application/json
Successfully return orders
​
orderId
string
​
status
string

Was this page helpful?