Getting Warehouse Shipments

This guide walks you through getting Warehouse Shipments from the JUSDA API.

Authentication

JUSDA uses API keys for authentication. At this time API keys are assigned by JUSDA's Technology Team. To obtain a key, contact your JUSDA Sales representative.

Once you have an API key, to authenticate, it will be necessary to pass the key in the HTTP header of each call you make. For the header key pass x-api-key. Pass your key as the value. For example: x-api-key=34A81032-979E-4EFC-9A6F-87E2973F3E20

If there is any problem authenticating your key, the API will respond with an HTTP 401 code.

Testing

JUSDA may provide you an API key that is set to our test environment. If instead you have a production API key, it's possible to use the test environment on any API call by including an environment attribute in the endpoint's query string. For example:

https://services.jusdausa.com/api/v1/Rates?environment=Test

API Endpoint

The URL for JUSDA APIs is:

https://services.jusdausa.com/api/v1

To this endpoint add the resource you are accessing. For example, the endpoint to get Warehouse Shipments is:

https://services.jusdausa.com/api/v1/WarehouseShipments

Warehouse Shipment URL Parameters

The /WarehouseORder API accepts various filter values in its query string. Paging is also supported. Here are some example API calls with an explanation of how the query will execute.

https://services.jusdausa.com/api/v1/WarehouseShipments?orderNo=RJUSDA00003

The above example will retrieve a single Warehouse Shipment that has a OrderNo RJUSDA00003.

https://services.jusdausa.com/api/v1/WarehouseShipments?limit=10

The above example will retrieve the 10 most recent Warehouse Shipment.

https://services.jusdausa.com/api/v1/WarehouseShipments?limit=10&page=3

Limit specifies the maximum number of rows to return. Page specifies the page number. In this case, the shipments in positions 20-29 will be retrieved.

Get Warehouse Shipment Query String Paramaters

Use any of the following parameters in your HTTP GET query string to filter your search for existing warehouse Shipments.

• modifiedDateFrom: (optional) Supports search for shipments created or updated within a date range
• modifiedDateTo: (optional) Supports search for shipments created or updated within a date range
• shipmentNo: (optional) JUSDA's Shipment Number from our warehousing system
• orderNo: (optional) Retrieve a specific Shipment Number
• limit: (optional) Default is 100
• page: (optional) Default is 1
• environment: (optional) Test or Production. Default is Production.

Sample Response Payload

            [
                {
                    "ShipmentNo": "WSOTEST1737",
                    "OrderNo": "RJUSDA00002",
                    "ReceiptDate": "2021-01-28T10:37:36.25",
                    "ShipmentDate": "0001-01-01T00:00:00",
                    "ShipperName": "JUSDA USA",
                    "ShipperAddress1": null,
                    "ShipperAddress2": null,
                    "ShipperCity": null,
                    "ShipperStateProvince": null,
                    "ShipperPostalCode": null,
                    "ShipperCountryCode": null,
                    "ShipperTelNo": null,
                    "ConsigneeName": "",
                    "ConsigneeAddress1": "1 Fenton Street",
                    "ConsigneeAddress2": null,
                    "ConsigneeCity": "New York",
                    "ConsigneeStateProvince": "NY",
                    "ConsigneePostalCode": "10036",
                    "ConsigneeCountryCode": "US",
                    "ConsigneeTelNo": null,
                    "Carrier": "UPS",
                    "CarrierTrackingNo": "1Z780V7A0460285423",
                    "CarrierServiceLevel": "UPS GROUND",
                    "PackType": null,
                    "PackQuantity": 0,
                    "Weight": null,
                    "WeightUnit": null,
                    "ModeOfTransport": null,
                    "ExternalOrderIdentifier": "RJUSDA00002",
                    "Items": [
                    {
                        "LineNo": "10",
                        "SKU": "5795",
                        "Description": null,
                        "Quantity": 1,
                        "LineReference": ""
                    }
                    ]
                }
            ]