Skip to main content
GET
/
v1
/
orders
/
{order_id}
/
case
Retrieve Case
curl --request GET \
  --url https://api.zinc.io/v1/orders/{order_id}/case \
  --header 'Authorization: Basic <encoded-value>'
{
  "state": "open",
  "messages": [
    {
      "type": "case.opened.return.request_label",
      "message": "<string>",
      "timestamp": "2023-11-07T05:31:56Z"
    }
  ]
}
Check the status of a case for a Managed Account order. Cases are automatically opened when orders are cancelled, returns are requested, or other issues occur.

​
Case States

StateDescription
nullNo case has been opened for this order
openA case has been opened for this order
closedA case has been closed for this order

​
Message Types

The messages array contains the entire case history with these possible types:
Message TypeDescription
case.opened.return.request_labelA case has been opened for a return label
case.opened.nondelivery.not_deliveredA case has been opened for a non-delivery issue
case.opened.nondelivery.damagedA case has been opened for a damaged package
case.opened.nondelivery.empty_boxA case has been opened for an empty box
case.opened.tracking.request_updateA case has been opened requesting an update on an order status
case.opened.cancel.forced_cancellationA case has been opened for an order force cancelled by the source
case.opened.otherA catch-all category for a case
case.freetextA generic, free text case response
case.return.label_generatedA return label has been generated
case.return.status_updatedThe case status has been updated
case.refund.partialThe case has resulted in a partial refund being issued
case.refund.fullThe case has resulted in a full refund being issued
case.closedThe case has been closed
The most up-to-date case status is represented by the latest object in the messages list.

Authorizations

​
Authorization
string
header
required

Use your client token as the username. Leave the password blank.

Path Parameters

​
order_id
string
required

The order ID to retrieve case information for

Response

200 - application/json

Case information retrieved successfully

​
state
enum<string> | null

Current state of the case

Available options:
open,
closed
​
messages
object[]

Array of case messages and updates

⌘I