Skip to main content
Shipping

Shipping object schema for shipping revenue, costs, address, tax and shipping discount info

Frank Birzle avatar
Written by Frank Birzle
Updated over 10 months ago

city

Type: string

Description: City the order was shipped to.

Example Value(s): 'Munich' or 'Berlin'

provinceOrState

Type: string

Description: The provice or state the order was shipped to.

Example Value(s): 'Bayern' or 'Berlin'

countryCodeIso3Letter

Type: string

Description: Country code of the country the order was shipped to according to ISO 3166-1 alpha-3 standard.

Example Value(s): 'DEU' (Germany) or 'CHE' (Switzerland)

countryCodeIso2Letter

Type: string

Description: Country code of the country the order was shipped to according to ISO 3166-1 alpha-2 standard.

Example Value(s): 'DE' (Germany) or 'CH' (Switzerland)

currencyCodeIso3Letter

Type: string

Description: Currency code of the currency the order was paid for according to ISO 4217 alpha-3 standard.

Example Value(s): 'EUR' (Euro, €) or 'CHF' (Swiss Franc, CHF)

zipOrPostalCode

Type: string

Description: Postal code or ZIP code of the location the order was shipped to.

Example Value(s): '10557' (postal code in Berlin) or '8001' (postal code in Zurich)

providerDescriptor

Type: string

Description: Shipping provider used to deliver the parcel(s).

Example Value(s): 'DHL' or 'UPS'

shippingTotalAmountBeforeTaxAndDiscounts

Type: number

Description: The shipping revenue (amount the customer paid for this order) before taxes or discounts were deducted.

Example Value(s): 2.50 or 4.99

discounts

Type: [Discount]

Description: An array of Discount objects applied to the shipping.

Example Value(s): See Discount.

taxes

Type: [Tax]

Description: An array of Tax objects applied to the Shipping object.

Example Value(s): See Tax.

shippingTotalAmountAfterTaxAndDiscounts

Type: number

Description: The shipping revenue (amount the customer paid for this order) after taxes and discounts have been deducted.

Example Value(s): 1.10 or 3.13

totalLogisticsCosts

Type: number

Description: The costs the merchant paid for shipping this order (e.g. costs for DHL etc.) excluding tax.

Example Value(s): 1.10 or 3.13

Did this answer your question?