Carrier configuration endpoints

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

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
}

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

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 country service mapping

get

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

carrierIdstringRequired

ID of the carrier you want to get a countryservicemapping for

countryServiceMappingIdstringRequired

ID of the countryservicemapping

Responses

200

Carrier's countryservicemapping found & you are allowed to access it. 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 endpoint

application/json

404

Carrier's countryservicemappings Configuration 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": "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
  }
}

List country service mappings

get

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

carrierIdstringRequired

ID of the carrier you want to get the countryservicemappings for

Responses

200

Carrier's countryservicemappings found & you are allowed to access it. 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 endpoint

application/json

404

Carrier's countryservicemappings Configuration 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": "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
    }
  }
]

Create country service mapping

post

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

carrierIdstringRequired

ID of the carrier you want to create a countryservicemapping for

Body

application/json

CarrierCountryServiceMappingForCreation

carrierConfigurationVersioninteger · int64Required

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

Example: 42

carrierProductCategorystring · enumOptional

Desired product class to choose when ordering a label, this is not a carrier specific value

Possible values:

countAsTransitDayBeforestringOptional

destinationCountriesstring[] · min: 1OptionalDeprecated

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

@deprecated Use destination instead.

Example: DE

productsstring[]OptionalExample: EXPRESS

sourceCountrystring · min: 2 · max: 2OptionalDeprecated

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

@deprecated Use source instead.

Example: DE

Responses

201

CarrierCountryServiceMapping successfully created. The result is in the body.

application/json

CarrierCountryServiceMapping

carrierProductCategorystring · enumOptional

Desired product class to choose when ordering a label, this is not a carrier specific value

Possible values:

countAsTransitDayBeforestringOptional

destinationCountriesstring[] · min: 1OptionalDeprecated

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

@deprecated - Use destination instead.

Example: DE

idstringRequired

unique identifier for a countryServiceMapping

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

productsstring[]Optional

Array of products for the given mapping

Example: EXPRESS

sourceCountrystring · min: 2 · max: 2OptionalDeprecated

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

@deprecated - Use source instead.

Example: DE

staticCCSMRefstringOptional

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

{
  "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": 42,
  "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"
    }
  ],
  "mandatoryShippingItemAttributes": [
    {
      "descriptionLocalized": {
        "de_DE": "Wert",
        "en_US": "Value",
        "ru_RU": "значение"
      },
      "dataType": "Number",
      "description": "text",
      "referencedField": "description"
    }
  ],
  "products": [
    "EXPRESS"
  ],
  "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": "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
  }
}

Delete country service mapping

delete

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

carrierIdstringRequired

ID of the carrier you want to delete a countryservicemapping from

countryServiceMappingIdstringRequired

ID of the countryservicemapping

Responses

200

CarrierCountryServiceMapping successfully deleted.

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 or CarrierCountryServiceMapping 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

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

carrierIdstringRequired

ID of the carrier you want to update a countryservicemapping of

countryServiceMappingIdstringRequired

ID of the countryservicemapping

Body

application/json

CarrierCountryServiceMappingForUpdate

carrierConfigurationVersioninteger · int64Required

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

Example: 42

carrierProductCategorystring · enumOptional

Desired product class to choose when ordering a label, this is not a carrier specific value

Possible values:

countAsTransitDayBeforestringOptional

destinationCountriesstring[] · min: 1OptionalDeprecated

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

@deprecated Use destination instead.

Example: DE

productsstring[]Optional

Array of products for the given mapping

Example: EXPRESS

sourceCountrystring · min: 2 · max: 2OptionalDeprecated

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

@deprecated Use source instead.

Example: DE

Responses

200

CarrierCountryServiceMapping successfully updated. 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 endpoint

application/json

404

Carrier or CarrierCountryServiceMapping 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: 1394

{
  "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": 42,
  "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"
    }
  ],
  "mandatoryShippingItemAttributes": [
    {
      "descriptionLocalized": {
        "de_DE": "Wert",
        "en_US": "Value",
        "ru_RU": "значение"
      },
      "dataType": "Number",
      "description": "text",
      "referencedField": "description"
    }
  ],
  "products": [
    "EXPRESS"
  ],
  "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": "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
  }
}