Create a shipping rule

POST

/rules

curl --request POST \
  --url https://shipjay.com/api/v1/rules \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "phase": "shipment", "priority": 100, "enabled": true, "stop_on_match": false, "conditions": { "all": [] }, "actions": [ { "type": "block", "message": "example" } ] }'

Authorizations

• bearerAuth
  rules:write

Request Body^required

Media typeapplication/json

object

name

required

string

>= 1 characters <= 80 characters

phase

required

string

Allowed values: shipment rate

priority

integer

default: 100 >= 1 <= 10000

enabled

boolean

default: true

stop_on_match

boolean

conditions

Any of:

object

object

all

required

Array

<= 20 items

Any of:

object

object

field

required

string

Allowed values: to.country to.state to.zip international weight_oz packaging_type declared_value_cents reference1 rate.carrier rate.service rate.price_cents rate.days

op

required

string

Allowed values: eq neq gt gte lt lte in not_in starts_with contains

value

required

Any of:

unknown

Any of:

string

string

<= 100 characters

number

number

boolean

boolean

Array

Array

<= 50 items

object

object

all

required

Array<object> recursive

object

object

any

required

Array<object> recursive

object

object

any

required

Array

<= 20 items

Any of:

object

object

field

required

string

Allowed values: to.country to.state to.zip international weight_oz packaging_type declared_value_cents reference1 rate.carrier rate.service rate.price_cents rate.days

op

required

string

Allowed values: eq neq gt gte lt lte in not_in starts_with contains

value

required

Any of:

unknown

Any of:

string

string

<= 100 characters

number

number

boolean

boolean

Array

Array

<= 50 items

object

object

all

required

Array<object> recursive

object

object

any

required

Array<object> recursive

actions

required

Array

>= 1 items <= 10 items

One of:

object

object

type

required

string

Allowed value: block

message

required

string

>= 1 characters <= 200 characters

object

object

type

required

string

Allowed value: require_signature

object

object

type

required

string

Allowed value: set_insurance

amount_cents

required

integer

>= 100 <= 500000

object

object

type

required

string

Allowed value: exclude_carrier

carrier

required

string

>= 1 characters <= 40 characters

object

object

type

required

string

Allowed value: exclude_service

contains

required

string

>= 1 characters <= 60 characters

object

object

type

required

string

Allowed value: max_price

cents

required

integer

> 0 <= 9007199254740991

object

object

type

required

string

Allowed value: max_days

days

required

integer

>= 1 <= 60

object

object

type

required

string

Allowed value: choose_rate

strategy

required

string

Allowed values: cheapest fastest best

carrier

string

<= 40 characters

Responses

201

Success.

Media typeapplication/json

object

id

required

string

Example ^generated

{
  "id": "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"
  }
}