Skip to main content
POST
Error

Authorizations

​
Authorization
string
header
required

Prefix the value with "ApiKey" to indicate the custom authorization type

Body

application/json

Request to create a replacement (return + new order)

​
personId
string<uuid>
required

ID of the person whose equipment is being replaced

​
returnItems
object[]
required

Items to return as part of the replacement

Minimum array length: 1
​
order
object
required

The replacement order details (new equipment)

​
requestAddressConfirmation
boolean
required

Whether to request address confirmation from the person before shipping the return kit

​
isShippingAddressPresentWhenNotConfirming
boolean
required
​
returnKitAddress
object

Address for the return kit shipment. Required when requestAddressConfirmation is false (the default). Omit only when requestAddressConfirmation is true, in which case the person is prompted to confirm their address before the kit ships. If omitted and requestAddressConfirmation is false, the order's shipping address is used.

​
officeId
string<uuid>

Office ID for office returns. When set, items are returned to the office via SHIPMENT

Response

Replacement created

Response after creating a replacement

​
id
string<uuid>
required

Replacement ID

​
status
enum<string>
required

Current status of the replacement

Available options:
SUBMITTED,
PROCESSING,
COMPLETED,
PARTIALLY_COMPLETED,
CANCELLED
​
orderId
string<uuid>

ID of the replacement order (new equipment)

​
returnOrderId
string<uuid>

ID of the return order