Custom carrier endpoints

List carriers

get

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

startAfterIdstringOptional

all entities after given Id

sizeintegerOptional

number of entities to show

Default: 25

localestringOptional

Provide the localized names and descriptions for the parcel label classifications. If not provided the default locale is used., for example de_DE.

Responses

200

The current list of available carriers

application/json

StrippedCarriers

totalintegerOptional

Total number of found entities for this query

Example: 42

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

404

No more elements available

application/json

get

/api/carriers

HTTPcURLJavaScriptPython

GET /api/carriers HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "carriers": [
    {
      "created": "2020-02-03T08:45:51.525Z",
      "lastModified": "2020-02-03T09:45:51.525Z",
      "version": 42,
      "deliveryType": "SAMEDAY",
      "id": "climk4dcQFiPdA5ULuhS",
      "key": "text",
      "lifecycle": "GA",
      "name": "DHL Köln",
      "status": "ACTIVE"
    }
  ],
  "total": 42
}

Create carrier

post

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

localestringOptional

Provide the localized names and descriptions for the parcel label classifications. If not provided the default locale is used., for example de_DE.

Body

application/json

CarrierForCreation

defaultParcelHeightInCmnumber · min: 1Optional

Default height in cm

Default: 10

defaultParcelLengthInCmnumber · min: 1Optional

Default length in cm

Default: 25

defaultParcelWeightInGramnumber · min: 1Optional

Default weight for a parcel in gram

Default: 1000

defaultParcelWidthInCmnumber · min: 1Optional

Default width in cm

Default: 35

keystringRequired

References the KEP. Currently allowed values are DHL_V2, DPD_CH, DPD_CH_VCE, ANGEL, GLS, FEDEX, POSTNL, BRING, UPS, POST_NORD, DHL_EXPRESS, CUSTOM and to distinct between multiple custom carriers one can use CUSTOM_ combined with a unique name.

Example: DHL_V2

logoUrlstring · min: 1Optional

namestringRequired

This is the well known name for a supported CEP partner. Can be adapted to the clients needs.

Example: DHL Köln

productValueNeededbooleanOptional

Setting to enable the Client to ask for the parcel product value while ordering a label. This information is mandatory for sending parcels between different countries (customs declaration)

Example: true

statusstring · enumOptional

It is taken into consideration for all carriers. Default: INACTIVE

Possible values:

Responses

201

The carrier was successfully created. The Location header contains the URL of the carrier.

application/json

400

Invalid input. See response for details

application/json

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

post

/api/carriers

HTTPcURLJavaScriptPython

POST /api/carriers HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 472

{
  "credentials": {
    "key": "text"
  },
  "defaultParcelHeightInCm": 10,
  "defaultParcelLengthInCm": 25,
  "defaultParcelWeightInGram": 1000,
  "defaultParcelWidthInCm": 35,
  "key": "DHL_V2",
  "logoUrl": "text",
  "name": "DHL Köln",
  "parcelLabelClassifications": [
    {
      "nameLocalized": {
        "de_DE": "S-Paket",
        "en_US": "S-Parcel",
        "ru_RU": "S-пакет"
      },
      "dimensions": {
        "customWeight": 1700,
        "height": 50,
        "length": 100,
        "weight": 1700,
        "width": 25
      },
      "services": {
        "bulkyGoods": false
      }
    }
  ],
  "productValueNeeded": true,
  "status": "ACTIVE"
}

{
  "credentials": {
    "key": "text"
  },
  "defaultParcelHeightInCm": 10,
  "defaultParcelLengthInCm": 25,
  "defaultParcelWeightInGram": 1000,
  "defaultParcelWidthInCm": 35,
  "key": "DHL_V2",
  "logoUrl": "text",
  "name": "DHL Köln",
  "parcelLabelClassifications": [
    {
      "nameLocalized": {
        "de_DE": "S-Paket",
        "en_US": "S-Parcel",
        "ru_RU": "S-пакет"
      },
      "dimensions": {
        "customWeight": 1700,
        "height": 50,
        "length": 100,
        "weight": 1700,
        "width": 25
      },
      "name": "S-Parcel",
      "services": {
        "bulkyGoods": false
      }
    }
  ],
  "productValueNeeded": true,
  "status": "ACTIVE",
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42,
  "deliveryType": "SAMEDAY",
  "id": "LGMl2DuvPnfPoSHhYFOm",
  "lifecycle": "GA"
}

