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

Update a policy shipment info

post
/policies/{id}/update-shipment

Update a policy’s shipment information by ID.

This api is used to update the shipment information. When the shipment information is provided, the policy will be activated and you can make a claim via policy.

Request

Path Parameters

id
string
required

policy id

Body

order
object
required
trackings
array[Tracking]
required
>= 1 items
ship_date
string
required

ship date of package

>= 1 characters
Match pattern:
^[0-9]{4}-[0-9]{2}-[0-9]{2}$
additional_fields
string

additional fields for remark extra info

Auth
:
Parameters
:
Body
preparing...