Skip to main content
POST
Create a contract for a carrier

Authorizations

Authorization
string
header
required

Basic Authentication using API key and secrets is currently the main authentication mechanism.

Body

application/json

Contract request object model

contract_data
object
required

Fields for creating a contract. It supports dynamic key-value pairs, where keys represent field names and values are string-based data.

Example:
carrier_code
string
required

The carrier code of the contract

Example:

"postnl"

is_active
boolean
default:false

New contracts are inactive by default, if you want to activate it immediately set this flag.

Example:

false

is_default_per_carrier
boolean
default:false

Marks the contract as default for a carrier. You can have only one default direct contract per carrier.

Example:

false

Response

OK

Create a contract

data
Contract · object

User contract