- Previous: Goods Receipt Confirmations
- Up: Logistics Operators
- Next: Transfer Posting
Delivery Orders
This api is consumed by a logistics operator to notify to Campari that products are picked or dispatched.
#### Request URI
#### Request Structure
#### Request Example
#### Response Example
#### Response Table:
API field | Type | Mandatory | Description | Technical Details |
header |
||||
businessId |
String | Y | Campari Document Number - in case of PickingConfirmation we have the delivery number | Max lenght: 10 |
flow |
String | Y | Name of the business flow. | Fixed value: "PickingConfirmation" |
correlationId |
String | Y | Transactional identification for a specific flow. | The value should be shared across all documents of a specific transaction (read document, picking, dispatch for DO) |
companyType |
String | Y | Type of company sending the document | Default value for third party logistic operators: "3PL" |
transactionCompany |
String | Y | Logistic Operator plant |
|
transactionId |
String | Y | Unique identifier of the transaction. | This has to be different on every transaction |
site |
String | Y | This value represents the position, location or place from where the products were requested | Default value: "CP" |
depositor |
String | N | This value is the Depositor name. I.e., the entity which deposited the order | Default value: "Campari" |
transactionTimeZone |
String | Y | Time zone used in Date/DateTime type fields | E.g. "CST" or "UTC" |
transactionDateTime |
DateTime | Y | Date and Time when the actual document is generated | Format: YYYY-MM-DDThh:mm:ss |
doNumber |
Sting | Y | Unique reference that identifies the delivery order | Max lenght: 10 |
doId |
String | Y | Unique identifier for the delivery order (see doNumber ) |
Max lenght: 10 |
customerDoNumber |
String | N | Document number of the customer | |
invoiceCustomerCode |
String | N | This reference could be any ID/code relevant for customer to identify a given order. | |
shipToCustomerCode |
String | N | If available, use the ship-to customer code | Max lenght: 10 |
header/partners (0..∞) |
||||
partnerCode |
String | N | Represents the code of the partner | Example "SP" |
partnerNumber |
String | N | Represents the number of the partner | Example "1000081919" |
header/additional (0..∞) |
||||
key |
String | N | Represents the name of the additional information to be sent. This value can be agreed. | Example "reference01", "reference02" or "comment01" |
value |
String | N | Represents the value of the additional information related to the specific key | |
lineItem (1..∞) |
||||
lineId |
Integer | Y | Unique identifier for a line item. It can be progressive or not. | E.g. First Line "1", Second Line "2" |
itemCode |
String | Y | Code of the item | Max lenght: 18 |
storageLocation |
String | Y | Location of the storage. | Example: "1001" |
unitOfMeasure |
String | Y | Value that identifies the unit of measure. | Possible values: "CS" (cases) or "BOT" (bottles) |
quantity |
Integer | Y | Picked or Dispatched quantity. | Value reported in "unitOfMeasure" |
orderLineNumber |
String | Y | This value is the line number to identify a unique detail line in the Delivery order (DO) | Max lenght: 6 |
manufactureDate |
Date | N | Manufacture date | Format: YYYY-MM-DD |
retentionDate |
Date | N | Retention Date | Format: YYYY-MM-DD |
expirationDate |
Date | N | Shelf Life Expiration or Best-Before Date | Format: YYYY-MM-DD |
palletNumber |
String | N | Number of the pallet | |
symbolicCode |
String | N | Value of the symbolic Code | |
stockNature |
String | N | Status or Nature of the Product | Default value: "AV" (Available) |
reservationCode |
String | N | Value of the reservation Code |
|
itemPrice |
Decimal | N | Price of the item | |
containerQuantity |
Integer | N | Quantity included if the customer manage any container different than pieces (eaches) | |
containerUnitCode |
String | N | Measure Unit for container quantity. | |
lineItem/additional (0..∞) |
||||
key |
String | N | Represents the name of the additional information to be sent. | E.g. "reference01", "reference02" or "comment01" |
value |
String | N | Represents the value of the additional information related to the specific key | |
lineItem/serial (0..∞) |
||||
serialNumber |
String | N | Number of the serial | |
lineItem/serial/additional (0..∞) |
||||
key |
String | N | Represents the name of the additional information, related to the lineItem serial, to be sent. | E.g. "reference01", "reference02" or "comment01" |
value |
String | N | Represents the value of the additional information related to the specific key | |
lineItem/lot (0..∞) |
||||
lotNumber |
String | Y | Batch number. | If batches are not managed, use fixed value "9999999999" |
lineItem/lot/additional (0..∞) |
||||
key |
String | N | Represents the name of the additional information, related to the lineItem serial, to be sent. | E.g. "reference01", "reference02" or "comment01" |
value |
String | N | Represents the value of the additional information related to the specific key | |
lineItem/lpn (0..∞) |
||||
lpnNumber |
String | N | Number of the lpn | |
lineItem/lpn/additional (0..∞) |
||||
key |
String | N | Represents the name of the additional information, related to the lineItem serial, to be sent. | E.g. "reference01", "reference02" or "comment01" |
value |
String | N | Represents the value of the additional information related to the specific key |
#### Response Structure
API field | Type | Description | Technical Details |
ResponseType (0..∞) |
|||
status |
String | Status of the processed request | Possible value: "success" or "error" |
message |
String | This field is provided in case of error status and represents a description of the error | |
DeliveryNoteNumber |
String | This field is provided when a delivery note number is found for partners fields provided. |
Status | Message | Description |
success | In case of request processed successfully | |
error | Error on internal Campari’s system - SAP | In case of error while connecting to SAP |
error | Item not processed | The following message refers to a general error during the processing |
error | Technical error | The following message refers to a general error during the processing |
error | Goods issue has already been posted for delivery | In case the goods have already been created on SAP |
error | AsnNumber field more than 10 characters | In case the "asnNumber" field in the request is more than 10 characters |
- Previous: Goods Receipt Confirmations
- Up: Logistics Operators
- Next: Transfer Posting
0 Comments
Please sign in to post a comment.