Carriers Configuration (Operations)

Endpoints to create, update and read carriers configuration.

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

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: [email protected]

idstringOptional

The id of the carrier configuration

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

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

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": "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": "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": "text",
      "transitTime": {
        "maxTransitDays": 3,
        "minTransitDays": 1
      }
    }
  ],
  "created": "2026-06-06T04:52:19.682Z",
  "defaultPickUpTime": {
    "end": {
      "hour": 1,
      "minute": 1
    },
    "start": {
      "hour": 1,
      "minute": 1
    }
  },
  "fallBackTrackAndTraceEmail": "[email protected]",
  "id": "text",
  "lastModified": "2026-06-06T04:52:19.682Z",
  "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
  },
  "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

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: [email protected]

idstringOptional

The id of the carrier configuration

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

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

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

{
  "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": "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": "text",
      "transitTime": {
        "maxTransitDays": 3,
        "minTransitDays": 1
      }
    }
  ],
  "created": "2026-06-06T04:52:19.682Z",
  "defaultPickUpTime": {
    "end": {
      "hour": 1,
      "minute": 1
    },
    "start": {
      "hour": 1,
      "minute": 1
    }
  },
  "fallBackTrackAndTraceEmail": "[email protected]",
  "id": "text",
  "lastModified": "2026-06-06T04:52:19.682Z",
  "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
  },
  "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": "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": "text",
      "transitTime": {
        "maxTransitDays": 3,
        "minTransitDays": 1
      }
    }
  ],
  "created": "2026-06-06T04:52:19.682Z",
  "defaultPickUpTime": {
    "end": {
      "hour": 1,
      "minute": 1
    },
    "start": {
      "hour": 1,
      "minute": 1
    }
  },
  "fallBackTrackAndTraceEmail": "[email protected]",
  "id": "text",
  "lastModified": "2026-06-06T04:52:19.682Z",
  "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
  },
  "version": 42
}

List country service mappings

get

List country service mappings

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

carrierIdstringRequired

Responses

200

Carrier's countryservicemappings found & you are allowed to access it. The result is in the body.

application/json

CarrierCountryServiceMapping

carrierProductCategorystring · enumOptional

Desired product class to choose when ordering a label

Possible values:

countAsTransitDayBeforestringOptional

Time before which this day counts as a transit day

Example: 12:00

destinationCountriesstring[] · max: 250OptionalDeprecated

deprecated - Use destinations instead.

idstringRequired

Unique identifier for a countryServiceMapping

Example: bc5b581a-8f65-45b0-9f81-6e0d4babbcb2

productsstring[] · max: 50Optional

Array of products for the given mapping

sourceCountrystringOptionalDeprecated

deprecated - Use source instead.

Example: DE

staticCCSMRefstringOptional

Reference to a static country service mapping

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

application/json

404

The requested entity was not found

application/json

get

/api/carriers/{carrierId}/configuration/countryservicemappings

HTTPcURLJavaScriptPython

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

[
  {
    "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": "text",
    "transitTime": {
      "maxTransitDays": 3,
      "minTransitDays": 1
    }
  }
]

Create country service mapping

post

Create country service mapping

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

carrierIdstringRequired

Body

application/json

CarrierCountryServiceMappingForCreation

carrierConfigurationVersioninteger · int64Required

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

carrierProductCategorystring · enumOptional

Desired product class to choose when ordering a label

Possible values:

countAsTransitDayBeforestringOptional

Time before which this day counts as a transit day

destinationCountriesstring[] · min: 1OptionalDeprecated

deprecated - Use destination instead.

productsstring[]Optional

Products for this mapping

sourceCountrystring · min: 2 · max: 2OptionalDeprecated

deprecated - Use source instead.

Responses

201

CarrierCountryServiceMapping successfully created. The result is in the body.

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

application/json

404

The requested entity was not found

application/json

post

/api/carriers/{carrierId}/configuration/countryservicemappings

HTTPcURLJavaScriptPython

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

{
  "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"
    }
  ],
  "carrierConfigurationVersion": 1,
  "carrierProductCategory": "STANDARD",
  "countAsTransitDayBefore": "text",
  "deliveryCosts": [
    {
      "cost": 10.99,
      "currency": "EUR"
    }
  ],
  "destinations": [
    {
      "countryCode": "DE",
      "postalCodes": [
        "text"
      ]
    }
  ],
  "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"
    ]
  },
  "transitTime": {
    "maxTransitDays": 3,
    "minTransitDays": 1
  }
}

{
  "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": "text",
  "transitTime": {
    "maxTransitDays": 3,
    "minTransitDays": 1
  }
}

