ShipupETA object reference
Address
| FIELD | DESCRIPTION |
|---|---|
| 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 | In the context of the 'origin' field, you can specify the warehouse your order originates from. If this warehouse is configured in Shipup, we will use its location as an origin. |
Carrier
| FIELD | DESCRIPTION |
|---|---|
| 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. |
Order
| FIELD | DESCRIPTION |
|---|---|
| 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) |
| 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) |
PredictionResult
| FIELD | DESCRIPTION |
|---|---|
| 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) | Estimated date of delivery |
Updated 10 months ago