SAP
Material Master
Get
Endpoint
Query paramters are optional
GET api-dev.ventory.io/api/product-master-data?page=0
Headers
x-api-key: your-api-key
Create
Endpoint
POST api-dev.ventory.io/api/product-master-data/create
Headers
x-api-key: your-api-key
Request Body
{
"companyId": "xxxx-xxxx-xxxx-xxxx", // SAP Company/Plant ID
"productName": "Flexi tuinkas alu 3 x 4,5 x 2,75m", // SAP Source API Field: ProductDescription
"productNumber": "200001201", // SAP Source API Field: Product
"lotManaged": true, // SAP Source API Field: IsBatchManagementRequired
"countryOfOrigin": "FR", // SAP Source API Field: CountryOfOrigin
"globalTradeItemNumber": "5414761562649", // SAP Source API Field: GlobalTradeItemNumber
"grossWeight": {
"value": 10000, // SAP Source API Field: GrossWeight
"unit": "KG" // SAP Source API Field: WeightUnit
},
"dimensions": {
"height": 80, // SAP Source API Field: UnitSpecificProductHeight
"length": 120, // SAP Source API Field: UnitSpecificProductLength
"width": 100, // SAP Source API Field: UnitSpecificProductWidth
"unit": "CM" // SAP Source API Field: ProductMeasurementUnit
},
"externalIdentifier": {
"settingsId": "001", // Static value to indicate SAP integration
"externalId": "xxxx-xxxx-xxxx-xxxx" // SAP Material Master ID
},
"customFields": [
{
"name": "InternationalArticleNumberCat",
"value": "UC" // SAP Source API Field: InternationalArticleNumberCat
},
{
"name": "BaseUnit",
"value": "PC",
},
{
"name": "ProductStandardID",
"value": "5414761562649" // SAP Source API Field: ProductStandardID
},
{
"name": "SupplyingPlant",
"value": "P900" // SAP Source API Field: SupplyingPlant
},
{
"name": "ProductHierarchy",
"value": "ProductHierarchy" // SAP Source API Field: ProductHierarchy
},
{
"name": "Language",
"value": "NL" // SAP Source API Field: Language
}
]
}
Update
We allow both partial updates (see example below) and complete updates (same data as create)
Endpoint
POST api-dev.ventory.io/api/product-master-data/update
Headers
x-api-key: your-api-key
Request Body
{
"companyId": "xxxx-xxxx-xxxx-xxxx",
"countryOfOrigin": "NL", // Changing CountryOfOrigin from FR to NL
"externalIdentifier": {
"settingsId": "001",
"externalId": "xxxx-xxxx-xxxx-xxxx"
}
}
Delete
Endpoint
POST api-dev.ventory.io/api/product-master-data/delete
Headers
x-api-key: your-api-key
Request Body
{
"companyId": "xxxx-xxxx-xxxx-xxxx",
"externalIdentifier": {
"settingsId": "001",
"externalId": "xxxx-xxxx-xxxx-xxxx"
}
}
Storage Location
Get
Endpoint
Query paramters are optional
GET api-dev.ventory.io/api/stock-location?page=0
Headers
x-api-key: your-api-key
Create
Endpoint
POST api-dev.ventory.io/api/stock-location/create
Headers
x-api-key: your-api-key
Request Body
{
"companyId": "xxxx-xxxx-xxxx-xxxx", // SAP Company/Plant ID
"name": "storage-location-name", // SAP Storage Location Name
"externalIdentifier": {
"settingsId": "001", // Static value to indicate SAP integration
"externalId": "xxxx-xxxx-xxxx-xxxx" // SAP Storage Location ID
}
}
Update
We allow both partial updates (see example below) and complete updates (same data as create)
Endpoint
POST api-dev.ventory.io/api/stock-location/update
Headers
x-api-key: your-api-key
Request Body
{
"companyId": "xxxx-xxxx-xxxx-xxxx",
"name": "name-storage-location-name",
"externalIdentifier": {
"settingsId": "001",
"externalId": "xxxx-xxxx-xxxx-xxxx"
}
}
Delete
Endpoint
POST api-dev.ventory.io/api/stock-location/delete
Headers
x-api-key: your-api-key
Request Body
{
"companyId": "xxxx-xxxx-xxxx-xxxx",
"externalIdentifier": {
"settingsId": "001",
"externalId": "xxxx-xxxx-xxxx-xxxx"
}
}
Inbound Delivery
Get
Endpoint
Query paramters are optional
GET api-dev.ventory.io/api/order?page=0
Headers
x-api-key: your-api-key
Create
Endpoint
POST api-dev.ventory.io/api/order/create
Headers
x-api-key: your-api-key
Request Body
{
"companyId": "xxxx-xxxx-xxxx-xxxx", // SAP Company/Plant ID
"type": "inbound", // Indicates Inbound Delivery
"number": "180000000", // SAP Source API Field: DeliveryDocument
"products": [
{
"quantity": 2, // SAP Source API Field: OriginalDeliveryQuantity
"customFields": [
{
"name": "DeliveryDocumentItem",
"value": "10" // SAP Source API Field: DeliveryDocumentItem
},
{
"name": "Material",
"value": "TG11" // SAP Source API Field: Material
},
{
"name": "DeliveryDocumentItemText",
"value": "Trad.Good 11,PD,Reg.Trading" // SAP Source API Field: DeliveryDocumentItemText
},
{
"name": "DeliveryQuantityUnit",
"value": "PC" // SAP Source API Field: DeliveryQuantityUnit
},
{
"name": "Plant",
"value": "2520" // SAP Source API Field: Plant
},
{
"name": "StorageLocation",
"value": "252a" // SAP Source API Field: StorageLocation
},
{
"name": "ReferenceSDDocument",
"value": "4500000000" // SAP Source API Field: ReferenceSDDocument
},
{
"name": "Batch",
"value": "" // SAP Source API Field: Batch
},
{
"name": "BatchBySupplier",
"value": "" // SAP Source API Field: BatchBySupplier
}
]
}
],
"externalIdentifier": {
"settingsId": "001", // Static value to indicate SAP integration
"externalId": "xxxx-xxxx-xxxx-xxxx" // SAP Delivery ID
},
"customFields": [
{
"name": "DeliveryDocumentType",
"value": "EL" // SAP Source API Field: DeliveryDocumentType
},
{
"name": "Supplier",
"value": "25100088" // SAP Source API Field: Supplier
},
{
"name": "DeliveryDate",
"value": "22.11.2024" // SAP Source API Field: DeliveryDate
},
{
"name": "DeliveryTime",
"value": "14.11.2024" // SAP Source API Field: DeliveryTime
},
]
}
Update
Endpoint
POST api-dev.ventory.io/api/order/update
Headers
x-api-key: your-api-key
Request Body
{
"companyId": "xxxx-xxxx-xxxx-xxxx", // SAP Company/Plant ID
"type": "inbound", // Indicates Inbound Delivery
"number": "180000000", // SAP Source API Field: DeliveryDocument
"products": [
{
"quantity": 20, // SAP Source API Field: OriginalDeliveryQuantity
"customFields": [
{
"name": "DeliveryDocumentItem",
"value": "10" // SAP Source API Field: DeliveryDocumentItem
},
{
"name": "Material",
"value": "TG11" // SAP Source API Field: Material
},
{
"name": "DeliveryDocumentItemText",
"value": "Trad.Good 11,PD,Reg.Trading" // SAP Source API Field: DeliveryDocumentItemText
},
{
"name": "DeliveryQuantityUnit",
"value": "PC" // SAP Source API Field: DeliveryQuantityUnit
},
{
"name": "Plant",
"value": "2520" // SAP Source API Field: Plant
},
{
"name": "StorageLocation",
"value": "252a" // SAP Source API Field: StorageLocation
},
{
"name": "ReferenceSDDocument",
"value": "4500000000" // SAP Source API Field: ReferenceSDDocument
},
{
"name": "Batch",
"value": "" // SAP Source API Field: Batch
},
{
"name": "BatchBySupplier",
"value": "" // SAP Source API Field: BatchBySupplier
}
]
}
],
"externalIdentifier": {
"settingsId": "001", // Static value to indicate SAP integration
"externalId": "xxxx-xxxx-xxxx-xxxx" // SAP Delivery ID
},
"customFields": [
{
"name": "DeliveryDocumentType",
"value": "EL" // SAP Source API Field: DeliveryDocumentType
},
{
"name": "Supplier",
"value": "25100088" // SAP Source API Field: Supplier
},
{
"name": "DeliveryDate",
"value": "22.11.2024" // SAP Source API Field: DeliveryDate
},
{
"name": "DeliveryTime",
"value": "14.11.2024" // SAP Source API Field: DeliveryTime
},
]
}
Outbound Delivery
Get
Endpoint
Query paramters are optional
GET api-dev.ventory.io/api/order?page=0
Headers
x-api-key: your-api-key
Create
Endpoint
POST api-dev.ventory.io/api/order/create
Headers
x-api-key: your-api-key
Request Body
{
"companyId": "xxxx-xxxx-xxxx-xxxx", // SAP Company/Plant ID
"type": "outbound", // Indicates Outbound Delivery
"number": "80000536", // SAP Source API Field: Delivery Document
"products": [
{
"quantity": 10, // SAP Source API Field: ActualDeliveryQuantity
"customFields": [
{
"name": "DeliveryDate",
"value": "22.11.2024" // SAP Source API Field: DeliveryDate
},
{
"name": "ActualDeliveredQtyInBaseUnit",
"value": "8" // SAP Source API Field: ActualDeliveredQtyInBaseUnit
},
{
"name": "BaseUnit",
"value": "PC" // SAP Source API Field: BaseUnit
},
{
"name": "Batch",
"value": "56875394" // SAP Source API Field: Batch (Optional)
},
{
"name": "DeliveryDocumentItem",
"value": "000010" // SAP Source API Field: DeliveryDocumentItem
},
{
"name": "DeliveryDocumentItemText",
"value": "" // SAP Source API Field: DeliveryDocumentItemText
},
{
"name": "DeliveryQuantityUnit",
"value": "PC" // SAP Source API Field: DeliveryQuantityUnit
},
{
"name": "Material",
"value": "TG11" // SAP Source API Field: Material
},
{
"name": "Plant",
"value": "2520" // SAP Source API Field: Plant
},
{
"name": "ReferenceSDDocument",
"value": "5" // SAP Source API Field: ReferenceSDDocument
},
{
"name": "ShelfLifeExpirationDate",
"value": "05.05.2025" // SAP Source API Field: ShelfLifeExpirationDate
},
{
"name": "StorageLocation",
"value": "255W" // SAP Source API Field: StorageLocation
}
]
}
],
"externalIdentifier": {
"settingsId": "001", // Static value to indicate SAP integration
"externalId": "xxxx-xxxx-xxxx-xxxx" // SAP Delivery ID
},
"customFields": [
{
"name": "DeliveryDate",
"value": "22.11.2024" // SAP Source API Field: DeliveryDate
},
{
"name": "Delivery DocumentType",
"value": "LF" // SAP Source API Field: Delivery DocumentType
},
{
"name": "DeliveryTime",
"value": "14.11.2024" // SAP Source API Field: DeliveryTime
},
{
"name": "ShipToParty",
"value": "25100001" // SAP Source API Field: ShipToParty
},
{
"name": "SoldToParty",
"value": "25100001" // SAP Source API Field: SoldToParty
},
{
"name": "Warehouse",
"value": "Warehouse 1" // SAP Source API Field: Warehouse
}
]
}
Update
Endpoint
POST api-dev.ventory.io/api/order/update
Headers
x-api-key: your-api-key
Request Body
{
"companyId": "xxxx-xxxx-xxxx-xxxx", // SAP Company/Plant ID
"type": "outbound", // Indicates Outbound Delivery
"number": "80000536", // SAP Source API Field: Delivery Document
"products": [
{
"quantity": 11, // SAP Source API Field: ActualDeliveryQuantity
"customFields": [
{
"name": "DeliveryDate",
"value": "24.11.2024" // SAP Source API Field: DeliveryDate
},
{
"name": "Batch",
"value": "56875394" // SAP Source API Field: Batch (Optional)
},
{
"name": "Material",
"value": "TG11" // SAP Source API Field: Material
},
{
"name": "StorageLocation",
"value": "255W" // SAP Source API Field: StorageLocation
}
]
},
{
"quantity": 25, // SAP Source API Field: ActualDeliveryQuantity
"customFields": [
{
"name": "DeliveryDate",
"value": "24.11.2024" // SAP Source API Field: DeliveryDate
},
{
"name": "Batch",
"value": "56875395" // SAP Source API Field: Batch (Optional)
},
{
"name": "Material",
"value": "526" // SAP Source API Field: Material
},
{
"name": "StorageLocation",
"value": "255W" // SAP Source API Field: StorageLocation
}
]
},
{
"quantity": 15, // SAP Source API Field: ActualDeliveryQuantity
"customFields": [
{
"name": "DeliveryDate",
"value": "24.11.2024" // SAP Source API Field: DeliveryDate
},
{
"name": "Material",
"value": "MAT01" // SAP Source API Field: Material
},
{
"name": "StorageLocation",
"value": "252a" // SAP Source API Field: StorageLocation
}
]
}
],
"externalIdentifier": {
"settingsId": "001", // Static value to indicate SAP integration
"externalId": "80000536" // SAP Delivery ID
},
"customFields": [
{
"name": "DeliveryDate",
"value": "24.11.2024" // SAP Source API Field: DeliveryDate
},
{
"name": "Delivery DocumentType",
"value": "LF" // SAP Source API Field: Delivery DocumentType
},
{
"name": "DeliveryTime",
"value": "14.11.2024" // SAP Source API Field: DeliveryTime
},
{
"name": "ShipToParty",
"value": "25100001" // SAP Source API Field: ShipToParty
},
{
"name": "SoldToParty",
"value": "25100001" // SAP Source API Field: SoldToParty
},
{
"name": "Warehouse",
"value": "Warehouse 1" // SAP Source API Field: Warehouse
}
]
}
Delete Delivery
Endpoint
POST api-dev.ventory.io/api/order/delete
Headers
x-api-key: your-api-key
Request Body
The user can either send the complete (deleted) order or only the mandatory fields
{
// Mandatory
"companyId": "xxxx-xxxx-xxxx-xxxx",
"externalIdentifier": {
"settingsId": "001",
"externalId": "80000536"
},
}