Get country service mapping

get

Get country service mapping

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

carrierIdstringRequired

countryServiceMappingIdstringRequired

Responses

200

Carrier's countryservicemapping found & you are allowed to access it. The result is in the body.

application/json

CarrierCountryServiceMapping

carrierProductCategorystring · enumOptional

Desired product class to choose when ordering a label

Possible values:

countAsTransitDayBeforestringOptional

Time before which this day counts as a transit day

Example: 12:00

destinationCountriesstring[] · max: 250OptionalDeprecated

deprecated - Use destinations instead.

idstringRequired

Unique identifier for a countryServiceMapping

Example: bc5b581a-8f65-45b0-9f81-6e0d4babbcb2

productsstring[] · max: 50Optional

Array of products for the given mapping

sourceCountrystringOptionalDeprecated

deprecated - Use source instead.

Example: DE

staticCCSMRefstringOptional

Reference to a static country service mapping

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

application/json

404

The requested entity was not found

application/json

get

/api/carriers/{carrierId}/configuration/countryservicemappings/{countryServiceMappingId}

HTTPcURLJavaScriptPython

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

{
  "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": "text",
  "transitTime": {
    "maxTransitDays": 3,
    "minTransitDays": 1
  }
}

Delete country service mapping

delete

Delete country service mapping

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

carrierIdstringRequired

countryServiceMappingIdstringRequired

Responses

200

CarrierCountryServiceMapping successfully deleted.

No content

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

application/json

404

The requested entity was not found

application/json

delete

/api/carriers/{carrierId}/configuration/countryservicemappings/{countryServiceMappingId}

HTTPcURLJavaScriptPython

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

No content

Update country service mapping

patch

Update country service mapping

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

carrierIdstringRequired

countryServiceMappingIdstringRequired

Body

application/json

CarrierCountryServiceMappingForUpdate

carrierConfigurationVersioninteger · int64Required

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

carrierProductCategorystring · enumOptional

Desired product class to choose when ordering a label

Possible values:

countAsTransitDayBeforestringOptional

Time before which this day counts as a transit day

destinationCountriesstring[] · min: 1OptionalDeprecated

deprecated - Use destination instead.

productsstring[]Optional

Array of products for the given mapping

sourceCountrystring · min: 2 · max: 2OptionalDeprecated

deprecated - Use source instead.

Responses

200

CarrierCountryServiceMapping successfully updated. The result is in the body.

application/json

CarrierCountryServiceMapping

carrierProductCategorystring · enumOptional

Desired product class to choose when ordering a label

Possible values:

countAsTransitDayBeforestringOptional

Time before which this day counts as a transit day

Example: 12:00

destinationCountriesstring[] · max: 250OptionalDeprecated

deprecated - Use destinations instead.

idstringRequired

Unique identifier for a countryServiceMapping

Example: bc5b581a-8f65-45b0-9f81-6e0d4babbcb2

productsstring[] · max: 50Optional

Array of products for the given mapping

sourceCountrystringOptionalDeprecated

deprecated - Use source instead.

Example: DE

staticCCSMRefstringOptional

Reference to a static country service mapping

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

application/json

404

The requested entity was not found

application/json

patch

/api/carriers/{carrierId}/configuration/countryservicemappings/{countryServiceMappingId}

HTTPcURLJavaScriptPython

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

{
  "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"
    }
  ],
  "carrierConfigurationVersion": 1,
  "carrierProductCategory": "STANDARD",
  "countAsTransitDayBefore": "text",
  "deliveryCosts": [
    {
      "cost": 10.99,
      "currency": "EUR"
    }
  ],
  "destinations": [
    {
      "countryCode": "DE",
      "postalCodes": [
        "text"
      ]
    }
  ],
  "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"
    ]
  },
  "transitTime": {
    "maxTransitDays": 3,
    "minTransitDays": 1
  }
}

{
  "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": "text",
  "transitTime": {
    "maxTransitDays": 3,
    "minTransitDays": 1
  }
}

Get transit time config

get

This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

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

application/json

TransitTimeConfiguration

createdstring · date-timeOptional

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

Example: 2020-02-03T08:45:51.525Z

lastModifiedstring · date-timeOptional

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

Example: 2020-02-03T09:45:51.525Z

versioninteger · int64Required

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

Example: 42

calculationStrategystring · enumRequiredPossible values:

idstringRequired

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

Cutoff time configuration not found

application/json

get

/api/configurations/transittime

HTTPcURLJavaScriptPython

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

{
  "calculationStrategy": "EARLIEST",
  "id": "text",
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}