Reject a return request

POST

/returns/{id}/reject

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

Authorizations

• bearerAuth
  returns:write

Parameters

Path Parameters

id

required

string

Request Body^required

Media typeapplication/json

object

note

required

string

>= 1 characters <= 1000 characters

Example ^generated

{
  "note": "example"
}

Responses

200

Success.

Media typeapplication/json

object

id

required

string

status

required

string

Allowed value: rejected

Example

{
  "status": "rejected"
}

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"
  }
}