Kestraa Logo

Environment

Production: https://api.kestraa.com.br

QA: https://api-qa.kestraa.com.br

POST Goods Delivery

This endpoint provides essential information for the integration between the ERP system and the Kestraa platform, specifically regarding the notification of goods entry into inventory as indicated by the ERP.

Target URL: ${environment}/documents/purchaseorders/{id}/items/{id}/events/

Rate Limits: 5 requests per second per token.

Required Headers

Name Description
Authorization Bearer Token for authentication. or Apikey xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Request Body

{
  "id": null,
  "type": "item.delivery",
  "eventDate": "2024-01-29T14:43:19-03:00",
  "data": {
    "quantity": 10000
  },
  "sapId": "5500000307",
  "sapItemId": "0001",
  "year": 2024,
  "documentSapId": "4500002922",
  "documentItemSapId": 10
}

Field Explanation

Field Mandatory Type Description
id No Default: null
type Yes String(10) Always "item.delivery".
eventDate Yes String(30) Event date and time in ISO 8601 format (e.g. 2023-11-14T14:43:19-03:00).
data.quantity Yes Numeric Quantity of delivered merchandise. Example: 80.0
sapId Yes String(10) Transaction number generated by the ERP.
sapItemId Yes String(10) Transaction number generated by the ERP when the item is delivered.
year Yes Integer Year of goods delivery and stock entry.
documentSapId Yes String(255) Purchase order number used internally for control — code generated by the ERP system.
documentItemSapId Yes String(15) The item number generated by the ERP; always increases in increments of 10 as recorded in the Kestraa Purchase Order (e.g. 10, 20, 30).

HTTP Status Codes

Code Description
200OK
201Created
400Bad Request
401Unauthorized
404Not Found
500Internal Server Error