POST
Add a vendor delivery rate
Company space For: Buyer, Manager · Permission: vendor_delivery_rates.create Conditions
  • label and amount are required; label must be unique among the supplier’s rates.
  • amount must be 0 or more with at most currency_exponent decimals.
What else happens
  • The rate is active unless is_active is false.
Part of Manage suppliers.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

vendor
string
required

Identifier of the supplier the rate is created for.

Response

VendorDeliveryRateResource

id
string
required

Identifier of the delivery rate (27-character KSUID).

vendor_id
string
required

Identifier of the supplier that charges this delivery fee.

label
string
required

Name of the rate, unique among the supplier's rates.

amount
number
required

Delivery fee charged by the supplier. In major units (the stored minor-unit amount divided by 10 to the power currency_exponent).

is_active
boolean
required

Whether the rate can still be chosen for new receptions.

created_at
string<date-time>
required

Date and time the record was created (ISO 8601, UTC).

updated_at
string<date-time>
required

Date and time the record was last changed (ISO 8601, UTC).