Returns a specific carriers products

Get a specific carriers products

GET /orgs/{orgId}/carriers/{carrierId}/products

Returns a specific carriers products

cURL

curl --request GET \
  --url https://api.zippendo.com/orgs/{orgId}/carriers/{carrierId}/products \
  --header 'Authorization: Bearer <token>'

200

[
  {
    "name": "<string>",
    "productId": "<string>",
    "type": "outbound",
    "availableCountries": [
      "<string>"
    ],
    "availableSenderCountries": [
      "<string>"
    ],
    "isServicePoint": false,
    "isPickupAvailable": false,
    "description": "<string>",
    "services": [
      {
        "name": "<string>",
        "serviceId": "<string>"
      }
    ],
    "additionalParameters": [
      {
        "name": "<string>",
        "type": "string",
        "description": "<string>",
        "isRequired": false,
        "requiredService": [
          "<string>"
        ]
      }
    ],
    "weightLimits": {
      "min": 123,
      "max": 123,
      "unit": "kg"
    }
  }
]

Authorizations

Authorization · string · header · required

JWT access token or API token (prefixed with zipp_)

Path Parameters

orgId · string · required

Organization ID

carrierId · string · required

Carrier ID

Response

200

application/json

Default Response

name · string · required

productId · string · required

type · enum<string> · required

Available options: outbound, inbound

availableCountries · string[] · required

availableSenderCountries · string[] · required

isServicePoint · boolean · default: false · required

isPickupAvailable · boolean · default: false · required

description · string

services · object[]

Show child attributes

additionalParameters · object[]

Show child attributes

weightLimits · object

Show child attributes