Inventory

Usage: Insert / update an inventory record in the OneSource database

JSON Schema URL: https://management-api.dc-onesource.com/en/US/inventory/schema.json

HTTP Method: POST

Header Parameters Required
x-api-key yes
x-api-password yes

Sample POST Request (Reference JSON schema link above to build full object)

POST https://management-api.dc-onesource.com/en/US/inventory
x-api-key: YOUR_API_KEY_HERE
x-api-password: YOUR_API_PASSWORD_HERE

{
  "productId": "1234",
  "parts": [
    {
      "isBuyToOrder": true,
      "isMainPart": false,
      "isManufacturedItem": false,
      "partId": "1234-RD-5XL",
      "validTimestamp": "2021-02-19T13:23:44.269Z",
      "locations": [
        {
          "country": "US",
          "id": "1",
          "quantity": {
            "uom": "EA",
            "value": 1254
          },
          "futureAvailability": [
            {
              "availableOn": "2021-06-26T15:42:18.239Z",
              "quantity": {
                "uom": "EA",
                "value": "1500"
              }
            }
          ],
          "postalCode": "66030",
          "name": "Gardner Warehouse"
        },
        {
          "country": "US",
          "id": "2",
          "quantity": {
            "uom": "EA",
            "value": 10
          },
          "futureAvailability": [
            {
              "availableOn": "2021-06-26T15:42:18.239Z",
              "quantity": {
                "uom": "EA",
                "value": "500"
              }
            }
          ],
          "postalCode": "63106",
          "name": "Saint Louis Warehouse"
        }
      ],
      "labelSize": "5XL",
      "partDescription": "Red 5XL Tank Top",
      "partColor": "Red",
      "quantityAvailable": {
        "value": 1264
      }
    },
    {
      "isBuyToOrder": true,
      "isMainPart": false,
      "isManufacturedItem": false,
      "partId": "1234-BK-4XL",
      "validTimestamp": "2021-02-19T13:23:44.269Z",
      "locations": [
        {
          "country": "US",
          "id": "1",
          "quantity": {
            "uom": "EA",
            "value": 1100
          },
          "futureAvailability": [
            {
              "availableOn": "2021-06-26T15:42:18.239Z",
              "quantity": {
                "uom": "EA",
                "value": "1500"
              }
            }
          ],
          "postalCode": "66030",
          "name": "Gardner Warehouse"
        },
        {
          "country": "US",
          "id": "2",
          "quantity": {
            "uom": "EA",
            "value": 100
          },
          "futureAvailability": [
            {
              "availableOn": "2021-06-26T15:42:18.239Z",
              "quantity": {
                "uom": "EA",
                "value": "1500"
              }
            }
          ],
          "postalCode": "63106",
          "name": "Saint Louis Warehouse"
        }
      ],
      "labelSize": "4XL",
      "partDescription": "Black 4XL Tank Top",
      "partColor": "Black",
      "quantityAvailable": {
        "value": 1200
      }
    },
    {
      "isBuyToOrder": true,
      "isMainPart": false,
      "isManufacturedItem": false,
      "partId": "1234-BL-S",
      "validTimestamp": "2021-02-19T13:23:44.269Z",
      "locations": [
        {
          "country": "US",
          "id": "1",
          "quantity": {
            "uom": "EA",
            "value": 50
          },
          "futureAvailability": [
            {
              "availableOn": "2021-06-26T15:42:18.239Z",
              "quantity": {
                "uom": "EA",
                "value": "1500"
              }
            }
          ],
          "postalCode": "66030",
          "name": "Gardner Warehouse"
        },
        {
          "country": "US",
          "id": "2",
          "quantity": {
            "uom": "EA",
            "value": 10
          },
          "futureAvailability": [
            {
              "availableOn": "2021-06-26T15:42:18.239Z",
              "quantity": {
                "uom": "EA",
                "value": "1500"
              }
            }
          ],
          "postalCode": "63106",
          "name": "Saint Louis Warehouse"
        }
      ],
      "labelSize": "S",
      "partDescription": "Blue Small Tank Top",
      "partColor": "Blue",
      "quantityAvailable": {
        "value": 60
      }
    }
  ]
}

How to DELETE an inventory record

Usage: Delete an inventory record in the OneSource database

HTTP Method: DELETE

Header Parameters Required
x-api-key yes
x-api-password yes

Sample DELETE Request

DELETE https://management-api.dc-onesource.com/en/US/inventory/{productId}
x-api-key: YOUR_API_KEY_HERE
x-api-password: YOUR_API_PASSWORD_HERE
Did this answer your question? Thanks for the feedback There was a problem submitting your feedback. Please try again later.