Create Master Data

POST 
https://sight.inspectorio.com/api/v1/master-data

Create a new master data entry

Request

application/json

Bodyrequired

uidstringrequired
Unique identifier for the master data entry
Example: UID_ABC_123
rawDataobjectrequired
Raw data content in any valid JSON format
Example: {"purchaseOrderNumber":"PO_123456","vendorSubmitDate":"2024-04-09","estimatedCargoReadyDate":"2024-04-11","shipmentLoadType":"CY","shipmentBookingId":"SB_ABC_123","shipmentBookingStatus":"PackageBookingStatusAcceptedEvent","targetOrgId":"custom_01"}
versionstringnullable
Optional version identifier for the data format
Example: shipment-booking-v1.0.0

Responses

201

Master data created successfully

application/json

Schema

Schema

data object
updatedDatedate-time
Example: 2025-02-14T06:52:42.073326+00:00
versionstring
Example: shipment-booking-v1.0.0
uidstring
Example: UID_ABC_123
rawDataobject
Raw data content in any valid JSON format
Example: {"purchaseOrderNumber":"PO_123456","vendorSubmitDate":"2024-04-09","estimatedCargoReadyDate":"2024-04-11","shipmentLoadType":"CY","shipmentBookingId":"SB_ABC_123","shipmentBookingStatus":"PackageBookingStatusAcceptedEvent","targetOrgId":"custom_01"}
createdDatedate-time
Example: 2025-02-14T06:52:42.073319+00:00

Example (auto)

{
  "data": {
    "updatedDate": "2025-02-14T06:52:42.073326+00:00",
    "version": "shipment-booking-v1.0.0",
    "uid": "UID_ABC_123",
    "rawData": {
      "purchaseOrderNumber": "PO_123456",
      "vendorSubmitDate": "2024-04-09",
      "estimatedCargoReadyDate": "2024-04-11",
      "shipmentLoadType": "CY",
      "shipmentBookingId": "SB_ABC_123",
      "shipmentBookingStatus": "PackageBookingStatusAcceptedEvent",
      "targetOrgId": "custom_01"
    },
    "createdDate": "2025-02-14T06:52:42.073319+00:00"
  }
}

400

Bad request

application/json

Schema

Schema

detailstring
Bad request error message
codeinteger
Response status code
Example: 400
statusinteger
Response status code
Example: 400

Example (auto)

{
  "detail": "string",
  "code": 400,
  "status": 400
}

401

Unauthorized

application/json

Schema

Schema

errorCodestring
Example: Generic
messagestring
Example: Cannot retrieve session data because of expired token

Example (auto)

{
  "errorCode": "Generic",
  "message": "Cannot retrieve session data because of expired token"
}

429

Rate-limiting Error

application/json

Schema

Schema

errorCodestring
Example: Generic
messagestring
Example: Too many requests

Example (auto)

{
  "errorCode": "Generic",
  "message": "Too many requests"
}

500

Internal Error

application/json

Schema

Schema

errorCodestring
Example: Generic
errorsobject
Example: {"system":["Internal error detail message"]}
messagestring
Example: Internal server error

Example (auto)

{
  "errorCode": "Generic",
  "errors": {
    "system": [
      "Internal error detail message"
    ]
  },
  "message": "Internal server error"
}

Authorization: apiKey

name: apiKeytype: apiKeyin: header

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L 'https://sight.inspectorio.com/api/v1/master-data' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'apiKey: <apiKey>' \
-d '{
  "uid": "UID_ABC_123",
  "rawData": {
    "purchaseOrderNumber": "PO_123456",
    "vendorSubmitDate": "2024-04-09",
    "estimatedCargoReadyDate": "2024-04-11",
    "shipmentLoadType": "CY",
    "shipmentBookingId": "SB_ABC_123",
    "shipmentBookingStatus": "PackageBookingStatusAcceptedEvent",
    "targetOrgId": "custom_01"
  },
  "version": "shipment-booking-v1.0.0"
}'

Request Collapse all

Base URL

https://sight.inspectorio.com

Auth

ApiKeyAuth

Body required

{
  "uid": "UID_ABC_123",
  "rawData": {
    "purchaseOrderNumber": "PO_123456",
    "vendorSubmitDate": "2024-04-09",
    "estimatedCargoReadyDate": "2024-04-11",
    "shipmentLoadType": "CY",
    "shipmentBookingId": "SB_ABC_123",
    "shipmentBookingStatus": "PackageBookingStatusAcceptedEvent",
    "targetOrgId": "custom_01"
  },
  "version": "shipment-booking-v1.0.0"
}

ResponseClear

Click the Send API Request button above and see the response here!