API Reference
  1. WSHOP API
  2. Returns

Create returns in bulk

post
https://{instance}.wshop.cloud/api/v1/returns/bulkcreate

Processes several returns. Bulk returns are always refunded and closed immediately: returnStatus, store_code, externalRef and external_reason_id are not supported.

A validation error on items (missing orderItems, ean, reason, refund, restock or quantity, invalid returnFees or comment) rejects the whole batch; an invalid orderId/returnId only skips that return.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

One return to process. orderId or returnId is required. Bulk returns are always refunded and closed.

string
^C[0-9]{11}$|^CT[0-9]{10}$

Order number (C + 11 digits) or carrier order number (CT + 10 digits). Required if returnId is not provided.

string
^RET[0-9]{10}$|^REM[0-9]{10}$

Existing, not yet closed return to process. Takes precedence over orderId.

number

Return fees (tax incl.) deducted from the refund. Only applied when return fees are enabled on the platform and the order was not paid with Global-e or a marketplace; defaults to the fees already stored on the return.

number

Shipping fees refunded in addition to the items

boolean
Defaults to false

Force the update of the existing return data

orderItems
array of objects
required
length ≥ 1
orderItems*
Responses

Updated 6 months ago

Did this page help you?
Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 6 months ago

Did this page help you?