Update carrier

patch

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

carrierIdstringRequired

ID of carrier you want to patch

Query parameters

localestringOptional

Provide the localized names and descriptions for the parcel label classifications. If not provided the default locale is used., for example de_DE.

Body

application/json

CarrierPatchActions

versioninteger · int64Required

The version of the document to be used in optimistic locking mechanisms.

Example: 42

Responses

200

Carrier was found & patch-set has been applied. The patched entity is in the body.

application/json

Carrier

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

404

Entity not found

application/json

409

Entity version conflict

application/json

patch

/api/carriers/{carrierId}

HTTPcURLJavaScriptPython

PATCH /api/carriers/{carrierId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 551

{
  "actions": [
    {
      "action": "ModifyCarrier",
      "credentials": {
        "key": "text"
      },
      "defaultParcelHeightInCm": 10,
      "defaultParcelLengthInCm": 25,
      "defaultParcelWeightInGram": 1000,
      "defaultParcelWidthInCm": 35,
      "deliveryType": "SAMEDAY",
      "lifecycle": "GA",
      "logoUrl": "text",
      "name": "DHL Köln",
      "parcelLabelClassifications": [
        {
          "nameLocalized": {
            "de_DE": "S-Paket",
            "en_US": "S-Parcel",
            "ru_RU": "S-пакет"
          },
          "dimensions": {
            "customWeight": 1700,
            "height": 50,
            "length": 100,
            "weight": 1700,
            "width": 25
          },
          "services": {
            "bulkyGoods": false
          }
        }
      ],
      "productValueNeeded": true,
      "status": "ACTIVE"
    }
  ],
  "version": 42
}

{
  "credentials": {
    "key": "text"
  },
  "defaultParcelHeightInCm": 10,
  "defaultParcelLengthInCm": 25,
  "defaultParcelWeightInGram": 1000,
  "defaultParcelWidthInCm": 35,
  "key": "DHL_V2",
  "logoUrl": "text",
  "name": "DHL Köln",
  "parcelLabelClassifications": [
    {
      "nameLocalized": {
        "de_DE": "S-Paket",
        "en_US": "S-Parcel",
        "ru_RU": "S-пакет"
      },
      "dimensions": {
        "customWeight": 1700,
        "height": 50,
        "length": 100,
        "weight": 1700,
        "width": 25
      },
      "name": "S-Parcel",
      "services": {
        "bulkyGoods": false
      }
    }
  ],
  "productValueNeeded": true,
  "status": "ACTIVE",
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42,
  "deliveryType": "SAMEDAY",
  "id": "LGMl2DuvPnfPoSHhYFOm",
  "lifecycle": "GA"
}

Update carrier config

put

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

carrierIdstringRequired

ID of the carrier you want to update the configuration

Body

application/json

or

or

or

or

or

or

or

or

or

Responses

200

Carrier Configuration was found & you were allowed to access it. The result is in the body.

application/json

or

or

or

or

or

or

or

or

or

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

404

Carrier Configuration not found

application/json

put

/api/carriers/{carrierId}/configuration

HTTPcURLJavaScriptPython

PUT /api/carriers/{carrierId}/configuration HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 3455

{
  "additionalWeightInPercent": 1,
  "alternativeReturnAddress": {
    "additionalAddressInfo": "to care of: Mrs. Müller",
    "city": "Langenfeld",
    "country": "DE",
    "customAttributes": {},
    "houseNumber": "42a",
    "phoneNumbers": [
      {
        "customAttributes": {},
        "label": "text",
        "type": "MOBILE",
        "value": "text"
      }
    ],
    "postalCode": "40764",
    "province": "NRW",
    "street": "Hauptstr.",
    "companyName": "Speedy Boxales Ltd.",
    "emailAddresses": [
      {
        "recipient": "'Mailinglist reaching all the employees', 'Marc Fulton, Manager', etc.",
        "value": "text"
      }
    ],
    "resolvedCoordinates": {
      "lat": 50.937531,
      "lon": 6.960279
    },
    "resolvedTimeZone": {
      "offsetInSeconds": 28800,
      "source": "Google Maps API",
      "timeZoneId": "America/Los_Angeles",
      "timeZoneName": "Pacific Standard Time"
    }
  },
  "alternativeSendAddress": {
    "additionalAddressInfo": "to care of: Mrs. Müller",
    "city": "Langenfeld",
    "country": "DE",
    "customAttributes": {},
    "houseNumber": "42a",
    "phoneNumbers": [
      {
        "customAttributes": {},
        "label": "text",
        "type": "MOBILE",
        "value": "text"
      }
    ],
    "postalCode": "40764",
    "province": "NRW",
    "street": "Hauptstr.",
    "companyName": "Speedy Boxales Ltd.",
    "emailAddresses": [
      {
        "recipient": "'Mailinglist reaching all the employees', 'Marc Fulton, Manager', etc.",
        "value": "text"
      }
    ],
    "resolvedCoordinates": {
      "lat": 50.937531,
      "lon": 6.960279
    },
    "resolvedTimeZone": {
      "offsetInSeconds": 28800,
      "source": "Google Maps API",
      "timeZoneId": "America/Los_Angeles",
      "timeZoneName": "Pacific Standard Time"
    }
  },
  "carrierRef": "text",
  "countryServiceMappings": [
    {
      "additionalShippingArticleAttributes": [
        {
          "descriptionLocalized": {
            "de_DE": "Wert",
            "en_US": "Value",
            "ru_RU": "значение"
          },
          "category": "customs",
          "dataType": "NUMBER",
          "description": "text",
          "referencedField": "attributes.weightPerUnit"
        }
      ],
      "additionalShippingAttributes": [
        {
          "descriptionLocalized": {
            "de_DE": "Wert",
            "en_US": "Value",
            "ru_RU": "значение"
          },
          "dataType": "Number",
          "description": "text",
          "referencedField": "dimensions.weight"
        }
      ],
      "carrierProductCategory": "STANDARD",
      "carrierServices": [
        "SIGNATURE"
      ],
      "countAsTransitDayBefore": "text",
      "deliveryCosts": [
        {
          "cost": 10.99,
          "currency": "EUR"
        }
      ],
      "destinations": [
        {
          "countryCode": "DE",
          "postalCodes": [
            "text"
          ]
        }
      ],
      "id": "bc5b581a-8f65-45b0-9f81-6e0d4babbcb2",
      "mandatoryShippingArticleAttributes": [
        {
          "descriptionLocalized": {
            "de_DE": "Wert",
            "en_US": "Value",
            "ru_RU": "значение"
          },
          "category": "customs",
          "dataType": "NUMBER",
          "description": "text",
          "referencedField": "attributes.weightPerUnit"
        }
      ],
      "mandatoryShippingAttributes": [
        {
          "descriptionLocalized": {
            "de_DE": "Wert",
            "en_US": "Value",
            "ru_RU": "значение"
          },
          "dataType": "Number",
          "description": "text",
          "referencedField": "dimensions.weight"
        }
      ],
      "products": [
        "EXPRESS"
      ],
      "source": {
        "countryCode": "DE",
        "postalCodes": [
          "text"
        ]
      },
      "staticCCSMRef": "text",
      "transitTime": {
        "maxTransitDays": 3,
        "minTransitDays": 1
      }
    }
  ],
  "defaultPickUpTime": {
    "end": {
      "hour": 1,
      "minute": 1
    },
    "start": {
      "hour": 1,
      "minute": 1
    }
  },
  "fallBackTrackAndTraceEmail": "[email protected]",
  "id": "text",
  "mustBeWeighed": false,
  "nonDeliveryDaysPerCountryAndProvince": [
    {
      "country": "text",
      "nonDeliveryDays": [
        {
          "nonDeliveryDay": "2020-02-03T00:00:00.000Z",
          "nonDeliveryType": "SINGLE"
        }
      ],
      "nonDeliveryDaysPerProvince": [
        {
          "nonDeliveryDays": [
            {
              "nonDeliveryDay": "2020-02-03T00:00:00.000Z",
              "nonDeliveryType": "SINGLE"
            }
          ],
          "province": "text",
          "recurringNonDeliveryWeekdays": [
            "MONDAY"
          ]
        }
      ],
      "recurringNonDeliveryWeekdays": [
        "MONDAY"
      ]
    }
  ],
  "returnLabel": false,
  "serviceUrl": "text",
  "thresholdPriceValue": {
    "priceRange": {
      "currency": "EUR",
      "decimalPlaces": 2,
      "from": 1299,
      "to": 25000
    },
    "priority": 1
  },
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

{
  "additionalWeightInPercent": 1,
  "alternativeReturnAddress": {
    "additionalAddressInfo": "to care of: Mrs. Müller",
    "city": "Langenfeld",
    "country": "DE",
    "customAttributes": {},
    "houseNumber": "42a",
    "phoneNumbers": [
      {
        "customAttributes": {},
        "label": "text",
        "type": "MOBILE",
        "value": "text"
      }
    ],
    "postalCode": "40764",
    "province": "NRW",
    "street": "Hauptstr.",
    "companyName": "Speedy Boxales Ltd.",
    "emailAddresses": [
      {
        "recipient": "'Mailinglist reaching all the employees', 'Marc Fulton, Manager', etc.",
        "value": "text"
      }
    ],
    "resolvedCoordinates": {
      "lat": 50.937531,
      "lon": 6.960279
    },
    "resolvedTimeZone": {
      "offsetInSeconds": 28800,
      "source": "Google Maps API",
      "timeZoneId": "America/Los_Angeles",
      "timeZoneName": "Pacific Standard Time"
    }
  },
  "alternativeSendAddress": {
    "additionalAddressInfo": "to care of: Mrs. Müller",
    "city": "Langenfeld",
    "country": "DE",
    "customAttributes": {},
    "houseNumber": "42a",
    "phoneNumbers": [
      {
        "customAttributes": {},
        "label": "text",
        "type": "MOBILE",
        "value": "text"
      }
    ],
    "postalCode": "40764",
    "province": "NRW",
    "street": "Hauptstr.",
    "companyName": "Speedy Boxales Ltd.",
    "emailAddresses": [
      {
        "recipient": "'Mailinglist reaching all the employees', 'Marc Fulton, Manager', etc.",
        "value": "text"
      }
    ],
    "resolvedCoordinates": {
      "lat": 50.937531,
      "lon": 6.960279
    },
    "resolvedTimeZone": {
      "offsetInSeconds": 28800,
      "source": "Google Maps API",
      "timeZoneId": "America/Los_Angeles",
      "timeZoneName": "Pacific Standard Time"
    }
  },
  "carrierRef": "text",
  "countryServiceMappings": [
    {
      "additionalShippingArticleAttributes": [
        {
          "descriptionLocalized": {
            "de_DE": "Wert",
            "en_US": "Value",
            "ru_RU": "значение"
          },
          "category": "customs",
          "dataType": "NUMBER",
          "description": "text",
          "referencedField": "attributes.weightPerUnit"
        }
      ],
      "additionalShippingAttributes": [
        {
          "descriptionLocalized": {
            "de_DE": "Wert",
            "en_US": "Value",
            "ru_RU": "значение"
          },
          "dataType": "Number",
          "description": "text",
          "referencedField": "dimensions.weight"
        }
      ],
      "carrierProductCategory": "STANDARD",
      "carrierServices": [
        "SIGNATURE"
      ],
      "countAsTransitDayBefore": "text",
      "deliveryCosts": [
        {
          "cost": 10.99,
          "currency": "EUR"
        }
      ],
      "destinations": [
        {
          "countryCode": "DE",
          "postalCodes": [
            "text"
          ]
        }
      ],
      "id": "bc5b581a-8f65-45b0-9f81-6e0d4babbcb2",
      "mandatoryShippingArticleAttributes": [
        {
          "descriptionLocalized": {
            "de_DE": "Wert",
            "en_US": "Value",
            "ru_RU": "значение"
          },
          "category": "customs",
          "dataType": "NUMBER",
          "description": "text",
          "referencedField": "attributes.weightPerUnit"
        }
      ],
      "mandatoryShippingAttributes": [
        {
          "descriptionLocalized": {
            "de_DE": "Wert",
            "en_US": "Value",
            "ru_RU": "значение"
          },
          "dataType": "Number",
          "description": "text",
          "referencedField": "dimensions.weight"
        }
      ],
      "products": [
        "EXPRESS"
      ],
      "source": {
        "countryCode": "DE",
        "postalCodes": [
          "text"
        ]
      },
      "staticCCSMRef": "text",
      "transitTime": {
        "maxTransitDays": 3,
        "minTransitDays": 1
      }
    }
  ],
  "defaultPickUpTime": {
    "end": {
      "hour": 1,
      "minute": 1
    },
    "start": {
      "hour": 1,
      "minute": 1
    }
  },
  "fallBackTrackAndTraceEmail": "[email protected]",
  "id": "text",
  "mustBeWeighed": false,
  "nonDeliveryDaysPerCountryAndProvince": [
    {
      "country": "text",
      "nonDeliveryDays": [
        {
          "nonDeliveryDay": "2020-02-03T00:00:00.000Z",
          "nonDeliveryType": "SINGLE"
        }
      ],
      "nonDeliveryDaysPerProvince": [
        {
          "nonDeliveryDays": [
            {
              "nonDeliveryDay": "2020-02-03T00:00:00.000Z",
              "nonDeliveryType": "SINGLE"
            }
          ],
          "province": "text",
          "recurringNonDeliveryWeekdays": [
            "MONDAY"
          ]
        }
      ],
      "recurringNonDeliveryWeekdays": [
        "MONDAY"
      ]
    }
  ],
  "returnLabel": false,
  "serviceUrl": "text",
  "thresholdPriceValue": {
    "priceRange": {
      "currency": "EUR",
      "decimalPlaces": 2,
      "from": 1299,
      "to": 25000
    },
    "priority": 1
  },
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

Get carrier config

get

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

carrierIdstringRequired

ID of the carrier you want to get the configuration

Responses

200

Carrier Configuration was found & you were allowed to access it. The result is in the body.

application/json

or

or

or

or

or

or

or

or

or

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

404

Carrier Configuration not found

application/json

get

/api/carriers/{carrierId}/configuration

HTTPcURLJavaScriptPython

GET /api/carriers/{carrierId}/configuration HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "additionalWeightInPercent": 1,
  "alternativeReturnAddress": {
    "additionalAddressInfo": "to care of: Mrs. Müller",
    "city": "Langenfeld",
    "country": "DE",
    "customAttributes": {},
    "houseNumber": "42a",
    "phoneNumbers": [
      {
        "customAttributes": {},
        "label": "text",
        "type": "MOBILE",
        "value": "text"
      }
    ],
    "postalCode": "40764",
    "province": "NRW",
    "street": "Hauptstr.",
    "companyName": "Speedy Boxales Ltd.",
    "emailAddresses": [
      {
        "recipient": "'Mailinglist reaching all the employees', 'Marc Fulton, Manager', etc.",
        "value": "text"
      }
    ],
    "resolvedCoordinates": {
      "lat": 50.937531,
      "lon": 6.960279
    },
    "resolvedTimeZone": {
      "offsetInSeconds": 28800,
      "source": "Google Maps API",
      "timeZoneId": "America/Los_Angeles",
      "timeZoneName": "Pacific Standard Time"
    }
  },
  "alternativeSendAddress": {
    "additionalAddressInfo": "to care of: Mrs. Müller",
    "city": "Langenfeld",
    "country": "DE",
    "customAttributes": {},
    "houseNumber": "42a",
    "phoneNumbers": [
      {
        "customAttributes": {},
        "label": "text",
        "type": "MOBILE",
        "value": "text"
      }
    ],
    "postalCode": "40764",
    "province": "NRW",
    "street": "Hauptstr.",
    "companyName": "Speedy Boxales Ltd.",
    "emailAddresses": [
      {
        "recipient": "'Mailinglist reaching all the employees', 'Marc Fulton, Manager', etc.",
        "value": "text"
      }
    ],
    "resolvedCoordinates": {
      "lat": 50.937531,
      "lon": 6.960279
    },
    "resolvedTimeZone": {
      "offsetInSeconds": 28800,
      "source": "Google Maps API",
      "timeZoneId": "America/Los_Angeles",
      "timeZoneName": "Pacific Standard Time"
    }
  },
  "carrierRef": "text",
  "countryServiceMappings": [
    {
      "additionalShippingArticleAttributes": [
        {
          "descriptionLocalized": {
            "de_DE": "Wert",
            "en_US": "Value",
            "ru_RU": "значение"
          },
          "category": "customs",
          "dataType": "NUMBER",
          "description": "text",
          "referencedField": "attributes.weightPerUnit"
        }
      ],
      "additionalShippingAttributes": [
        {
          "descriptionLocalized": {
            "de_DE": "Wert",
            "en_US": "Value",
            "ru_RU": "значение"
          },
          "dataType": "Number",
          "description": "text",
          "referencedField": "dimensions.weight"
        }
      ],
      "carrierProductCategory": "STANDARD",
      "carrierServices": [
        "SIGNATURE"
      ],
      "countAsTransitDayBefore": "text",
      "deliveryCosts": [
        {
          "cost": 10.99,
          "currency": "EUR"
        }
      ],
      "destinations": [
        {
          "countryCode": "DE",
          "postalCodes": [
            "text"
          ]
        }
      ],
      "id": "bc5b581a-8f65-45b0-9f81-6e0d4babbcb2",
      "mandatoryShippingArticleAttributes": [
        {
          "descriptionLocalized": {
            "de_DE": "Wert",
            "en_US": "Value",
            "ru_RU": "значение"
          },
          "category": "customs",
          "dataType": "NUMBER",
          "description": "text",
          "referencedField": "attributes.weightPerUnit"
        }
      ],
      "mandatoryShippingAttributes": [
        {
          "descriptionLocalized": {
            "de_DE": "Wert",
            "en_US": "Value",
            "ru_RU": "значение"
          },
          "dataType": "Number",
          "description": "text",
          "referencedField": "dimensions.weight"
        }
      ],
      "products": [
        "EXPRESS"
      ],
      "source": {
        "countryCode": "DE",
        "postalCodes": [
          "text"
        ]
      },
      "staticCCSMRef": "text",
      "transitTime": {
        "maxTransitDays": 3,
        "minTransitDays": 1
      }
    }
  ],
  "defaultPickUpTime": {
    "end": {
      "hour": 1,
      "minute": 1
    },
    "start": {
      "hour": 1,
      "minute": 1
    }
  },
  "fallBackTrackAndTraceEmail": "[email protected]",
  "id": "text",
  "mustBeWeighed": false,
  "nonDeliveryDaysPerCountryAndProvince": [
    {
      "country": "text",
      "nonDeliveryDays": [
        {
          "nonDeliveryDay": "2020-02-03T00:00:00.000Z",
          "nonDeliveryType": "SINGLE"
        }
      ],
      "nonDeliveryDaysPerProvince": [
        {
          "nonDeliveryDays": [
            {
              "nonDeliveryDay": "2020-02-03T00:00:00.000Z",
              "nonDeliveryType": "SINGLE"
            }
          ],
          "province": "text",
          "recurringNonDeliveryWeekdays": [
            "MONDAY"
          ]
        }
      ],
      "recurringNonDeliveryWeekdays": [
        "MONDAY"
      ]
    }
  ],
  "returnLabel": false,
  "serviceUrl": "text",
  "thresholdPriceValue": {
    "priceRange": {
      "currency": "EUR",
      "decimalPlaces": 2,
      "from": 1299,
      "to": 25000
    },
    "priority": 1
  },
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

Get carrier

get

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

carrierIdstringRequired

ID of the carrier you want to get

Query parameters

localestringOptional

Provide the localized names and descriptions for the parcel label classifications. If not provided the default locale is used., for example de_DE.

Responses

200

Carrier was found & you were allowed to access it. The result is in the body.

application/json

Carrier

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

404

User not found

application/json

get

/api/carriers/{carrierId}

HTTPcURLJavaScriptPython

GET /api/carriers/{carrierId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "credentials": {
    "key": "text"
  },
  "defaultParcelHeightInCm": 10,
  "defaultParcelLengthInCm": 25,
  "defaultParcelWeightInGram": 1000,
  "defaultParcelWidthInCm": 35,
  "key": "DHL_V2",
  "logoUrl": "text",
  "name": "DHL Köln",
  "parcelLabelClassifications": [
    {
      "nameLocalized": {
        "de_DE": "S-Paket",
        "en_US": "S-Parcel",
        "ru_RU": "S-пакет"
      },
      "dimensions": {
        "customWeight": 1700,
        "height": 50,
        "length": 100,
        "weight": 1700,
        "width": 25
      },
      "name": "S-Parcel",
      "services": {
        "bulkyGoods": false
      }
    }
  ],
  "productValueNeeded": true,
  "status": "ACTIVE",
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42,
  "deliveryType": "SAMEDAY",
  "id": "LGMl2DuvPnfPoSHhYFOm",
  "lifecycle": "GA"
}