Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Properties

Optional AvailabilityDate

AvailabilityDate: undefined | false | true

Include the expected date on which the provided products can be picked-up from a shop.

Optional InArea

InArea: PickupArea

Select the organizations that are considered for pickup based on a rectangular area defined by the top-left and bottom-right co-ordinates.

Optional InRadius

InRadius: PickupRadius

Select the organizations that are considered for pickup based on a circular area defined by the center co-ordinate and a radius (specified in km).

Optional IncludeOrganizationUnitsWithoutStock

IncludeOrganizationUnitsWithoutStock: undefined | false | true

If specified as true then all relevant pick-up OrganizationUnits are returned, whether they have available stock or not.

Defaults to false and only has effect if IncludePickupOrganizationUnits is set to true.

Optional IncludePickupOrganizationUnits

IncludePickupOrganizationUnits: undefined | false | true

If specified as true the response will contain the pickup organizations. Which organizations are included depends on the rest of the request:

  • If a rectangular area is specified through InArea it will contain the organizations within the area.
  • If the radius is specified through InRadius it will contain the organizations within the radius of the given center co-ordinates.
  • If an explicit list of organizations is specified through OrganizationUnitIDs then those are returned.

In all cases, whether or not all of them are returned or only those that contain stock is determined by IncludeOrganizationUnitsWithoutStock. By default only organizations with stock are returned.

If the request specifies more than one product, the organization will only be returned if all products have stock (unless IncludeOrganizationUnitsWithoutStock is true).

Optional OpeningHoursType

When the pickup organizations are returned, this determines what returned opening-hours are returned. See each value of the enum for details.

Optional OrganizationUnitIDs

OrganizationUnitIDs: number[]

This can be optionally used to provide a list of shops for which you would like to check pick-up availability. Entity type: OrganizationUnit

Optional OrganizationUnitType

OrganizationUnitType: OrganizationUnitTypes

Optional Type

This field lets you specify whether the pickup availability date you get back (in case you requested it) for each product should be based on your current OrganizationUnit, or whether it should be the OrganizationUnit that has the earliest availability for the product. Defaults to FastestShop.