Skip to content

Get all third-party logistics providers

Request

Retrieves all third-party logistics providers configured for the caller's profile. Use the returned ids with POST /v1/movement-requests/create-with-3pl to dispatch movements to a specific provider.

Security
JigcarAPIAuth
curl -i -X GET \
  https://docs.jigcar.com/_mock/openapi-v1/infrastructure/providers/third-party \
  -H 'X-Jigcar-API-Key: YOUR_API_KEY_HERE'

Responses

All 3PLs retrieved

Bodyapplication/json
Array [
idstringrequired

The logistic providers id

Example:"some-third-party-id"
namestringrequired

The logistics providers name

Example:"ACME Ltd"
primaryContactInformationobjectrequired
supportedTransportTypesArray of strings(TransportMethod)required

The transport methods this 3PL is willing/able to fulfil

Items Enum:"DRIVEN""TRANSPORTED"
Example:
[ "DRIVEN" ]
doesWeekendDeliverybooleanrequired

Whether this 3PL delivers on weekends

Example:true
]
Response
[ { "id": "some-third-party-id", "name": "ACME Ltd", "primaryContactInformation": { … }, "supportedTransportTypes": [ … ], "doesWeekendDelivery": true } ]