Order Shipments API
Order shipments hold information about how the the order was shipped, including shipping address, weight, box size, shipping provider, and status. Orders can have more than one shipment.
Use the Order Shipment API to retrieve information about the shipment for an order.
Use the Order Shipment API to retrieve information about the shipment for an order.
Note: To authenticate with the Weebly API, you need to use OAuth. This will allow you to access resources based on a particular user and site.
In this topic:
Fields
The following table shows all fields that exist for this API and those that are returned when you retrieve a list. All fields are returned when you retrieve a single item.
Name |
Description |
Type |
List? |
user_id |
Unique ID of the user authenticated during the OAuth process |
string |
X |
site_id |
ID of a Weebly site, unique to the currently authenticated user |
string |
X |
order_id |
The unique order ID (within the store) of the order |
string |
X |
order_shipment_id |
The unique ID (within the order) for this shipment |
string |
X |
shipping_provider |
Company used to ship the order |
string |
|
weight |
Weight of the box |
integer |
|
weight_unit |
The weight unit used for this order (kg or lb). If not set, defaults to the store's weight unit. |
string |
|
height |
Height of the box |
integer |
|
width |
Width of the box |
integer |
|
depth |
Depth of the box |
integer |
|
full_name |
Full name of the addressee |
string |
|
email |
Email of the addressee |
string |
|
phone |
Phone number of the addressee |
string |
|
business_name |
Business name of the addressee, if used |
string |
|
street |
Street address |
string |
|
street2 |
Second line of street address, if used |
string |
|
city |
City of the addressee |
string |
|
region |
Region/state of the addressee |
string |
|
country |
Country of the addressee |
string |
|
postal_code |
Postal code of the addressee |
string |
|
shipment_tax_total |
Total amount of tax charged against the shipping amount |
integer |
|
shipment_tax_rates |
Rate of tax charged against the shipping amount |
integer |
|
price |
Amount charged for shipping |
decimal |
|
shipment_total |
Amount charged for shipping including any tax |
integer |
|
charge_taxes_on_shipping |
Whether or not this store charges tax on shipping. Valid values are:
|
boolean |
|
title |
Shipping method used for this box, for example "UPS" or "DHL" |
string |
|
shipment_date |
Date this box was shipped. Returns null if status is not shipped. |
Unix timestamp in GMT |
|
tracking_number |
Shipping provider's tracking number |
integer |
|
status |
Status for this shipment. Valid values are:
|
string |
|
created_date |
Date the shipment was first created |
Unix timestamp in GMT |
|
updated_date |
Date the shipment was last updated |
Unix timestamp in GMT |
|
transactions |
An array of Shipment Transaction objects |
array |
Note: Any fields returned that are not documented are currently unsupported and can be safely ignored.
Retrieve a List of Shipments for an Order
Endpoint URL
Returns all shipments created for this order.
Scope: read:store-orders
Request
Example request:
Response
Example response
Retrieve the Number of Shipments for an Order
Enpoint URL
Returns the number of shipments for an order.
Scope: read:store-orders
Scope: read:store-orders
Request
Example request
Response
Example response
Retrieve Details for an Order Shipment
Enpoint URL
Returns the details for an order shipment.
Scope: read:store-orders
Scope: read:store-orders
Request
Example request
Response
See Fields table. All fields for the order shipment are returned.
Example response