Skip to main content

Getting Started

Welcome to the Getting Started guide for the Logistics Plus Warehouse API. This guide will help you set up your environment and make your first API call.

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

Prerequisites​

Before you start, make sure you have the following:

  1. An API key provided by Logistics Plus. This key is used for authenticating your requests to the API. If you don't have an API key, please contact your Logistics Plus representative.
  2. A code editor or an API development tool like Postman to send requests to the API.
  3. A basic understanding of JSON and RESTful APIs.

Authentication​

There are two types of authentication available for the Logistics Plus Warehouse API: single organization authentication and multi-organization authentication. Single organization authentication is the simpler of the two and only requires the API key in the header. Multi-organization authentication, on the other hand, requires an additional header, organization-slug, to identify the customer organization you are interacting with. Please refer to the credentials packet provided by your Logistics Plus representative to determine if your integration requires multi-organization authentication.

Single Organization Authentication​

Use the x-api-key header with your API key as the value.

For example:

GET warehouse/v1/products HTTP/1.1
x-api-key: {{api-key}}

Multi-Organization Authentication​

info

Multi-organization authentication is not required for all integrations. Please refer to the credentials packet provided by your Logistics Plus representative to determine if your integration requires this method. If you are using multi-organization authentication, the organization-slug header will be required for all requests.

When making requests, the organization-slug header is essential to identify the customer organization you are interacting with. If you pass an organization slug that does not exist, you will receive a 401 response.

Use the x-api-key header with your API key as the value and the organization-slug header with your organization slug as the value.

GET warehouse/v1/products HTTP/1.1
x-api-key: {{api-key}}
organization-slug: {{org-slug}}

Sandbox Base URL​

All API requests for testing should be made to the following base URL: https://sandbox.api.logisticsplus.com/warehouse

Making Your First API Call​

To create a new warehouse product, you can make a POST request to the /warehouse/v1/products endpoint. The JSON payload for this request should include at minimum the following fields: productCode, productDescription, and productUnit. Here's an example of how the request should look:

POST /warehouse/v1/products HTTP/1.1
x-api-key: your_api_key
organization-slug: your_organization_slug (if required)
Content-Type: application/json

{
  "productCode": "yourProductCode",
  "productDescription": "yourProductDescription",
  "productUnit": "UNT"
}

Replace your_api_key with your actual API key and your_organization_slug with your organization slug, if required.

If the request is successful, you will receive a 200 OK status code and a JSON response containing the newly created product.

{
    "data": {
        "id": "64304fe4bd6934788b4448ab",
        "productCode": "yourProductCode",
        "productDescription": "yourProductDescription",
        "productUnit": "UNT",
        "productAttributes": [],
        "dimHeight": 0,
        "dimWidth": 0,
        "dimDepth": 0,
        "weightPerProduct": 0
    },
    "id": "e340a3bce8ec40cb874654e02812a849",
    "resource": [],
    "errors": []
}

Next Steps​

Congratulations! You've successfully made your first API call to the Logistics Plus Warehouse API. Now you can explore the API further and integrate it into your applications. Be sure to read the documentation for each endpoint to understand the required fields and their formats.

If you encounter any issues or have questions, don't hesitate to reach out to our support team. We're here to help you make the most of our API and ensure a smooth integration process.