Skip to main content
POST
/
v1
/
orders
/
{order_id}
/
case
Create or Update Case
curl --request POST \
  --url https://api.zinc.io/v1/orders/{order_id}/case \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "reason": "return.request_label",
  "message": "<string>"
}'
{
  "state": "open",
  "messages": [
    {
      "type": "case.opened.return.request_label",
      "message": "<string>",
      "timestamp": "2023-11-07T05:31:56Z"
    }
  ]
}
Cases are for Zinc Managed Account (ZMA) orders only. Self-managed account orders should handle issues directly with the retailer.
Add a message to an existing case to provide updates or additional information.
Do not include the reason field when updating a case - send only the message.
Check the case status regularly using the Retrieve Case endpoint for updates from Zinc support.

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 create or update a case for

Body

application/json
​
message
string
required

Message content for the case

​
reason
enum<string>

The reason for opening a case (required when opening a new case)

Available options:
return.request_label,
nondelivery.not_delivered,
nondelivery.damaged,
nondelivery.empty_box,
tracking.request_update,
cancel.forced_cancellation,
other

Response

200 - application/json

Case created or updated successfully

​
state
enum<string> | null

Current state of the case

Available options:
open,
closed
​
messages
object[]

Array of case messages and updates

⌘I