# Carriers (Operations)

Endpoints to create, update and read carriers.

## List carriers

> List carriers

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read carriers.","name":"Carriers (Operations)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"StrippedCarriers":{"properties":{"carriers":{"description":"List of carriers","items":{"$ref":"#/components/schemas/StrippedCarrier"},"type":"array"},"total":{"description":"Total number of found entities for this query","type":"integer"}},"title":"StrippedCarriers","type":"object","description":"StrippedCarriers"},"StrippedCarrier":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"deliveryType":{"description":"The delivery type of this carrier","enum":["SAMEDAY","DELIVERY"],"type":"string"},"id":{"description":"The id of the carrier","type":"string"},"key":{"description":"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.","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"lifecycle":{"description":"The lifecycle of this carrier","enum":["GA","BETA","ALPHA"],"type":"string"},"name":{"description":"This is the well known name for a supported CEP partner. Can be adapted to the clients needs.","type":"string"},"status":{"description":"The status of this carrier","enum":["ACTIVE","INACTIVE"],"type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","type":"integer"}},"required":["id","key","name","version"],"title":"StrippedCarrier","type":"object","description":"StrippedCarrier"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/carriers":{"get":{"deprecated":false,"description":"List carriers","operationId":"getCarriers","parameters":[{"in":"query","name":"size","required":false,"schema":{"type":"number"}},{"in":"query","name":"startAfterId","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StrippedCarriers"}}},"description":"The current list of available carriers"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this"}},"summary":"List carriers","tags":["Carriers (Operations)"]}}}}
```

## Create carrier

> Create carrier

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read carriers.","name":"Carriers (Operations)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"CarrierForCreation":{"properties":{"credentials":{"allOf":[{"$ref":"#/components/schemas/AbstractCarrierCredentials"}],"description":"Credentials for the carrier"},"defaultParcelHeightInCm":{"default":10,"description":"Default height in cm","minimum":1,"type":"number"},"defaultParcelLengthInCm":{"default":25,"description":"Default length in cm","minimum":1,"type":"number"},"defaultParcelWeightInGram":{"default":1000,"description":"Default weight for a parcel in gram","minimum":1,"type":"number"},"defaultParcelWidthInCm":{"default":35,"description":"Default width in cm","minimum":1,"type":"number"},"key":{"description":"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.","type":"string"},"logoUrl":{"description":"URL of the carrier logo","minLength":1,"type":"string"},"name":{"description":"This is the well known name for a supported CEP partner. Can be adapted to the clients needs.","type":"string"},"parcelLabelClassifications":{"description":"Parcel label classifications for this carrier","items":{"$ref":"#/components/schemas/ParcelLabelClassificationForCreation"},"type":"array"},"productValueNeeded":{"description":"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)","type":"boolean"},"status":{"description":"It is taken into consideration for all carriers. Default: INACTIVE","enum":["ACTIVE","INACTIVE"],"type":"string"}},"required":["key","name"],"title":"CarrierForCreation","type":"object","description":"CarrierForCreation"},"AbstractCarrierCredentials":{"properties":{"key":{"description":"The key identifying the carrier credentials type","type":"string"}},"required":["key"],"title":"AbstractCarrierCredentials","type":"object","description":"AbstractCarrierCredentials"},"ParcelLabelClassificationForCreation":{"properties":{"nameLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized name for parcel label classification"},"dimensions":{"allOf":[{"$ref":"#/components/schemas/ParcelDimensions"}],"description":"Dimensions for this parcel label classification"},"services":{"allOf":[{"$ref":"#/components/schemas/ParcelLabelClassificationServices"}],"description":"Services available for this parcel label classification"}},"required":["nameLocalized","dimensions"],"title":"ParcelLabelClassificationForCreation","type":"object","description":"ParcelLabelClassificationForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides Localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/localization","title":"LocaleString","type":"object"},"ParcelDimensions":{"additionalProperties":false,"nullable":true,"properties":{"customWeight":{"type":"number"},"height":{"type":"number"},"length":{"type":"number"},"weight":{"type":"number"},"width":{"type":"number"}},"type":"object","title":"ParcelDimensions","description":"ParcelDimensions"},"ParcelLabelClassificationServices":{"properties":{"bulkyGoods":{"default":false,"description":"Indicates if this label classification is for bulky goods","type":"boolean"}},"title":"ParcelLabelClassificationServices","type":"object","description":"ParcelLabelClassificationServices"},"Carrier":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"credentials":{"allOf":[{"$ref":"#/components/schemas/AbstractCarrierCredentials"}],"description":"Credentials for the carrier"},"defaultParcelHeightInCm":{"default":10,"description":"Default height in cm","minimum":1,"type":"number"},"defaultParcelLengthInCm":{"default":25,"description":"Default length in cm","minimum":1,"type":"number"},"defaultParcelWeightInGram":{"default":1000,"description":"Default weight for a parcel in gram","minimum":1,"type":"number"},"defaultParcelWidthInCm":{"default":35,"description":"Default width in cm","minimum":1,"type":"number"},"deliveryType":{"description":"Provided delivery of this CEP. Default: DELIVERY","enum":["SAMEDAY","DELIVERY"],"type":"string"},"id":{"description":"The id of the carrier","type":"string"},"key":{"description":"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.","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"lifecycle":{"description":"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","enum":["GA","BETA","ALPHA"],"type":"string"},"logoUrl":{"description":"URL of the carrier logo","minLength":1,"type":"string"},"name":{"description":"This is the well known name for a supported CEP partner. Can be adapted to the clients needs.","type":"string"},"parcelLabelClassifications":{"description":"Parcel label classifications for this carrier","items":{"$ref":"#/components/schemas/ParcelLabelClassification"},"type":"array"},"productValueNeeded":{"description":"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)","type":"boolean"},"status":{"description":"It is taken into consideration for all carriers. Default: INACTIVE","enum":["ACTIVE","INACTIVE"],"type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","type":"integer"}},"required":["id","version","key","name","defaultParcelWidthInCm","defaultParcelLengthInCm","defaultParcelHeightInCm"],"title":"Carrier","type":"object","description":"Carrier"},"ParcelLabelClassification":{"properties":{"nameLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized name for parcel label classification"},"dimensions":{"allOf":[{"$ref":"#/components/schemas/ParcelDimensions"}],"description":"Dimensions for this parcel label classification"},"name":{"description":"Name of the parcel label classification","type":"string"},"services":{"allOf":[{"$ref":"#/components/schemas/ParcelLabelClassificationServices"}],"description":"Services available for this parcel label classification"}},"required":["nameLocalized","dimensions"],"title":"ParcelLabelClassification","type":"object","description":"ParcelLabelClassification"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/carriers":{"post":{"deprecated":false,"description":"Create carrier","operationId":"addCarrier","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CarrierForCreation"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Carrier"}}},"description":"The carrier was successfully created. The Location header contains the URL of the carrier."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Invalid input. See response for details."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this"}},"summary":"Create carrier","tags":["Carriers (Operations)"]}}}}
```

## Get carrier

> Get carrier

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read carriers.","name":"Carriers (Operations)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"Carrier":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"credentials":{"allOf":[{"$ref":"#/components/schemas/AbstractCarrierCredentials"}],"description":"Credentials for the carrier"},"defaultParcelHeightInCm":{"default":10,"description":"Default height in cm","minimum":1,"type":"number"},"defaultParcelLengthInCm":{"default":25,"description":"Default length in cm","minimum":1,"type":"number"},"defaultParcelWeightInGram":{"default":1000,"description":"Default weight for a parcel in gram","minimum":1,"type":"number"},"defaultParcelWidthInCm":{"default":35,"description":"Default width in cm","minimum":1,"type":"number"},"deliveryType":{"description":"Provided delivery of this CEP. Default: DELIVERY","enum":["SAMEDAY","DELIVERY"],"type":"string"},"id":{"description":"The id of the carrier","type":"string"},"key":{"description":"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.","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"lifecycle":{"description":"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","enum":["GA","BETA","ALPHA"],"type":"string"},"logoUrl":{"description":"URL of the carrier logo","minLength":1,"type":"string"},"name":{"description":"This is the well known name for a supported CEP partner. Can be adapted to the clients needs.","type":"string"},"parcelLabelClassifications":{"description":"Parcel label classifications for this carrier","items":{"$ref":"#/components/schemas/ParcelLabelClassification"},"type":"array"},"productValueNeeded":{"description":"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)","type":"boolean"},"status":{"description":"It is taken into consideration for all carriers. Default: INACTIVE","enum":["ACTIVE","INACTIVE"],"type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","type":"integer"}},"required":["id","version","key","name","defaultParcelWidthInCm","defaultParcelLengthInCm","defaultParcelHeightInCm"],"title":"Carrier","type":"object","description":"Carrier"},"AbstractCarrierCredentials":{"properties":{"key":{"description":"The key identifying the carrier credentials type","type":"string"}},"required":["key"],"title":"AbstractCarrierCredentials","type":"object","description":"AbstractCarrierCredentials"},"ParcelLabelClassification":{"properties":{"nameLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized name for parcel label classification"},"dimensions":{"allOf":[{"$ref":"#/components/schemas/ParcelDimensions"}],"description":"Dimensions for this parcel label classification"},"name":{"description":"Name of the parcel label classification","type":"string"},"services":{"allOf":[{"$ref":"#/components/schemas/ParcelLabelClassificationServices"}],"description":"Services available for this parcel label classification"}},"required":["nameLocalized","dimensions"],"title":"ParcelLabelClassification","type":"object","description":"ParcelLabelClassification"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides Localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/localization","title":"LocaleString","type":"object"},"ParcelDimensions":{"additionalProperties":false,"nullable":true,"properties":{"customWeight":{"type":"number"},"height":{"type":"number"},"length":{"type":"number"},"weight":{"type":"number"},"width":{"type":"number"}},"type":"object","title":"ParcelDimensions","description":"ParcelDimensions"},"ParcelLabelClassificationServices":{"properties":{"bulkyGoods":{"default":false,"description":"Indicates if this label classification is for bulky goods","type":"boolean"}},"title":"ParcelLabelClassificationServices","type":"object","description":"ParcelLabelClassificationServices"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/carriers/{carrierId}":{"get":{"deprecated":false,"description":"Get carrier","operationId":"getCarrier","parameters":[{"in":"path","name":"carrierId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Carrier"}}},"description":"Carrier was found & you were allowed to access it. The result is in the body."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"The requested entity was not found"}},"summary":"Get carrier","tags":["Carriers (Operations)"]}}}}
```

## Update carrier

> Update carrier

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read carriers.","name":"Carriers (Operations)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"CarrierPatchActions":{"properties":{"actions":{"description":"Array of modification actions to apply to the carrier","items":{"$ref":"#/components/schemas/ModifyCarrier"},"minItems":1,"type":"array"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["actions","version"],"title":"CarrierPatchActions","type":"object","description":"CarrierPatchActions"},"ModifyCarrier":{"properties":{"action":{"description":"Use value 'ModifyCarrier', because you want to modify a carrier","enum":["ModifyCarrier"],"type":"string"},"credentials":{"allOf":[{"$ref":"#/components/schemas/AbstractModifyCarrierCredentials"}],"description":"Credentials for the carrier"},"defaultParcelHeightInCm":{"default":10,"description":"Default height in cm","minimum":1,"type":"number"},"defaultParcelLengthInCm":{"default":25,"description":"Default length in cm","minimum":1,"type":"number"},"defaultParcelWeightInGram":{"default":1000,"description":"Default weight for a parcel in gram","minimum":1,"type":"number"},"defaultParcelWidthInCm":{"default":35,"description":"Default width in cm","minimum":1,"type":"number"},"deliveryType":{"description":"Provided delivery of this CEP","enum":["SAMEDAY","DELIVERY"],"type":"string"},"lifecycle":{"description":"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.","enum":["GA","BETA","ALPHA"],"type":"string"},"logoUrl":{"description":"URL of the carrier logo","minLength":1,"type":"string"},"name":{"description":"This is the well known name for a supported CEP partner. Can be adapted to the clients needs.","type":"string"},"parcelLabelClassifications":{"description":"Parcel label classifications for this carrier","items":{"$ref":"#/components/schemas/ParcelLabelClassificationForCreation"},"type":"array"},"productValueNeeded":{"description":"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)","type":"boolean"},"status":{"description":"It is taken into consideration for all carriers","enum":["ACTIVE","INACTIVE"],"type":"string"}},"required":["action"],"title":"ModifyCarrier","type":"object","description":"ModifyCarrier"},"AbstractModifyCarrierCredentials":{"properties":{"key":{"description":"The key identifying the carrier credentials type","type":"string"}},"required":["key"],"title":"AbstractModifyCarrierCredentials","type":"object","description":"AbstractModifyCarrierCredentials"},"ParcelLabelClassificationForCreation":{"properties":{"nameLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized name for parcel label classification"},"dimensions":{"allOf":[{"$ref":"#/components/schemas/ParcelDimensions"}],"description":"Dimensions for this parcel label classification"},"services":{"allOf":[{"$ref":"#/components/schemas/ParcelLabelClassificationServices"}],"description":"Services available for this parcel label classification"}},"required":["nameLocalized","dimensions"],"title":"ParcelLabelClassificationForCreation","type":"object","description":"ParcelLabelClassificationForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides Localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/localization","title":"LocaleString","type":"object"},"ParcelDimensions":{"additionalProperties":false,"nullable":true,"properties":{"customWeight":{"type":"number"},"height":{"type":"number"},"length":{"type":"number"},"weight":{"type":"number"},"width":{"type":"number"}},"type":"object","title":"ParcelDimensions","description":"ParcelDimensions"},"ParcelLabelClassificationServices":{"properties":{"bulkyGoods":{"default":false,"description":"Indicates if this label classification is for bulky goods","type":"boolean"}},"title":"ParcelLabelClassificationServices","type":"object","description":"ParcelLabelClassificationServices"},"Carrier":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"credentials":{"allOf":[{"$ref":"#/components/schemas/AbstractCarrierCredentials"}],"description":"Credentials for the carrier"},"defaultParcelHeightInCm":{"default":10,"description":"Default height in cm","minimum":1,"type":"number"},"defaultParcelLengthInCm":{"default":25,"description":"Default length in cm","minimum":1,"type":"number"},"defaultParcelWeightInGram":{"default":1000,"description":"Default weight for a parcel in gram","minimum":1,"type":"number"},"defaultParcelWidthInCm":{"default":35,"description":"Default width in cm","minimum":1,"type":"number"},"deliveryType":{"description":"Provided delivery of this CEP. Default: DELIVERY","enum":["SAMEDAY","DELIVERY"],"type":"string"},"id":{"description":"The id of the carrier","type":"string"},"key":{"description":"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.","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"lifecycle":{"description":"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","enum":["GA","BETA","ALPHA"],"type":"string"},"logoUrl":{"description":"URL of the carrier logo","minLength":1,"type":"string"},"name":{"description":"This is the well known name for a supported CEP partner. Can be adapted to the clients needs.","type":"string"},"parcelLabelClassifications":{"description":"Parcel label classifications for this carrier","items":{"$ref":"#/components/schemas/ParcelLabelClassification"},"type":"array"},"productValueNeeded":{"description":"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)","type":"boolean"},"status":{"description":"It is taken into consideration for all carriers. Default: INACTIVE","enum":["ACTIVE","INACTIVE"],"type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","type":"integer"}},"required":["id","version","key","name","defaultParcelWidthInCm","defaultParcelLengthInCm","defaultParcelHeightInCm"],"title":"Carrier","type":"object","description":"Carrier"},"AbstractCarrierCredentials":{"properties":{"key":{"description":"The key identifying the carrier credentials type","type":"string"}},"required":["key"],"title":"AbstractCarrierCredentials","type":"object","description":"AbstractCarrierCredentials"},"ParcelLabelClassification":{"properties":{"nameLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized name for parcel label classification"},"dimensions":{"allOf":[{"$ref":"#/components/schemas/ParcelDimensions"}],"description":"Dimensions for this parcel label classification"},"name":{"description":"Name of the parcel label classification","type":"string"},"services":{"allOf":[{"$ref":"#/components/schemas/ParcelLabelClassificationServices"}],"description":"Services available for this parcel label classification"}},"required":["nameLocalized","dimensions"],"title":"ParcelLabelClassification","type":"object","description":"ParcelLabelClassification"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/carriers/{carrierId}":{"patch":{"deprecated":false,"description":"Update carrier","operationId":"patchCarrier","parameters":[{"in":"path","name":"carrierId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CarrierPatchActions"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Carrier"}}},"description":"Carrier was found & patch-set has been applied. The patched entity is in the body."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"The requested entity was not found"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"A version conflict occurred."}},"summary":"Update carrier","tags":["Carriers (Operations)"]}}}}
```

## Update transit time config

> This part of the API is in Beta status. For details please check the \<a href="<https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#beta>" target="\_blank">api-release-life-cycle documentation\</a>.\<br />\<br />

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read carriers.","name":"Carriers (Operations)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"TransitTimeConfigurationForUpsert":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"calculationStrategy":{"enum":["EARLIEST","LATEST"],"type":"string"}},"required":["calculationStrategy"],"type":"object","title":"TransitTimeConfigurationForUpsert","description":"TransitTimeConfigurationForUpsert"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"TransitTimeConfiguration":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"calculationStrategy":{"enum":["EARLIEST","LATEST"],"type":"string"},"id":{"type":"string"}},"required":["id","calculationStrategy"],"type":"object","title":"TransitTimeConfiguration","description":"TransitTimeConfiguration"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/configurations/transittime":{"put":{"description":"This part of the API is in Beta status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#beta\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />","operationId":"putTransitTimeConfiguration","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransitTimeConfigurationForUpsert"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransitTimeConfiguration"}}},"description":"Transit time configuration was written successfully"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Transit time configuration not found"}},"summary":"Update transit time config","tags":["Carriers (Operations)"]}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.fulfillmenttools.com/documentation/apis/api-reference/carriers-operations.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
