Introduction

This document provides the design specifications for the REST/OData-based endpoints used to exchange delivery, material master, and inventory information between the customer application and Solve Cloudmunk.

The interfaces covered in this document support the integration of the following business objects:

Each endpoint specification in this document is organized into three sections:

Authorization (OAuth 2.0)

All REST API endpoints use OAuth 2.0 for authentication and authorization.

Delivery Header & Item Upload API

Used by the customer application to push Delivery Header and Delivery Item information to Solve Cloudmunk. A single request can contain one Delivery Header and one or more Delivery Items belonging to the same delivery document.

Sample request payload

{
  "Header": {
    "Delivery": "8000012345",
    "ShipPoint": "1710",
    "ShiptoParty": "1000001234",
    "ShiptoPartyName": "ABC Retail",
    "ShiptoPartyCity": "Atlanta",
    "OverallPickStatus": "A",
    "OverallPackStatus": "A",
    "OverallGMStatus": "A"
  },
  "Items": [
    {
      "Delivery": "8000012345",
      "Item": "000010",
      "Material": "MAT10001",
      "Description": "Soft Drink 500ml",
      "Batch": "BATCH001",
      "DeliveryQty": 120.000,
      "PickedQty": 120.000,
      "PickStatus": "C",
      "UOM": "EA"
    },
    {
      "Delivery": "8000012345",
      "Item": "000020",
      "Material": "MAT10002",
      "Description": "Orange Juice",
      "Batch": "BATCH002",
      "DeliveryQty": 50.000,
      "PickedQty": 48.000,
      "PickStatus": "B",
      "UOM": "EA"
    }
  ]
}

Response fields

Sample response

{
  "Delivery": "8000012345",
  "Status": "Completed",
  "Message": "Delivery uploaded successfully",
  "TotalItems": 2,
  "SuccessfulItems": 2,
  "FailedItems": 0,
  "ItemResults": [
    { "Item": "000010", "Processed": "Completed", "Message": "Item processed successfully." },
    { "Item": "000020", "Processed": "Completed", "Message": "Item processed successfully." }
  ]
}

Material Master Upload API

Submits material master-related information required by Solve Cloudmunk — the material number, plant, base unit of measure, logistics execution quantity per pallet, and packaging product group.

Sample request payload

{
  "Plant": "1710",
  "Date": "2026-07-21",
  "Time": "14:30:25",
  "Material": "MAT10001",
  "PalletQty": 48,
  "BaseUOM": "EA",
  "PackagingTypeCategory": "P001"
}

Response

{
  "Material": "MAT10001",
  "Plant": "1710",
  "Status": "Completed",
  "Message": "Material Master record sent successfully."
}

{
  "Material": "MAT10001",
  "Plant": "1710",
  "Status": "Error",
  "Message": "Material Master record could not be processed",
  "ErrorMessage": "Invalid Packaging Product Group."
}

Inventory Details API

Submits inventory stock information for a material at a specific plant and storage location — batch-specific stock quantities, storage-bin information, and stock split across unrestricted-use, quality inspection, and blocked categories. Also carries batch data: manufacture date and shelf-life expiration date.

Sample request payload

{
  "Material": "MAT10001",
  "Batch": "BATCH001",
  "Plant": "1710",
  "StorageLocation": "171A",
  "StorageBin": "BIN-A-001",
  "Unrestricted": 1250.000,
  "QualInspection": 50.000,
  "Blocked": 10.000,
  "ManufactureDate": "2026-07-01",
  "SLED": "2027-07-01"
}

Response

{
  "Material": "MAT10001",
  "Batch": "BATCH001",
  "Plant": "1710",
  "StorageLocation": "171A",
  "Status": "Completed",
  "Message": "Inventory record processed successfully."
}

{
  "Material": "MAT10001",
  "Batch": "BATCH001",
  "Plant": "1710",
  "StorageLocation": "171A",
  "Status": "Error",
  "Message": "Inventory record could not be processed.",
  "ErrorMessage": "Invalid storage location or material."
}

Standard OData Services

The endpoint APIs use data retrieved from standard SAP OData services to populate the required Delivery, Material Master, and Inventory data structures. SAP OData services act as the source of business data; Cloudmunk endpoint APIs provide the interface through which that data is exchanged with the customer application.

Integration & data mapping

Data obtained from standard SAP OData services is extracted, transformed, and mapped to the request payload structure required by the corresponding Cloudmunk REST endpoint before transmission to Solve.

Endpoint Payload Mapping

Summary of the relationship between standard SAP OData services and the Cloudmunk endpoint APIs. This source-to-target mapping ensures endpoint payloads are populated using standardized SAP OData services and that required business information is consistently transferred to Cloudmunk.

HTTP Status Codes

Standard response codes returned by the Cloudmunk endpoint APIs.