List shipments

GET

/shipments

curl --request GET \
  --url 'https://shipjay.com/api/v1/shipments?limit=25&status=rated' \
  --header 'Authorization: Bearer <token>'

Authorizations

• bearerAuth
  shipments:read

Parameters

Query Parameters

limit

integer

default: 25 >= 1 <= 100

cursor

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

status

string

Allowed values: rated purchasing purchased printed refunded failed

tracking_code

string

<= 60 characters

Responses

200

Success.

Media typeapplication/json

object

data

required

Array<object>

object

id

required

string

status

required

string

tracking_status

required

string | null

tracking_code

required

string | null

carrier

required

string | null

service

required

string | null

currency

required

string

price_cents

required

What the organization was charged.

number | null

insurance_cents

required

number | null

to

required

object

name

required

string | null

company

required

string | null

street1

required

string | null

street2

required

string | null

city

required

string | null

state

required

string | null

zip

required

string | null

country

required

string | null

email

required

string | null

phone

required

string | null

reference1

required

string | null

zone

required

number | null

ship_date

required

string | null

est_delivery_date

required

string | null

purchased_at

required

string | null

refund_status

required

string | null

tracking_url

required

The branded tracking page for the recipient.

string | null

has_label

required

boolean

created_at

required

string

next_cursor

required

string | null

Example ^generated

{
  "data": [
    {
      "id": "example",
      "status": "example",
      "tracking_status": "example",
      "tracking_code": "example",
      "carrier": "example",
      "service": "example",
      "currency": "example",
      "price_cents": 1,
      "insurance_cents": 1,
      "to": {
        "name": "example",
        "company": "example",
        "street1": "example",
        "street2": "example",
        "city": "example",
        "state": "example",
        "zip": "example",
        "country": "example",
        "email": "example",
        "phone": "example"
      },
      "reference1": "example",
      "zone": 1,
      "ship_date": "example",
      "est_delivery_date": "example",
      "purchased_at": "example",
      "refund_status": "example",
      "tracking_url": "example",
      "has_label": true,
      "created_at": "example"
    }
  ],
  "next_cursor": "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"
  }
}