Call Off

This api is consumed by a logistics operator to create or modify a PurchaseOrder document into Campari ERP system. The API can be used for the following scenarios:

Scenario	Description	SAP Order Type	Action
1	Purchase Order of Components with reference to an Outline agreement (Contract)	Z120	Creation; Modification
2	Purchase Order of Components without reference to an Outline agreement (Contract)	Z100	Creation; Modification
3	Stock Transfer Order of semi-finished Liquid	Z310	Creation
4	Subcontracting Purchase Order with reference to an Outline agreement (Contract)	Z120	Creation; Modification

## CallOff - Creation #### Request URI

#### Request Structure

API field	Type	Mandatory	Description	Technical Details
`header`
`transactionCompany`	String	Y	Logistic Operator plant
`transactionId`	String	Y	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 time of the transaction	Format: YYYY-MM-DDThh:mm:ss
`flow`	String	Y	Name of the business flow.	Fixed value: "CallOff"
`correlationId`	String	Y	Transactional identification for a specific flow.	The value should be shared across all documents of a specific transaction.
`companyType`	String	Y	Receiver operator typology. It is a value that represents the company. Therefore, it can be agreed.	Default value for third party logistic operators: "3PL"
`site`	String	Y	Name of the destination site	Default value: "CP"
`depositor`	String	N	Name of the deposit	Default value: "Campari"
`doNumber`	Sting	Y	Document number that identifies the Campari partner's document	Max lenght: 10
`supplierPlant`	Sting	N	Pupplier Plant
`companyCode`	Sting	N	Company code
`purchaseOrganization`	Sting	N	Purchase Organization
`purchaseGroup`	Sting	N	Purchase Group
`documentDate`	Date	N	Date of the document	Format: YYYY-MM-DD
`supplierCode`	String	N	Unique code that identifies the supplier	Max lenght: 10
`documentType`	String	N	Document type
`deliveryDateTime`	DateTime	Y	Delivery Date and time	Format YYYY-MM-DDTHH:mm:ss
`lineItem (1..∞)`
`lineId`	Integer	Y	Identifier of the line item. This field must be unique for each item	E.g. First Line "10", Second Line "20"
`itemCode`	String	Y	Code of the line Item	Max lenght: 18
`contractNumber`	Sting	N	Unique reference that identifies the Outline agreement (Contract)	Max lenght: 10
`contractLineNumber`	String	N	Unique reference that identifies the line item in the Outline agreement (Contract)	E.g. First Line "10", Second Line "20"
`plant`	String	N	Plant of logistics operator.	Fixed value. This value can be agreed
`netPrice`	Decimal	N	Net price.
`priceUnit`	Decimal	N	Price unit.
`storageLocation`	String	N	Location of the storage.	Example: "1001"
`quantity`	Integer	Y	Quantity of the material identified by the itemCode field.
`unitOfMeasure`	Integer	N	Unit of measure applied to the quantity.	Possible values: "CS" (cases) or "BOT" (bottles).
`itemText(1..∞)`
`textId`	String	N	Text Id.
`textLine`	String	N	Text.

#### Request Example

{ "header": { "transactionCompany": "IT1L", "transactionId": "00001", "transactionTimeZone": "UTC-5", "transactionDateTime": "2023-01-01T00:00:00.001", "flow": "CallOff", "correlationId": "00001", "companyType": "CP", "site": "CP", "depositor": "Campari", "doNumber": "1234567890", "documentDate": "2023-01-24", "supplierCode": "1000004440", "deliveryDateTime": "2023-01-01T00:00:00.001" }, "lineItem": [ { "lineId": "00010", "itemCode": "000000000000230233", "contractNumber": "6500001429", "contractLineNumber": "00010", "plant": "IT1L", "storageLocation": "0002", "unitOfMeasure": "BOT", "quantity": 200, "itemText": { "textId": "F01", "textLine": "Text related to item lineId 00010" } } ] }

#### Response Structure

