Approve a return and buy its label

POST

/returns/{id}/approve

curl --request POST \
  --url https://shipjay.com/api/v1/returns/example/approve \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "note": "example" }'

Buys a prepaid return label from the wallet and emails it to the customer.

Authorizations

• bearerAuth
  returns:write

Parameters

Path Parameters

id

required

string

Request Body^required

Media typeapplication/json

object

note

string

<= 1000 characters

Example ^generated

{
  "note": "example"
}

Responses

200

Success.

Media typeapplication/json

object

id

required

string

rma

required

number

status

required

string

shipment_id

required

string

return_shipment_id

required

string | null

reason

required

string

reason_note

required

string | null

customer_email

required

string

customer_name

required

string | null

label_error

required

string | null

created_at

required

string

received_at

required

string | null

Example ^generated

{
  "id": "example",
  "rma": 1,
  "status": "example",
  "shipment_id": "example",
  "return_shipment_id": "example",
  "reason": "example",
  "reason_note": "example",
  "customer_email": "example",
  "customer_name": "example",
  "label_error": "example",
  "created_at": "example",
  "received_at": "example"
}

401

Missing or invalid API key.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: validation unauthenticated forbidden not_found conflict insufficient_funds org_suspended spend_limit rate_limited maintenance not_configured upstream internal

message

required

string

details

object

key

additional properties

any

request_id

required

string

Example

{
  "error": {
    "code": "validation"
  }
}

403

The key lacks the required permission, or the account is suspended.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: validation unauthenticated forbidden not_found conflict insufficient_funds org_suspended spend_limit rate_limited maintenance not_configured upstream internal

message

required

string

details

object

key

additional properties

any

request_id

required

string

Example

{
  "error": {
    "code": "validation"
  }
}

404

The resource does not exist.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: validation unauthenticated forbidden not_found conflict insufficient_funds org_suspended spend_limit rate_limited maintenance not_configured upstream internal

message

required

string

details

object

key

additional properties

any

request_id

required

string

Example

{
  "error": {
    "code": "validation"
  }
}

422

The request is not valid. error.details.issues lists the problems.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: validation unauthenticated forbidden not_found conflict insufficient_funds org_suspended spend_limit rate_limited maintenance not_configured upstream internal

message

required

string

details

object

key

additional properties

any

request_id

required

string

Example

{
  "error": {
    "code": "validation"
  }
}

429

Too many requests. Wait Retry-After seconds.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: validation unauthenticated forbidden not_found conflict insufficient_funds org_suspended spend_limit rate_limited maintenance not_configured upstream internal

message

required

string

details

object

key

additional properties

any

request_id

required

string

Example

{
  "error": {
    "code": "validation"
  }
}