Delivery form
Endpoints
Import entity list
/forecast/companies/{companycode}/establishments/{establishmentcode}/delivery-forms/import |
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
companyCode |
Current context company code |
string |
Path |
establishmentCode |
Current context establishment code |
string |
Body |
body |
Data structure
DeliveryForm
Delivery Form data structure.
Name | Description | Value | Business rules |
---|---|---|---|
canceled |
True if deliverey form is canceled |
boolean |
false by default, true to delete an already sent delivery form |
chrono |
Chrono |
integer |
|
companyCode |
Company code |
string |
2 characters max |
customerCode |
Customer code |
string |
10 characters max |
deliveredToCode |
Delivered to code |
string |
|
deliveryDate |
Delivery date |
datetime (ISO-8601) |
YYYY-MM-DDTHH:MM:SSZ |
discountAmount1 |
Discount amount 1 |
double |
Can be negative depending on the nature of discount |
discountAmount10 |
Discount amount 10 |
double |
Can be negative depending on the nature of discount |
discountAmount2 |
Discount amount 2 |
double |
Can be negative depending on the nature of discount |
discountAmount3 |
Discount amount 3 |
double |
Can be negative depending on the nature of discount |
discountAmount4 |
Discount amount 4 |
double |
Can be negative depending on the nature of discount |
discountAmount5 |
Discount amount 5 |
double |
Can be negative depending on the nature of discount |
discountAmount6 |
Discount amount 6 |
double |
Can be negative depending on the nature of discount |
discountAmount7 |
Discount amount 7 |
double |
Can be negative depending on the nature of discount |
discountAmount8 |
Discount amount 8 |
double |
Can be negative depending on the nature of discount |
discountAmount9 |
Discount amount 9 |
double |
Can be negative depending on the nature of discount |
establishmentCode |
Establishment code |
string |
2 characters max |
firstOrderQuantity |
Order quantity 1 |
double |
|
firstOrderUnitCode |
Order unit code 1 |
string |
5 characters max |
firstQuantity |
Quantity 1 |
double |
|
firstUnitCode |
Unit code 1 |
string |
5 characters max |
grossAmount |
Gross amount |
double |
Is negative in case of adjustment |
itemCode |
Item code |
string |
20 characters max |
nb1 |
Internal number 1 |
integer |
|
orderChrono |
Order chrono |
integer |
|
orderDate |
Order date |
datetime (ISO-8601) |
YYYY-MM-DDTHH:MM:SSZ |
orderNb1 |
Order internal number 1 |
integer |
|
quantityAdjustment |
True if deliverey form is a quantity adjustment |
boolean |
false by default, true for quantity adjustments |
secondOrderQuantity |
Order quantity 2 |
double |
|
secondOrderUnitCode |
Order unit code 2 |
string |
5 characters max |
secondQuantity |
Quantity 2 |
double |
|
secondUnitCode |
Unit code 2 |
string |
5 characters max |
shippingDate |
Shipping date |
datetime (ISO-8601) |
YYYY-MM-DDTHH:MM:SSZ |
shippingSiteCode |
Shipping site code |
string |
10 characters max |
thirdQuantity |
Quantity 3 |
double |
|
thirdUnitCode |
Unit code 3 |
string |
5 characters max |
soldUnderPromotion |
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 |
string |
data |
DeliveryForm list |