API Reference
  1. WSHOP API
  2. Returns

Create a single return

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

Creates and processes a return for a shipped order.

  • returnStatus: requested: creates a return request, generates the return voucher and label (unless include_document is false) and does not refund.
  • any other returnStatus (or none): processes the return immediately — PSP refund according to refund, restock according to restock — and closes it (unless closed is false).

If any item is invalid, nothing is processed.

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

orderId or returnId is required.

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 (e.g. created with returnStatus: requested). Takes precedence over orderId.

string

requested: creates a return request and returns the return voucher and label, without refunding. Any other value (or no value) processes the return immediately: the customer is refunded through the PSP according to refund, items are restocked according to restock.

string

External reference stored on the return (requested mode only).

boolean
Defaults to true

requested mode only: generate the return voucher and label and return them in the response.

boolean
Defaults to true

Refund mode only: close the return once processed.

number

Return fees (tax incl.) deducted from the refund. In requested mode, stored on the return.

number

Shipping fees refunded in addition to the items (refund mode only).

string
length ≤ 11

Code of an existing store to link the return to

orderItems
array of objects
required
length ≥ 1
orderItems*
string
required
length ≤ 13
integer

Return reason id (see /api/v1/returns/getreasons). Required unless external_reason_id is provided or returnId is used (the reason of the existing return line is reused).

integer
enum
required

1 to refund the item. Forced to 1 in requested mode.

Allowed:
integer
enum
required

1 to put the item back in stock

Allowed:
integer
required
≥ 1
string
length ≤ 100
boolean
Defaults to false

By default restock: 0 is stored as "not restocked"; set to true to keep the raw restock value.

integer
enum
Defaults to 2

Refund mode: 1 no refund, 2 refund, 3 credit, 4 exchange. Any mode other than 2 sets refund to 0. Ignored in requested mode.

Allowed:
string

External reason code. The matching return reason is used, or created with external_reason_name. Replaces reason.

string

Label of the reason created from external_reason_id

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?