API field	Type	Mandatory	Description
`ResponseType (0..∞)`
`Status`	String	Y	Possible value are "Success" or "Error"
`Message`	String	Y	In case of error, this field provides a description of the error. Otherwise it notifies a successful transaction.
`documentNumber`	String	N	In case of Success, the SAP identifier of the newly-created document is returned in respose. In case of error, this field is not returned.

#### Response Example

 {
    "ResponseType": [{
            "Status": "Success",
            "Message": "Document created successfully",
            "documentNumber": "1234567890"
        }
    ]
}

## CallOff - Modification #### Request URI

Path Parameter	Type	Mandatory	Description
`id`	String	Y	Document number that identifies Campari's document (this is the same value of the "documentNumber" field returned by the CallOf Creation API)

#### Request Structure

API field	Type	Mandatory	Description	Technical Details
`header`
`transactionCompany`	String	Y	Logistic Operator plant
`transactionId`	String	Y	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 time of the transaction	Format: YYYY-MM-DDThh:mm:ss
`flow`	String	Y	Name of the business flow.	Fixed value: "CallOff"
`correlationId`	String	Y	Transactional identification for a specific flow.	The value should be shared across all documents of a specific transaction.
`companyType`	String	Y	Receiver operator typology. It is a value that represents the company. Therefore, it can be agreed.	Default value for third party logistic operators: "3PL"
`site`	String	Y	Name of the destination site	Default value: "CP"
`depositor`	String	N	Name of the deposit	Default value: "Campari"
`doNumber`	Sting	Y	Document number that identifies the Campari partner's document	Max lenght: 10
`documentDate`	Date	N	Date of the document	Format: YYYY-MM-DD
`supplierCode`	String	N	Unique code that identifies the supplier	Max lenght: 10
`deliveryDateTime`	DateTime	Y	Delivery Date and time	Format YYYY-MM-DDTHH:mm:ss
`lineItem (1..∞)`
`lineId`	Integer	Y	Identifier of the line item. This field must be unique for each item	E.g. First Line "10", Second Line "20"
`itemCode`	String	Y	Code of the line Item	Max lenght: 18
`deletionIndicator`	String	Y	Indicator that the whole line item has been deleted	Possible values: blank - item not deleted; "L" - item deleted
`contractNumber`	Sting	N	Unique reference that identifies the Outline agreement (Contract)	Max lenght: 10
`contractLineNumber`	String	N	Unique reference that identifies the line item in the Outline agreement (Contract)	E.g. First Line "10", Second Line "20"
`plant`	String	N	Plant of logistics operator.	Fixed value. This value can be agreed
`storageLocation`	String	N	Location of the storage.	Example: "1001"
`quantity`	Integer	Y	Quantity of the material identified by the itemCode field.
`unitOfMeasure`	Integer	N	Unit of measure applied to the quantity.	Possible values: "CS" (cases) or "BOT" (bottles).

#### Request Example

{ "header": { "transactionCompany": "IT1L", "transactionId": "00001", "transactionTimeZone": "UTC-5", "transactionDateTime": "2023-01-01T00:00:00.001", "flow": "CallOff", "correlationId": "00001", "companyType": "CP", "site": "CP", "depositor": "Campari", "doNumber": "1234567890", "documentDate": "2023-01-24", "supplierCode": "1000004440", "deliveryDateTime": "2023-01-01T00:00:00.001" }, "lineItem": [{ "lineId": "00010", "itemCode": "000000000000230233", "deletionIndicator": "", "contractNumber": "6500001429", "contractLineNumber": "00010", "plant": "IT1L", "storageLocation": "0002", "quantity": 200, "unitOfMeasure": "BOT" } ] }

#### Response Structure

API field	Type	Mandatory	Description
`ResponseType (0..∞)`
`Status`	String	Y	Possible value are "Success" or "Error"
`Message`	String	Y	In case of error, this field provides a description of the error. Otherwise it notifies a successful transaction.

#### Response Example

 {
    "ResponseType": [{
            "Status": "Success",
            "Message": "Document updated successfully"
        }
    ]
}

version 57 as of 8 months ago by Campari Jenkins

0 Comments

Please sign in to post a comment.

Call Off

0 Comments

Docs Navigation