Create a coverage

post
/coverages

Create a coverage.

Note:

  • In the shipping_address object, either phone or email field must be populated with a value.
  • In the sender_address object, the email field must be populated with a value.
order
object
required
source_id
string
required

A globally-unique identifier for the order.

number
string

order number of store/platform

>= 1 characters
items
array[Order Item]
required

items of order

>= 1 items
shipping_address
Address
required

Refers to the location from which a package or shipment will be sent, typically the address of the supplier, distributor, or retailer that is shipping the goods.

Example:
{"street_1":"1104, South University Avenue","street_2":"","postal_code":"53916","city":"Beaver Dam","state":{"name":"Wisconsin"},"country_region":{"code":"USA"},"phone":"+14155552671","email":"[email protected]","first_name":"Joe","last_name":"Smith"}
sender_address
Address
required

Refers to the location of the person or organization that is sending a package or shipment, typically the address of the individual or company that is responsible for sending the goods to their destination.

Example:
{"street_1":"1104, South University Avenue","street_2":"","postal_code":"53916","city":"Beaver Dam","state":{"name":"Wisconsin"},"country_region":{"code":"USA"},"phone":"+14155552671","email":"[email protected]","first_name":"Joe","last_name":"Smith"}
trackings
array[Tracking]

tracking info list

order_date
string<date>
required

order_date should be in UTC timezone.

>= 1 characters
Example:
2022-01-01
Match pattern:
^[0-9]{4}-[0-9]{2}-[0-9]{2}$
subtotal
Amount
required

The order's subtotal. The value of this field should be equal to the sum of the unit_insured_amount multiplied by the quantity for all items.

shipping_total
Amount

shipping_total will be included in the insured value.

Auth
:
Body
preparing...