GOgolocad
Inbound Consignment

GET /openapi/{version}/consignments/inbound_consignments/

This endpoint allows users to retrieve a list of inbound consignments.<b>Example curl Request:</b>

curl --location '{{url}}/openapi/v2/consignments/inbound_consignments?limit=20&offset=0' \
--header 'Authorization: Bearer {{token}}'

Request

  • Base URL
    https://base_url
  • Auth
    none declared

Path parameters

versionstring required

Query parameters

consignment_numberstring

Filter by consigment numbers (comma-separated). Example: ?consignment_number=C-1737451050,C-1737397050

created_afterstring

Filter by inbound consignment creation time. Example: ?created_after=2024-01-01:00:00:00

created_beforestring

Filter by inbound consignment creation time. Example: ?created_before=2024-01-01:00:00:00

limitinteger

Number of results to return per page (default: 20, max: 5000)

offsetinteger

The initial index from which to return the results (default: 0)

orderingstring

Which field to use when ordering the results.

searchstring

A search term.

updated_afterstring

Filter by inbound consignment update time. Example: ?updated_after=2024-01-01:00:00:00

updated_beforestring

Filter by inbound consignment update time. Example: ?updated_before=2024-01-01:00:00:00

Response

successboolean
messagestring required

Changes

No recorded changes to this operation across all 1 revision of this API.