Carrier endpoints

List carriers

get

List carriers

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

sizenumberOptional

startAfterIdstringOptional

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

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": "2026-08-07T19:20:34.950Z",
      "deliveryType": "SAMEDAY",
      "id": "LGMl2DuvPnfPoSHhYFOm",
      "key": "DHL_V2",
      "lastModified": "2026-08-07T19:20:34.950Z",
      "lifecycle": "GA",
      "name": "DHL",
      "status": "ACTIVE",
      "version": 42
    }
  ],
  "total": 42
}

Get carrier

get

Get carrier

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

carrierIdstringRequired

Responses

200

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

application/json

Carrier

createdstring · date-timeOptional

The date this entity was created at the platform. This value is generated by the service.

defaultParcelHeightInCmnumber · min: 1Required

Default height in cm

Default: 10Example: 10

defaultParcelLengthInCmnumber · min: 1Required

Default length in cm

Default: 25Example: 25

defaultParcelWeightInGramnumber · min: 1Optional

Default weight for a parcel in gram

Default: 1000Example: 1000

defaultParcelWidthInCmnumber · min: 1Required

Default width in cm

Default: 35Example: 35

deliveryTypestring · enumOptional

Provided delivery of this CEP. Default: DELIVERY

Possible values:

idstringRequired

The id of the carrier

Example: LGMl2DuvPnfPoSHhYFOm

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

lastModifiedstring · date-timeOptional

The date this entity was modified last. This value is generated by the service.

lifecyclestring · enumOptional

Used to determine if a carrier is available for configuration. GA carriers are generally available and are covered by our SLA. BETA carriers are available, but subject to change and not covered by SLA. ALPHA carriers are not implemented completely, yet. Default: GA

Possible values:

logoUrlstring · min: 1Optional

URL of the carrier logo

Example: https://example.com/resource

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:

versionintegerRequired

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

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

