Skip to main content
GET
Preview the choices for a mis-shipment correction's return

Authorizations

Authorization
string
header
required

API key issued per entity via Settings > Developers > API Keys. Each key carries scopes (e.g. orders:read, products:write). Bearer token format: Authorization: Bearer ark_live_ent_Test keys use ark_test_ent_. Both are issued per entity
via Settings > Developers > API Keys.

Path Parameters

id
string<uuid>
required

Response

The return's hold and the three choices. blocked is true while a wrong unit is held for the return or after its hold was written off (a void of the return is refused then, in the words of message). Each choice says whether it is available today, why not (why_not) when it is not, and in books what it books, one sentence each.

data
object
required