Data model

country_code string

Country code (iso 3166-1 alpha 2 format)

country
string

Country name. Prefer using country_code if possible. country_code will have precedence over country

zip
string

Zip code

state_code
string

State code

city
string

City name

warehouse_merchant_id string, optional

Specify the warehouse your order originates from. If this warehouse is configured in Shipup, we will use its location as an origin and its settings to compute shipping time.

code string

Carrier code for this shipment. See available carrier codes

service_code
string

Carrier service code. A list of available service_codes can be found here.

ordered_at datetime

Time at which the order was placed. If left empty, it will be replaced by the current time (i.e. the customer is currently placing the order)

order_processing_time
integer

Processing time for order in days. If left blank, Shipup will use warehouse's processing time.

merchant_shipping_date
date (YYYY-MM-DD string)

Order shipping date. If left blank, Shipup will make a prediction including the shipping time and the delivery time.

Only fill this field if you know exactly when the order will be shipped (e.g. for pre-orders or product sent on a specific date of the month)

carrier_code string

Carrier code for this shipment. See availabe carrier codes

service_code
string

Carrier service code. A list of available service_codes can be found here.

delivery_date
date (YYYY-MM-DD format)

Optimistic estimated date of delivery

safe_delivery_date
date (YYYY-MM-DD format)

Safer estimation that adds a one-day delay to the optimistic estimation. That delay is added before any post-processing rule is applied.

cutoff_datetime_utc
datetime (ISO format)

The nearest cutoff time for the carrier service in UTC timezone.