Data Access Order

Endpoints

Get list of orders

/forecast/companies/{companycode}/establishments/{establishmentcode}/start-date/{startDate}/end-date/{endDate}/data-access/orders

Description

Returns orders (conditional on the Data Access offer).

Parameters

Type Name Description Schema

Path

companyCode
required

Current context company code

string

Path

establishmentCode
required

Current context establishment code

string

Path

startDate
required

Start date of shipping date bound

datetime (ISO-8601)

Path

endDate
required

End date of shipping date bound

datetime (ISO-8601)

Query

page
optional

Page index

integer (int32)

Query

size
optional

Entity count per page

integer (int32)

Responses

HTTP Code Description Schema

200

Successfull

< Order > array

400

Functionnal error

No Content

403

Not allowed without Data Access offer

No Content

500

Internal server error

No Content

Produces

  • application/json

Data structure

Order

Order data structure.

Name Description Value

actType
required

Act type (=ORD)

string

amount
optional

Amount

double

canceled
optional

Always false for orders

boolean

chrono
required

Chrono

integer

companyCode
required

Company code

string

creationDate
optional

Creation date

datetime (ISO-8601)

currencyCode
optional

Currency code

string

customerCode
required

Customer code

string

deliveryDate
optional

Delivery date

datetime (ISO-8601)

establishmentCode
required

Establishment code

string

firstQuantity
required

Quantity 1

double

firstUnitCode
required

Unit code 1

string

itemCode
required

Item code

string

nb1
required

Internal number 1

integer

nbOffer
optional

Promotion offer number

integer

orderDate
optional

Order date

datetime (ISO-8601)

planCode
optional

Promotion plan code

string

referenceCode
optional

Promotion reference code

string

secondQuantity
optional

Quantity 2

double

secondUnitCode
optional

Unit code 2

string

shippingDate
required

Shipping date

datetime (ISO-8601)

shippingSiteCode
optional

Shipping site code

string

statUnit1Quantity
optional

Statistical unit 1 quantity

double

statUnit1Code
optional

Statistical unit 1 code

string

suffix
optional

Promotion suffix

string

updateDate
optional

Update date

datetime (ISO-8601)

soldUnderPromotion
optional

True if order is under promotion

boolean