• Register

Inventory report

This api is consumed by a logistics operator to notify to Campari a snapshot of the current stock. #### Request URI

#### Request Structure
API field Type Mandatory Description Technical Details
header
businessId String N Business key of the transaction type
customerNumber String N Customer number
flow String Y Name of the business flow. Default value: "InventoryReport"
correlationId String Y Transactional identification for a specific flow. The value should be shared across all documents of a specific transaction.
companyType String Y Logistic Operator plant Default value for third party logistic operators: "3PL"
transactionCompany String Y Name of the sender company. It is a value that represents the company. Therefore, it can be agreed.
depositor String Y Name of the deposit Default value: "Campari"
doId String N Additional id of the document
shipToCustomerCode String N Customer number or code to identify the final customer Max lenght: 10
site String N Name of the destination site Default value: "CP"
transactionId String Y Unique identifier of the transaction. This has to be different on every transaction
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
transactionPartner String Y Partner's identifier Max lenght: 3
partnerNumber String Y Partner's code Max lenght: 10
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
stock (1..∞)
site String N Name of the destination site Default value: "CP"
depositor String N Name of the deposit Default value: "Campari"
itemCode String Y SKU or ItemCode used by the Buyer to identify the product. Max lenght: 18
quantityUnits Integer Y Available units quantity Value reported in "unitOfMeasure"
unitOfMeasure String Y Unit of measure Possible values: "CS" (cases) or "BOT" (bottles)
fifoDate Date N Accepted date format yyyy-MM-dd Format: YYYY-MM-DD
stockNature String Y Status or Nature of the Product. Default value: "AV"
storageLocation String Y Location of the storage. Example: "1001"
statusCode String Y Status Code. Possible values: UNR = Unrestricted Stock; CTQ = Stock in Quality Control; BLK = Blocked Stock
expirationDate Date N Shelf Life Expiration or Best-Before Date Format YYYY-MM-DD
supplierCode String N Unique code that identifies the supplier Max lenght: 10
palletId String N Pallet Identifier
relatedPalletId String N Logistics Operators Internal Object Number.
stock/additional (0..∞)
key String N Represents the name of the additional information to be sent. Example "reference01", "reference02" or "comment01"
value String N Represents the value of the additional information related to the specific key
stock/lpn (0..∞)
lpnNumber String N Number of the lpn
stock/lpn/additional (0..∞)
key String N Represents the name of the additional information, related to the lineItem serial, to be sent. Example "reference01", "reference02" or "comment01"
value String N Represents the value of the additional information related to the specific key
stock/lot (0..∞)
lotNumber String Y Number of the lot
stock/lot/additional (0..∞)
key String N Represents the name of the additional information, related to the lineItem serial, to be sent. Example "reference01", "reference02" or "comment01"
value String N Represents the value of the additional information related to the specific key
#### Request Example

#### Response Structure
API field Type Description
ResponseType (0..∞)
status String Possible value are “success”, “error”
message String This field is provided in case of error status and represents a description of the error
#### Response Example

#### Response Table:
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 Technical error The following message refers to a general error during the processing

version 54 as of 2 years ago by Campari Jenkins

0 Comments

Please sign in to post a comment.

Docs Navigation