What Are Shipping and Address Structures?
The list of shipments produced by the Splitter component contains several nested structures.
The Splitter component in the shipping configuration assigns the list of shipments to the Shipments object. The ShippingMethodRouter component breaks this list down into a list of shipments_to_process for each component run. The list of shipments is a SimpleList object of dictionaries, one for each shipment.
The following table shows a sample of the keys in the shipment dictionaries.
Property Name |
Dictionary Key |
Description |
|---|---|---|
ShipmentID |
shipment_id |
The ID for the shipment. |
ShippingAddressID |
shipping_address_id |
The ID in the Address dictionary of the dictionary that contains the address information. |
ShippingMethodID |
shipping_method_id |
The shipping method ID, taken from the ShippingMethod database table. |
ShipmentTrackingNumber |
shipment_tracking_number |
Tracking number for the shipment. |
ShipmentTotal |
_cy_shipment_total |
The total shipping cost for the items in this shipment. |
LineItemIndexes |
ItemIndexes |
A SimpleList object of indexes to the line items in the order. |
ShippingDiscounts |
_shipping_discounts_applied |
A SimpleList object that lists all shipping discounts that have been applied to this shipment. |
Each address dictionary contains the following keys.
Property Name |
Dictionary Key |
Description |
|---|---|---|
OrderAddressID |
address_id |
Descriptive name for the address. |
Name |
name |
Full name of the addressee. |
FirstName |
first_name |
First name of the addressee. |
LastName |
last_name |
Last name of the addressee. |
Line1 |
addr_line1_text |
First line of the address. |
Line2 |
addr_line2_text |
Second line of the address. |
City |
city_name |
City name. |
State |
state |
Name of the state. |
CountryCode |
country_code |
Country/region code. |
CountryName |
country_name |
Country/region name. |
PostalCode |
postal_code |
Postal code. |
RegionName |
region_name |
Name of the state, region, or province. |
RegionCode |
region_code |
Code for the state, region, or province. |
DaytimePhoneNumber |
day_time_phone_number |
Daytime telephone number of the addressee. |
EveningPhoneNumber |
evening_phone_number |
Evening telephone number of the addressee. |
E-mail address of the addressee. |
||
OrderGroupID |
order_group_id |
Primary identifier for objects in the orders system. |