Response Schema

caution

Please note that Logistics Plus may add new fields to various response objects in the future without prior notice. These changes will not affect the usage of existing fields, but when developing your integration, it is important to ignore any additional fields in the response or webhook data. Please ensure that your code is designed to handle such changes and gracefully handle unexpected or unknown fields.

Note: The full OpenAPI specification for the Logistics Plus Warehouse API is available at the following link: https://api.logisticsplus.com/warehouse/api-docs.

The warehouse API will respond to each request with a standard response schema that contains the following fields:

• data: an object containing the complete object of the requested resource, if the request was successful.
• id: a unique identifier for the request.
• resource: an array of objects representing the requested resource, if the request was successful.
• errors: an array of error objects that occurred during the request.

Success Response

If the request was successful, the API will respond with a 200 OK status code and a response schema that looks like this:

{
  "data": {
    // Complete object of the requested resource
  },
  "id": "unique-request-identifier",
  "resource": [
    // Array of objects representing the requested resource
  ],
  "errors": []
}

Error Response

If an error occurred during the request, the API will respond with a non-200 status code and a response schema that looks like this:

{
  "data": {},
  "id": "unique-request-identifier",
  "resource": [],
  "errors": [
    {
      "id": "unique-error-identifier",
      "status": "status-code",
      "code": "error-code",
      "title": "error-title",
      "detail": "error-detail",
      "source": {
        "pointer": "error-source-pointer"
      }
    }
  ]
}

Here is an example of an error response:

{
  "data": {},
  "id": "6dd94618221649c38047a815b1a2aea3",
  "resource": [],
  "errors": [
    {
      "id": "f82e55d4-aa18-4f21-8d14-bdba78a44818",
      "status": "400",
      "code": "INVALID_REQUEST",
      "title": "Field [WarehouseCode] is invalid",
      "detail": "'Warehouse Code' must not be empty.",
      "source": {
        "pointer": "0HMMKJD57RG8J:00000002"
      }
    }
  ]
}