ZEzentail
SalesOrder

Create or cancel a return order on a Sales Order

Creates a return order for a return the buyer requested on the sales channel, keyed on channelReturnId. A re-send of the same return changes nothing. Send cancelled: true once the channel cancels or rejects the return; it cancels the return order unless the seller has already completed or cancelled it in Zentail. Every lineItemId is checked first, so one unknown line rejects the whole request with a 400 and writes nothing.

post/salesOrder/{orderNumber}/returnOrder

Request

  • Base URL
    https://api.zentail.com/v1
  • Auth
    API key in header AUTHORIZATION

Path parameters

orderNumbernumber required

Zentail Order Number

Request body

channelReturnIdstring required

The unique identifier for the return in the sales channel. A re-send with the same value changes nothing.

requestTsstring date-time

The time the buyer requested the return. In ISO-8601 format. Defaults to now.

cancelledboolean

Send true once the channel cancels or rejects the return. It cancels an open return order. A return order the seller already completed or cancelled is left as it is.

Response

Success

returnOrderIdnumber

The unqiue identifier for the return order in Zentail

channelReturnIdstring

The unqiue identifier for the return order in the sales channel

requestTsstring date-time

The time that the return order was requested. In ISO-8601 format

cancelledboolean

Indicates the return request has been cancelled

completedTsstring date-time

The time the seller completed the return in Zentail, or null while it is still open. In ISO-8601 format

Changes

No recorded changes to this operation across all 1 revision of this API.