Movilitas.Cloud Support

You can use the Serialized Logistics V2 API to integrate the third-party systems with the Serialized Logistics application.

The Serialized Logistics V2 API uses the Representational State Transfer (REST) standard to interact with other systems.

The Serialized Logistics V2 API is an extension of the Serialized Logistics application of Movilitas.Cloud and enables you to send requests from external systems to the application.

This article describes how to request the addresses of a client from Movilitas.Cloud by using the Serialized Logistics V2 API.

API Tool to Use

In this document, we provide examples by using the cURL command-line tool. To send the API request, you can find a lot of user-friendly REST API tools on the Internet, for example, Postman.

Before You Begin

Before you start sending any messages:

1. You must enable the Serialized Logistics application in the Admin UI.

2. You must create an API key and secret. 

3. You must create a shopfloor channel with Serialized Logistics V2 API source. You will need the channel key for your requests.

4. You must configure the Serialized Logistics application.

5. You must have the authentication token to send requests over API. Select one of the following ways:

• Apply a dynamic token. Send an authentication request over the Authentication API. For more information about the Authentication API, open the Tenant Dashboard in Movilitas.Cloud, select API keys, and choose Authentication API Documentation. Also, see Authentication Request.
• Apply a static token. Generate a static token for your previously created API key.

For more information, see Configuring the Movilitas.Cloud APIs.

Procedure

1. Use the GET method and the following URL:

https://api-acc.movilitas.cloud/v1/serialized_logistics/v2/api/clients/get_by_client_id/:client_id

2. Define the path variable.

3. For the header, define the authentication token and the channel key. The token can be given in one of the following ways:

• As x-access-token header.
• As Authorization header by using the Bearer schema.

Header Option 1:

Header Option 2:

4. Leave the body of the request empty.

5. Send the request. 

Sample cURL Request  

curl -X GET 'https://api-acc.movilitas.cloud/v1/serialized_logistics/v2/api/clients/get_by_client_id/california-client-usa' \
-H 'x-access-token: eyJhbGciOiJIUtI1NiIsInR5cCI6IkpXVCJ1.eyJrZXkiPiJqNlBFYXJiWE' \
-H 'x-channel-key: 1NRtO5Jr2ET0S05ktokAz2s7ynSuLwByDlZMib9k'

The application sends back a response that contains the following fields in the body:

Sample Response

{
    "success": true,
    "message": "Client master data",
    "data": {
        "name": "California Client USA",
        "address": {
            "city": "Los Angeles",
            "street_line_01": "15 Superstar Street",
            "street_line_02": null,
            "street_line_03": null,
            "state": "CA",
            "postal_code": "3420",
            "country": "United States"
        },
        "delivery_address": [
            {
                "delivery_address_id": "202201312322",
                "city": "Los Angeles",
                "street_line_01": "100 Central Depo",
                "street_line_02": null,
                "street_line_03": null,
                "state": "CA",
                "postal_code": "3422",
                "delivery_address_name": "CA Client Delivery",
                "country": "United States"
            },
            {
                "delivery_address_id": "2023120802",
                "city": "San Jose",
                "street_line_01": "23123 Depo Lane",
                "street_line_02": null,
                "street_line_03": null,
                "state": "CA",
                "postal_code": "23534",
                "delivery_address_name": "SJ Client Delivery 2",
                "country": "United States"
            }
        ]
    }
}