Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PaazlGetShippingOptionsForOrder

Returns a list of the available shipping options configured in Paazl, taking an OrderID. The related order needs to have a Shipping Address set. The parameter ExtendedDeliveryDateDetails toggles the Period value contents of the DeliveryDateDetails property in the response.

This data should be presented to the user, so that a choice can be made between the available options. When the option represents a "pick-up point", the user should additionally be able to select the desired address for delivery, of which the available options are also included in above return data.

Optionally, supply a ZipCode and CountryID to deviate from specified orders' Shipping Address (eg. to support dynamic pickup points). Note that you'll have to supply the same inputs to PaazlUpdateShippingOptionsForOrder if you want to use this feature!

:watch: Any Day mentioned is a date without time, and so it's timezone is irrelevant. Any From and Till time is in local time to the receipient or pick-up point, and needs to be presented to the user and saved with the PaazlUpdateShippingOptionsForOrder without any timezone conversion.

Hierarchy

  • PaazlGetShippingOptionsForOrder

Index

Properties

Optional CountryID

CountryID: undefined | string

Entity type: Country

Optional ExtendedDeliveryDateDetails

ExtendedDeliveryDateDetails: undefined | false | true
default

false

OrderID

OrderID: number

Entity type: Order

Optional ShowUnavailable

ShowUnavailable: undefined | false | true

Optional ZipCode

ZipCode: undefined | string