1 Shipment element
1.1 Elements
| Name | Type | Datatype | Example | Default | Description |
|---|
| ShipmentProvider
| required
| string
| UPS
| -
| The selected Shipment Tariff. Currently only UPS shipment is supported for the API.
|
| ShipmentTariff
| required
| string
| Standard; ExpressSaver
| -
| The selected Shipment Tariff.
|
| ShipTo
| required
| element
| -
| -
| The destination address used for shipment. For shipping cost calculation only the Country element is required.
|
| ShipFrom
| optional
| element
| -
| -
| The source address used for shipment. Required for neutral shipment.
|
1.2 Example
XML:
<Shipment>
<ShipTo>
<Country>US</Country>
</ShipTo>
</Shipment>
JSON:
"Shipment": {
"ShipTo": {
"Country": "US",
}
}
1.3 Additional response elements
| Name | Type | Datatype | Example | Default | Description |
|---|
| ShipmentTariffs
| optional
| element
| -
| -
| List of available shipment tariffs for the current article configuration.
|
| NetPackageWeight
| optional
| float
| -
| -
| Approximate shipping weight calculated using the dimensions and paper grammage. This is a rough estimation on the actual shipping weight based on the amount of paper that will be used of printing.
|
1.3.1 Example
XML
<Shipment>
<ShipmentTariffs>
<ShipmentTariff>
<Provider>UPS</Provider>
<Tariff>Standard</Tariff>
<Name>UPS Standard</Name>
</ShipmentTariff>
</ShipmentTariffs>
</Shipment>
JSON
"Shipment": {
"ShipmentTariffs": [
{
"Provider": "UPS",
"Tariff": "Standard",
"Name": "UPS Standard"
},
]
}