Read the event feed

GET

/events

curl --request GET \
  --url 'https://shipjay.com/api/v1/events?limit=50' \
  --header 'Authorization: Bearer <token>'

Events are kept for 30 days. Poll with after set to the last id you processed, oldest first. Types: shipment.purchased, shipment.refund_requested, shipment.refunded, shipment.refund_rejected, tracking.updated, return.requested, return.approved, return.rejected, return.received, adjustment.applied, batch.completed.

Authorizations

• bearerAuth
  events:read

Parameters

Query Parameters

after

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)$/

limit

integer

default: 50 >= 1 <= 100

type

string

<= 60 characters

Responses

200

Success.

Media typeapplication/json

object

data

required

Array<object>

object

id

required

string

type

required

string

data

required

object

key

additional properties

created_at

required

string

next_cursor

required

string | null

Example ^generated

{
  "data": [
    {
      "id": "example",
      "type": "example",
      "data": {
        "additionalProperty": "example"
      },
      "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"
  }
}