# Developer Guide

# Sandbox

We provide a sandbox testing environment to test your API integration. The sandbox URL is: https://sandbox.logistic.cloud/api/{version}/{resource}

You will need a sandbox API key to access the sandbox. You can request the sandbox API key by contacting us at support@logistikbroker.com.

The support will create a sandbox App with API key with a dedicated lifetime and permissions for your test customer in the sandbox and provide you with the API key.

To request a sandbox API key for you or one of your contractors you must be an active user of logistic.cloud or Logistikbroker ix4.

# Recommended way to update resources

Using the PUT endpoints will replace a resource. We strongly recommend that you only update resources that need to be updated. Here is how we recommend updating resources:

# Full update

Simple use the PUT endpoint to replace a resource.

# Partial update

In some cases you may need to update a resource partially. In this case, you must first get the resource you want to update. Then modify the attributes you want to update. Finally send the data to the PUT endpoint.

If you need to update a single or less resources that it is fine to get them by their id. If you need to update many resource, we recommend to get all and sending only the updated resources to the PUT endpoint.

# Get resources in a specific time range

Note that all datetime values are handled in the UTC time zone. You can specify the time zone that matches your local time in the filters.

Make sure that the values are encoded correctly.

# Get all articles updated between 2024-06-28 10:30 and 2024-06-28 12:30

To get all articles that have been updated between 2024-06-28 10:30 and 2024-06-28 12:30 in the time zone CEST you can pass in 2024-06-28T10:30:00+02:00 for updatedAtMin and 2024-06-28T12:31:00+02:00 for updatedAtMax.

curl -X GET \
  'https://{domain}.logistic.cloud/api/{version}/articles?updatedAtMin=2024-06-28T10:30:00%2B02:00&updatedAtMax=2024-06-28T12:31:00%2B02:00' \
  -H 'X-API-KEY: YOUR_API_KEY'

# Get all articles created at 2024-06-28

To get all articles that have been created on 2024-06-28 in the time zone CEST you can pass in 2024-06-28T00:00:00+02:00 for createdAtMin and 2024-06-29T00:00:00+02:00 for createdAtMax.

curl -X GET \
  'https://{domain}.logistic.cloud/api/{version}/articles?createdAtMin=2024-06-28T00:00:00%2B02:00&createdAtMax=2024-06-29T00:00:00%2B02:00' \
  -H 'X-API-KEY: YOUR_API_KEY'