Data Access Delivery form

Endpoints

Get list of delivery forms

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

Description

Returns delivery forms (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

< ExportDeliveryForm > array

400

Functionnal error

No Content

403

Not allowed without Data Access offer

No Content

500

Internal server error

No Content

Produces

Data structure

ExportDeliveryForm

Export Delivery Form data structure.

Name Description Value

actType
required

Act type (=DEL)

string

amount
optional

Amount

double

canceled
optional

True if deliverey form is canceled

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

firstOrderQuantity
optional

Order quantity 1

double

firstOrderUnitCode
optional

Order unit code 1

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

orderChrono
optional

Order chrono

integer

orderDate
optional

Order date

datetime (ISO-8601)

orderNb1
optional

Order internal number 1

integer

planCode
optional

Promotion plan code

string

quantityAdjustment
optional

True if deliverey form is a quantity adjustment

boolean

referenceCode
optional

Promotion reference code

string

secondOrderQuantity
optional

Order quantity 2

double

secondOrderUnitCode
optional

Order unit code 2

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

statUnit1OrderQuantity
optional

Statistical unit 1 order quantity

double

statUnit1Quantity
optional

Statistical unit 1 quantity

double

statUnit1Code
optional

Statistical unit 1 code

string

suffix
optional

Promotion suffix

string

thirdQuantity
optional

Quantity 3

double

thirdUnitCode
optional

Unit code 3

string

updateDate
optional

Update date

datetime (ISO-8601)

soldUnderPromotion
optional

True if delivery form is under promotion

boolean