QUICKSTART
API Quick Start
Authentication
SignString
Rate Limit
Body Envelope
Request Errors
CHANGELOG
Changelog
Reference
API Overview
v1
Claims
Create Claim
post
Get a claim
get
Upload Documents
post
Policies
Create Policy
post
Get a policy
get
Update a policy shipment info
post
Calculate Policy Amount
post
Model
Envelope
Meta
v1
Error
v1
Pagination
v1
Primitive
Address
v1
Amount
v1
Product
v1
ContactDetail
v1
Phone
v1
Tracking
v1
Name
v1
Resource
Policy
v1
Claim
v1
Enum
Policy Status
Claim Status
Courier Slug
Webhook
Webhook Overview
Support
Contact Support

Create Policy

post
/policies

Create a policy.

Request

Body

order
object
required
external_order_number
string

order number of platform

>= 1 characters
products
array[Product]
required

items of order

>= 1 items
destination_detail
ContactDetail
required
original_detail
ContactDetail
required
trackings
array[Tracking]

tracking info list

subtotal
Amount
required
order_date
string<date>

order time

>= 1 characters
Example:
2022-01-01
Match pattern:
^[0-9]{4}-[0-9]{2}-[0-9]{2}$
ship_date
string<date>

ship date from tracking

Example:
2022-01-01
Match pattern:
^[0-9]{4}-[0-9]{2}-[0-9]{2}$
shipment
Amount
premium
Amount
required
external_customer_id
string
required

Customer ID for identifying customer

<= 32 characters
additional_fields
string

Additional fields for extra information

Auth
:
Body
preparing...