List ship from addresses

GET

/ship-from

curl --request GET \
  --url https://shipjay.com/api/v1/ship-from \
  --header 'Authorization: Bearer <token>'

The addresses this account ships from. Pass one id as from_address_id when you get rates.

Authorizations

• bearerAuth
  shipments:read

Responses

200

Success.

Media typeapplication/json

object

data

required

Array<object>

object

id

required

Use this as from_address_id when you get rates.

string

nickname

required

string | null

name

required

string | null

company

required

string | null

street1

required

string

street2

required

string | null

city

required

string

state

required

string

zip

required

string

country

required

string

phone

required

string | null

is_default

required

boolean

use_as_return

required

Return labels ship to this address.

boolean

next_cursor

required

string | null

Example ^generated

{
  "data": [
    {
      "id": "example",
      "nickname": "example",
      "name": "example",
      "company": "example",
      "street1": "example",
      "street2": "example",
      "city": "example",
      "state": "example",
      "zip": "example",
      "country": "example",
      "phone": "example",
      "is_default": true,
      "use_as_return": true
    }
  ],
  "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"
  }
}