Shipping Method and Shipment

Overview

Below is a list of all the available drops on the Shipping Method object


 

Shipping Method

Name Description
id WM3 identifier
name Name of the shipping method
presentation Presentation of the shipping method
price Cost for the order
is_default Boolean. Is the shipping method set as default?
is_default? Boolean. Is the shipping method set as default?
 

 

Shipping Option

Below is a list of all the available drops on the Shipping Option object


Name Description
id Shipping method WM3 identifier
name Shipping method nmae
presentation Shipping method presentation
price Shipping cost for the order
is_default Default shipping method?
is_default? Default shipping method?
amount Same as price since there is only 1 ship cost per order
pre_tax_amount Returns the amount without taxes (excluding)
included_tax_total Returns the amount with taxes (including)
additional_tax_total Returns the amount with additional taxes
shipping_method_id The shipping method id
free_shipping_threshold Free shipping threshold
free_shipping_minimum Minimum item total required for free shipping
free_shipping_remaining_amount Remaining amount to achieve free shipping
free_shipping_amount_left Amount left to achieve free shipping


 

Shipment

Below is a list of all the available drops on the Shipment object


Name Description
id The id of the shipment
state The state of the shipment
number Shipment number in the webshop
shipping_method ShippingMethodDrop
tracking_number The tracking number of the shipment
tracking_url The URL for tracking the shipment
shipment_items Array <ShipmentItemDrop>
 

 

Shipment Item

Below is a list of all the available drops on the Shipment Item object


Name Description
id ID of the shipping item
state State of the shipping item
quantity The quantity of the shipping item
order_item OrderItemDrop
 

 

Shipping Category

Below is a list of all the available drops on the <insert name here> object


Name Description
id Shipping category WM3 identifier
name Shipping category name
presentation Shipping category localised presentation
is_default Boolean. Default shipping category?
is_default? Same is is_default

 

Updated: 2020-11-17