The requested entity was 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: */*

{
  "created": "2026-08-07T19:20:34.950Z",
  "credentials": {
    "key": "text"
  },
  "defaultParcelHeightInCm": 10,
  "defaultParcelLengthInCm": 25,
  "defaultParcelWeightInGram": 1000,
  "defaultParcelWidthInCm": 35,
  "deliveryType": "SAMEDAY",
  "id": "LGMl2DuvPnfPoSHhYFOm",
  "key": "DHL_V2",
  "lastModified": "2026-08-07T19:20:34.950Z",
  "lifecycle": "GA",
  "logoUrl": "https://example.com/resource",
  "name": "DHL Köln",
  "parcelLabelClassifications": [
    {
      "nameLocalized": {
        "de_DE": "S-Paket",
        "en_US": "S-Parcel",
        "ru_RU": "S-пакет"
      },
      "dimensions": {
        "customWeight": 1,
        "height": 1,
        "length": 1,
        "weight": 1,
        "width": 1
      },
      "name": "S-Parcel",
      "services": {
        "bulkyGoods": false
      }
    }
  ],
  "productValueNeeded": true,
  "status": "ACTIVE",
  "version": 42
}

Create carrier

post

Create carrier

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

CarrierForCreation

defaultParcelHeightInCmnumber · min: 1Optional

Default height in cm

Default: 10Example: 10

defaultParcelLengthInCmnumber · min: 1Optional

Default length in cm

Default: 25Example: 25

defaultParcelWeightInGramnumber · min: 1Optional

Default weight for a parcel in gram

Default: 1000Example: 1000

defaultParcelWidthInCmnumber · min: 1Optional

Default width in cm

Default: 35Example: 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

URL of the carrier logo

Example: https://example.com/resource

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

Carrier

createdstring · date-timeOptional

The date this entity was created at the platform. This value is generated by the service.

defaultParcelHeightInCmnumber · min: 1Required

Default height in cm

Default: 10Example: 10

defaultParcelLengthInCmnumber · min: 1Required

Default length in cm

Default: 25Example: 25

defaultParcelWeightInGramnumber · min: 1Optional

Default weight for a parcel in gram

Default: 1000Example: 1000

defaultParcelWidthInCmnumber · min: 1Required

Default width in cm

Default: 35Example: 35

deliveryTypestring · enumOptional

Provided delivery of this CEP. Default: DELIVERY

Possible values:

idstringRequired

The id of the carrier

Example: LGMl2DuvPnfPoSHhYFOm

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

lastModifiedstring · date-timeOptional

The date this entity was modified last. This value is generated by the service.

lifecyclestring · enumOptional

Used to determine if a carrier is available for configuration. GA carriers are generally available and are covered by our SLA. BETA carriers are available, but subject to change and not covered by SLA. ALPHA carriers are not implemented completely, yet. Default: GA

Possible values:

logoUrlstring · min: 1Optional

URL of the carrier logo

Example: https://example.com/resource

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:

versionintegerRequired

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

Example: 42

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: 486

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

{
  "created": "2026-08-07T19:20:34.950Z",
  "credentials": {
    "key": "text"
  },
  "defaultParcelHeightInCm": 10,
  "defaultParcelLengthInCm": 25,
  "defaultParcelWeightInGram": 1000,
  "defaultParcelWidthInCm": 35,
  "deliveryType": "SAMEDAY",
  "id": "LGMl2DuvPnfPoSHhYFOm",
  "key": "DHL_V2",
  "lastModified": "2026-08-07T19:20:34.950Z",
  "lifecycle": "GA",
  "logoUrl": "https://example.com/resource",
  "name": "DHL Köln",
  "parcelLabelClassifications": [
    {
      "nameLocalized": {
        "de_DE": "S-Paket",
        "en_US": "S-Parcel",
        "ru_RU": "S-пакет"
      },
      "dimensions": {
        "customWeight": 1,
        "height": 1,
        "length": 1,
        "weight": 1,
        "width": 1
      },
      "name": "S-Parcel",
      "services": {
        "bulkyGoods": false
      }
    }
  ],
  "productValueNeeded": true,
  "status": "ACTIVE",
  "version": 42
}

Update carrier

patch

Update carrier

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

carrierIdstringRequired

Body

application/json

CarrierPatchActions

versioninteger · int64Required

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

Example: 1

Responses

200

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

application/json

Carrier

createdstring · date-timeOptional

The date this entity was created at the platform. This value is generated by the service.

defaultParcelHeightInCmnumber · min: 1Required

Default height in cm

Default: 10Example: 10

defaultParcelLengthInCmnumber · min: 1Required

Default length in cm

Default: 25Example: 25

defaultParcelWeightInGramnumber · min: 1Optional

Default weight for a parcel in gram

Default: 1000Example: 1000

defaultParcelWidthInCmnumber · min: 1Required

Default width in cm

Default: 35Example: 35

deliveryTypestring · enumOptional

Provided delivery of this CEP. Default: DELIVERY

Possible values:

idstringRequired

The id of the carrier

Example: LGMl2DuvPnfPoSHhYFOm

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

lastModifiedstring · date-timeOptional

The date this entity was modified last. This value is generated by the service.

lifecyclestring · enumOptional

Used to determine if a carrier is available for configuration. GA carriers are generally available and are covered by our SLA. BETA carriers are available, but subject to change and not covered by SLA. ALPHA carriers are not implemented completely, yet. Default: GA

Possible values:

logoUrlstring · min: 1Optional

URL of the carrier logo

Example: https://example.com/resource

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:

versionintegerRequired

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

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

The requested entity was not found

application/json

409

A version conflict occurred.

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: 559

{
  "actions": [
    {
      "action": "ModifyCarrier",
      "credentials": {
        "key": "text"
      },
      "defaultParcelHeightInCm": 10,
      "defaultParcelLengthInCm": 25,
      "defaultParcelWeightInGram": 1000,
      "defaultParcelWidthInCm": 35,
      "deliveryType": "SAMEDAY",
      "lifecycle": "GA",
      "logoUrl": "https://example.com/resource",
      "name": "text",
      "parcelLabelClassifications": [
        {
          "nameLocalized": {
            "de_DE": "S-Paket",
            "en_US": "S-Parcel",
            "ru_RU": "S-пакет"
          },
          "dimensions": {
            "customWeight": 1,
            "height": 1,
            "length": 1,
            "weight": 1,
            "width": 1
          },
          "services": {
            "bulkyGoods": false
          }
        }
      ],
      "productValueNeeded": true,
      "status": "ACTIVE"
    }
  ],
  "version": 1
}

{
  "created": "2026-08-07T19:20:34.950Z",
  "credentials": {
    "key": "text"
  },
  "defaultParcelHeightInCm": 10,
  "defaultParcelLengthInCm": 25,
  "defaultParcelWeightInGram": 1000,
  "defaultParcelWidthInCm": 35,
  "deliveryType": "SAMEDAY",
  "id": "LGMl2DuvPnfPoSHhYFOm",
  "key": "DHL_V2",
  "lastModified": "2026-08-07T19:20:34.950Z",
  "lifecycle": "GA",
  "logoUrl": "https://example.com/resource",
  "name": "DHL Köln",
  "parcelLabelClassifications": [
    {
      "nameLocalized": {
        "de_DE": "S-Paket",
        "en_US": "S-Parcel",
        "ru_RU": "S-пакет"
      },
      "dimensions": {
        "customWeight": 1,
        "height": 1,
        "length": 1,
        "weight": 1,
        "width": 1
      },
      "name": "S-Parcel",
      "services": {
        "bulkyGoods": false
      }
    }
  ],
  "productValueNeeded": true,
  "status": "ACTIVE",
  "version": 42
}

Get carrier config

get

Retrieves the configuration for a specific carrier by its ID. If no configuration exists, a default one is created and returned.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

carrierIdstringRequired

Responses

200

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

application/json

CarrierConfiguration

additionalWeightInPercentnumberOptional

It is an amount of percentage for packaging weight which will be added to the calculated shipping weight

carrierRefstringRequired

Reference to the carrier this configuration belongs to

Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f

createdstring · date-timeOptional

The date this entity was created at the platform. This value is generated by the service.

fallBackTrackAndTraceEmailstring · email · min: 1Optional

EmailAddress used to receive track and trace information when no other emailaddress was provided

Example: [e-mail]

idstringOptional

The id of the carrier configuration

Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f

lastModifiedstring · date-timeOptional

The date this entity was modified last. This value is generated by the service.

mustBeWeighedbooleanOptional

Indicates if the content of a parcel must be weighed before ordering a label

Default: falseExample: false

returnLabelbooleanRequired

When enabled, a return label will be created by creating a shipping label

Default: falseExample: false

serviceUrlstringOptional

Service URL for this carrier configuration

Example: https://example.com/resource

versionintegerRequired

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

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

The requested entity was 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": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
  "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": "12:00",
      "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": [
        "text"
      ],
      "source": {
        "countryCode": "DE",
        "postalCodes": [
          "text"
        ]
      },
      "staticCCSMRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
      "transitTime": "2026-06-17T12:00:00.000Z"
    }
  ],
  "created": "2026-08-07T19:20:34.950Z",
  "defaultPickUpTime": "2026-06-17T12:00:00.000Z",
  "fallBackTrackAndTraceEmail": "[e-mail]",
  "id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
  "lastModified": "2026-08-07T19:20:34.950Z",
  "mustBeWeighed": false,
  "nonDeliveryDaysPerCountryAndProvince": [
    {
      "country": "US",
      "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": "https://example.com/resource",
  "thresholdPriceValue": {
    "priceRange": {
      "currency": "EUR",
      "decimalPlaces": 2,
      "from": 1299,
      "to": 25000
    },
    "priority": 1
  },
  "version": 42
}

Update carrier config

put

Updates the complete configuration for a specific carrier. This includes settings like return labels, weight adjustments, non-delivery days, country service mappings, and pick-up times.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

carrierIdstringRequired

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

CarrierConfiguration

additionalWeightInPercentnumberOptional

It is an amount of percentage for packaging weight which will be added to the calculated shipping weight

carrierRefstringRequired

Reference to the carrier this configuration belongs to

Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f

createdstring · date-timeOptional

The date this entity was created at the platform. This value is generated by the service.

fallBackTrackAndTraceEmailstring · email · min: 1Optional

EmailAddress used to receive track and trace information when no other emailaddress was provided

Example: [e-mail]

idstringOptional

The id of the carrier configuration

Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f

lastModifiedstring · date-timeOptional

The date this entity was modified last. This value is generated by the service.

mustBeWeighedbooleanOptional

Indicates if the content of a parcel must be weighed before ordering a label

Default: falseExample: false

returnLabelbooleanRequired

When enabled, a return label will be created by creating a shipping label

Default: falseExample: false

serviceUrlstringOptional

Service URL for this carrier configuration

Example: https://example.com/resource

versionintegerRequired

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

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

The requested entity was 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: 3525

{
  "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": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
  "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": "12:00",
      "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": [
        "text"
      ],
      "source": {
        "countryCode": "DE",
        "postalCodes": [
          "text"
        ]
      },
      "staticCCSMRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
      "transitTime": "2026-06-17T12:00:00.000Z"
    }
  ],
  "created": "2026-08-07T19:20:34.950Z",
  "defaultPickUpTime": "2026-06-17T12:00:00.000Z",
  "fallBackTrackAndTraceEmail": "[e-mail]",
  "id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
  "lastModified": "2026-08-07T19:20:34.950Z",
  "mustBeWeighed": false,
  "nonDeliveryDaysPerCountryAndProvince": [
    {
      "country": "US",
      "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": "https://example.com/resource",
  "thresholdPriceValue": {
    "priceRange": {
      "currency": "EUR",
      "decimalPlaces": 2,
      "from": 1299,
      "to": 25000
    },
    "priority": 1
  },
  "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": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
  "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": "12:00",
      "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": [
        "text"
      ],
      "source": {
        "countryCode": "DE",
        "postalCodes": [
          "text"
        ]
      },
      "staticCCSMRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
      "transitTime": "2026-06-17T12:00:00.000Z"
    }
  ],
  "created": "2026-08-07T19:20:34.950Z",
  "defaultPickUpTime": "2026-06-17T12:00:00.000Z",
  "fallBackTrackAndTraceEmail": "[e-mail]",
  "id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
  "lastModified": "2026-08-07T19:20:34.950Z",
  "mustBeWeighed": false,
  "nonDeliveryDaysPerCountryAndProvince": [
    {
      "country": "US",
      "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": "https://example.com/resource",
  "thresholdPriceValue": {
    "priceRange": {
      "currency": "EUR",
      "decimalPlaces": 2,
      "from": 1299,
      "to": 25000
    },
    "priority": 1
  },
  "version": 42
}