Retrieve Return - Zinc API Documentation

Retrieve Return

curl --request GET \
  --url https://api.zinc.io/v1/returns/{request_id} \
  --header 'Authorization: Basic <encoded-value>'

{
  "merchant_return_id": "<string>",
  "return_by": "<string>",
  "label_urls": [
    "<string>"
  ],
  "request": {}
}

GET

returns

{request_id}

Retrieve Return

curl --request GET \
  --url https://api.zinc.io/v1/returns/{request_id} \
  --header 'Authorization: Basic <encoded-value>'

{
  "merchant_return_id": "<string>",
  "return_by": "<string>",
  "label_urls": [
    "<string>"
  ],
  "request": {}
}

Authorization

string

header

required

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

request_id

string

required

The unique identifier for the return request

Return details retrieved successfully

_type

enum<string>

Response type

Available options:

return_response

merchant_return_id

string

A unique identifier for the return

return_by

string

The date before which the products must be returned by

label_urls

string[]

A list of URLs for the generated return labels

request

object

The original order request that was sent to the Zinc API

⌘I

Documentation Index