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 get an Advanced Shipping Notification 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. You can use any API tool to perform the API requests, for example, Postman or Katalon Studio.


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.movilitas.cloud/v1/serialized_logistics/v2/api/suppliers/get_advanced_shipping_notification


2. Define the query params.


KeyRequired or Optional?TypeAction
supplier_tagOptionalStringProvide the supplier tag that identifies your supplier.


Note: Make sure that you have registered the supplier in the Serialized Logistics application --> Site management --> Suppliers tab and apply the value given in the Supplier tag field.

purchase_order_idOptional*StringProvide the purchase order ID.
dispatch_advice_idOptional*StringProvide the despatch advice ID.
include_aggregationsRequiredBooleanSpecify whether you want to include aggregations. In the current implementation, the allowed value is "false".

*One of the two is required. If the purchase order ID or the despatch advice ID is provided, the other field is optional.


3. For the header, define the following:


KeyAction
x-access-tokenProvide the authentication token.
x-channel-keyProvide the channel key of your Serialized Logistics V2 API channel.


4. Leave the body of the request empty.


5. Send the request. 


Sample cURL Request  


curl -X GET \
https://api.movilitas.cloud/v1/serialized_logistics/v2/api/suppliers/get_advanced_shipping_notification?purchase_order_id=PO2&include_aggregations=false&dispatch_advice_id=DA1 \
  -H 'x-access-token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJrZXkiOiJzX2FqazQyS2RLQWhHciE3TUZtY1Q2UzhTQ3NDQ2hzc2RoTXRFUlNBIUNwUDhlZDkzU2htQ0hoaHIyTmg3Y0dBIiwiX2lkIjoiNWQyNzA4ZDc3NDQ1OTcxYjI5MmY4ZDI3IiwiaWF0IjoxNTY0MDU5ODc2LCJleHAiOjE1NjQxNDYyNzZ9.TBMv71CaxCNtE1opQMk0f1ncfbnZ0Cwnu7MWkTzkQqA' \
  -H 'x-channel-key: Ky1SpfEXmjj05fW3USBFD3pgoEi9AQ29Atsnj4Zy'

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


FieldTypeDescription
successBooleanIndicates whether the request was successful (true) or not (false).
messageStringMessage response.
dataObjectThe shipment data.
    productsObject[]The object array of the products. Each product object contains the details of a product:
  • Code
  • Batches


Note: The application returns the top-level trade items only. Containers (SSCCs) are not returned.

          codeStringThe product code (GTIN).
         batchesObject[]The object array of the batches. Each batch object contains the details of a batch:
  • Batch ID
  • Expiration date
  • Serial numbers
                 idStringThe batch ID.
                 expiration_dateStringProduct expiration date. GS1 format YYMMDD. For example, 2021 December 15 is "211215".
                 serialsString[]The array of serial numbers. The serial numbers follow the GS1 standard.


Sample Response


{
    "success": true,
    "message": "Advanced Shipping Notification",
    "data": {
        "products": [
            {
                "code": "30300040244510",
                "batches": [
                    {
                        "id": "0424C",
                        "expiration_date": "270424",
                        "serials": [
                            "3YZAB23061400",
                            "3YZAB23061401",
                            "3YZAB23061402",
                            "3YZAB23061403"
                        ]
                    }
                ]
            }
        ]
    }
}


Errors and Resolution


This section lists some of the most general error messages or error types when sending the request.


Error Message or Error TypeError CodeDescription
No token providedERR0001No authentication token is provided. Ensure that you add the authentication token to the header of the request.
Failed to authenticate tokenERR0000Failed to authenticate the provided token. Double-check if your token has expired or has been revoked. Obtain a valid token by generating a static one or by getting a dynamic one through Authentication API.
Channel ID is missing or it needs to be in correct format-The channel key of your Serialized Logistics V2 API channel is not specified in the request. To get the channel key, go to Tenant Dashboard --> Channels in the Admin UI, open your Serialized Logistics V2 API channel, and find the channel key on the top of the Edit shopfloor channel panel.
Validation error-The given data is invalid. It does not follow the required data type or pattern. The response includes details about the specific issue. Follow the explanation in the response and correct your data.
No upload found with provided id
-There is no Advanced Shipping Notification in Movilitas.Cloud with the provided ID.

Make sure that you provide an ID that comes from an existing Advanced Shipping Notification in Movilitas.Cloud. You can add an Advanced Shipping Notification to Movilitas.Cloud by receiving an EPCIS file from the supplier in the Serialized Logistics application.