Delivery form

Endpoints

Import entity list

/forecast/companies/{companycode}/establishments/{establishmentcode}/delivery-forms/import

Parameters

Type Name Description Schema

Path

companyCode
required

Current context company code

string

Path

establishmentCode
required

Current context establishment code

string

Body

body
required

Responses

HTTP Code Description Schema

202

Accepted

No Content

400

Functionnal error

No Content

500

Internal server error

No Content

Consumes

  • application/json

Produces

  • application/json

Data structure

DeliveryForm

Delivery Form data structure.

Name Description Value Business rules

canceled
optional

True if deliverey form is canceled

boolean

false by default, true to delete an already sent delivery form

chrono
required

Chrono

integer

companyCode
required

Company code

string

2 characters max

customerCode
required

Customer code

string

10 characters max

deliveredToCode
optional

Delivered to code

string

deliveryDate
optional

Delivery date

datetime (ISO-8601)

YYYY-MM-DDTHH:MM:SSZ

discountAmount1
optional

Discount amount 1

double

Can be negative depending on the nature of discount

discountAmount10
optional

Discount amount 10

double

Can be negative depending on the nature of discount

discountAmount2
optional

Discount amount 2

double

Can be negative depending on the nature of discount

discountAmount3
optional

Discount amount 3

double

Can be negative depending on the nature of discount

discountAmount4
optional

Discount amount 4

double

Can be negative depending on the nature of discount

discountAmount5
optional

Discount amount 5

double

Can be negative depending on the nature of discount

discountAmount6
optional

Discount amount 6

double

Can be negative depending on the nature of discount

discountAmount7
optional

Discount amount 7

double

Can be negative depending on the nature of discount

discountAmount8
optional

Discount amount 8

double

Can be negative depending on the nature of discount

discountAmount9
optional

Discount amount 9

double

Can be negative depending on the nature of discount

establishmentCode
required

Establishment code

string

2 characters max

firstOrderQuantity
optional

Order quantity 1

double

firstOrderUnitCode
optional

Order unit code 1

string

5 characters max

firstQuantity
required

Quantity 1

double

firstUnitCode
required

Unit code 1

string

5 characters max

grossAmount
optional

Gross amount

double

Is negative in case of adjustment

itemCode
required

Item code

string

20 characters max

nb1
required

Internal number 1

integer

orderChrono
optional

Order chrono

integer

orderDate
optional

Order date

datetime (ISO-8601)

YYYY-MM-DDTHH:MM:SSZ

orderNb1
optional

Order internal number 1

integer

quantityAdjustment
optional

True if deliverey form is a quantity adjustment

boolean

false by default, true for quantity adjustments

secondOrderQuantity
optional

Order quantity 2

double

secondOrderUnitCode
optional

Order unit code 2

string

5 characters max

secondQuantity
optional

Quantity 2

double

secondUnitCode
optional

Unit code 2

string

5 characters max

shippingDate
required

Shipping date

datetime (ISO-8601)

YYYY-MM-DDTHH:MM:SSZ

shippingSiteCode
optional

Shipping site code

string

10 characters max

thirdQuantity
optional

Quantity 3

double

thirdUnitCode
optional

Unit code 3

string

5 characters max

soldUnderPromotion
optional

True if delivery form is under promotion

boolean

if true or false, the flag is forced (not re-evaluated by treatment)

ImportDeliveryFormList

Name Value

callback
optional

string

data
optional