Search…
API Reference
Resources
Delivery lead times
The delivery lead time object and its fields
Delivery lead times provide customers with detailed information about their shipments. This is useful if you ship from many stock locations or offer more shipping method options within a market.

The delivery lead time object

A delivery lead time object is returned as part of the response body of each successful list, retrieve, create or update API call.
Field
Type
Description
type
string
delivery_lead_times
id
string
The delivery lead time unique identifier
links.self
string
The delivery lead time endpoint URL
attributes.min_hours
integer
The delivery lead minimum time (in hours) when shipping from the associated stock location with the associated shipping method.
attributes.max_hours
integer
The delivery lead maximun time (in hours) when shipping from the associated stock location with the associated shipping method.
attributes.min_days
integer
The delivery lead minimum time, in days (rounded)
attributes.max_days
integer
The delivery lead maximun time, in days (rounded)
attributes.created_at
datetime
Time at which the resource was created.
attributes.updated_at
datetime
Time at which the resource was last updated.
attributes.reference
string
A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.
attributes.reference_origin
string
Any identifier of the third party system that defines the reference code
attributes.metadata
object
Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.
relationships.stock_location
object
The associated stock location.
relationships.shipping_method
object
The associated shipping method.
relationships.attachments
array
The associated attachments.
meta.mode
string
The resource environment (can be one of test or live)
Last modified 1mo ago