Order Shipment Transactions API
Shipment transactions happen when the status of the shipment changes. For example, when a shipment goes from label_created to shipped, a transaction occurs.
Use the Order Shipment Transactions API to retrieve the shipment transactions for an order.
Use the Order Shipment Transactions API to retrieve the shipment transactions 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 |
integer |
X |
order_shipment_ transaction_id |
An incrementing id unique to the shipment. |
integer |
X |
tx_id |
ID for this transaction |
string |
|
tx_type |
Shipping method (as defined by the merchant) used for this transaction, for example UPS |
string |
|
tx_date |
Date the transaction was created |
Unix timestamp in GMT |
|
tx_status |
Status for this transaction. Valid values are:
|
string |
|
created_date |
Date the transaction was first created |
Unix timestamp in GMT |
|
updated_date |
Date the transaction was last updated |
Unix timestamp in GMT |
Note: Any fields returned that are not documented are currently unsupported and can be safely ignored.
Retrieve a List of Transactions for a Shipment
Endpoint URL
Returns all transactions for this shipment.
Scope: read:store-orders
Request
Example request
Response
Example response
Retrieve the Number of Transactions for an Order Shipment
Enpoint URL
Returns the number of transactions for an order shipment.
Scope: read:store-orders
Scope: read:store-orders
Request
Example request
Response
Example response
Retrieve Details for an Order Transaction
Enpoint URL
Returns the details for an order shipment transaction.
Scope: read:store-orders
Scope: read:store-orders
Request
Example request
Response
See Fields table. All fields for the transaction are returned.
Example response