Skip to main content

Shipping Request Fields

These fields can be used to store details about the shipping method and costs.

Field NameMandatory?Description/Value
shippingTrackingRefNoShipping tracking reference.
shippingMethodNoShipping method (eg Courier, Post, etc).
shippingAmountNoCost of shipping.
shippingGrossAmountNoGross cost of shipping.
shippingNetAmountNoNet cost of shipping.
shippingTaxRateNoTax rate as percentage to 2 decimal places.
shippingTaxAmountNoTax cost of shipping.
shippingTaxReasonNoTax reason (eg VAT).
shippingDiscountAmountNoDiscount on shipping.
shippingDiscountReasonNoReason for discount.
info

No attempt is made to check that any gross, net and tax amounts are correct with respect to each other. It is the sender’s responsibility to ensure alternative amount formats are correct.