Retail Order

Retail Orders transfer one to many orders to Time Slot Management for Retailers.

Attribute

Description

Type

Mandatory

Attribute

Description

Type

Mandatory

retail_orders_data

One to many orders

List of Retail Order Data

True


Retail Order Data contain the order data for a single order.

Attribute

Description

Type

Mandatory

Attribute

Description

Type

Mandatory

order_identifier

Unique order identifier, needs to be provided by the retailer

String

True

order_container_identifier

Reserved for future use, don't use

-

-

status

Indicates whether to import or cancel an order

Status

  • N: Import / Update

  • D: Delete / Cancel

See description

True

version

Version of order

String

For status = N

order_numbers

List of order numbers

String

For status = N

warehouse_name

Warehouse name

String

For status = N

routing

Enclosing element for order routing details

 

For status = N

routing/gate_selector

Indicates the target gate for the order

 

For status = N

routing/gate_selector/primary

Primary criterion for gate selection

String

For status = N

routing/gate_selector/secondary

Secondary criterion for gate selection

String

For status = N

supplier

Supplier information

 

For status = N

supplier/id

Supplier identifier

String

For status = N

supplier/name

Supplier name

String

For status = N

delivery_period

Datetime information

 

For status = N

delivery_period/from

Delivery period from

ISO 8601 Timestamp

For status = N

delivery_period/to

Delivery period to

ISO 8601 Timestamp

For status = N

delivery_period/preferred

Preferred delivery date

ISO 8601 Date

For status = N

order_options

Options related to the order

 

False

order_options/activated_order_deletion_locked

Allow to delete activated orders

Boolean

False

order_options/max_number_of_activations

Maximum number of allowed order activations

Integer

False

parameters

List of parameter DTOs, that enclose additional data of the order. See Parameter.

 

False

Â