# Carrier endpoints

## The Carrier object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"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"}}}}
```

## 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)"]}}}}
```

## 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)"]}}}}
```

## 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)"]}}}}
```

## 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)"]}}}}
```

## Get carrier config

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

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update and read carriers configuration.","name":"Carriers Configuration (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":{"CarrierConfiguration":{"properties":{"additionalWeightInPercent":{"description":"It is an amount of percentage for packaging weight which will be added to the calculated shipping weight","minimum":0,"type":"number"},"alternativeReturnAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddress"}],"description":"Alternative return address for this carrier"},"alternativeSendAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddress"}],"description":"Alternative send address for this carrier"},"carrierRef":{"description":"Reference to the carrier this configuration belongs to","type":"string"},"countryServiceMappings":{"description":"Country service mappings for this carrier configuration","items":{"$ref":"#/components/schemas/CarrierCountryServiceMapping"},"maxItems":100,"type":"array"},"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"defaultPickUpTime":{"allOf":[{"$ref":"#/components/schemas/CarrierPickUpTime"}],"description":"Default pick up time configuration for carriers supporting pick up scheduling, will be used to calculate the next possible pick up date"},"fallBackTrackAndTraceEmail":{"description":"EmailAddress used to receive track and trace information when no other emailaddress was provided","format":"email","minLength":1,"type":"string"},"id":{"description":"The id of the carrier configuration","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"mustBeWeighed":{"default":false,"description":"Indicates if the content of a parcel must be weighed before ordering a label","type":"boolean"},"nonDeliveryDaysPerCountryAndProvince":{"description":"Non-delivery days per country and province","items":{"$ref":"#/components/schemas/NonDeliveryDaysPerCountryAndProvince"},"maxItems":500,"type":"array"},"returnLabel":{"default":false,"description":"When enabled, a return label will be created by creating a shipping label","type":"boolean"},"serviceUrl":{"description":"Service URL for this carrier configuration","type":"string"},"thresholdPriceValue":{"allOf":[{"$ref":"#/components/schemas/ThresholdPriceValue"}],"description":"Threshold price value for carrier selection"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","type":"integer"}},"required":["version","carrierRef","returnLabel"],"title":"CarrierConfiguration","type":"object","description":"CarrierConfiguration"},"FacilityAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddressForCreation"},{"properties":{"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZone"}},"type":"object"}],"type":"object","xml":{"name":"FacilityAddress"},"title":"FacilityAddress","description":"FacilityAddress"},"FacilityAddressForCreation":{"allOf":[{"$ref":"#/components/schemas/Address"},{"properties":{"companyName":{"type":"string"},"emailAddresses":{"items":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"type":"string"}},"required":["value"],"type":"object"},"maxItems":10,"type":"array"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZoneForCreation","description":"User-specified time zone in identifier format (e.g., \"America/Los_Angeles\"). Used to determine local time. Relevant only if the country spans multiple time zones; otherwise, the time zone is automatically determined from the country or via Google if unspecified."}},"required":["companyName"],"type":"object"}],"type":"object","xml":{"name":"FacilityAddressForCreation"},"title":"FacilityAddressForCreation","description":"FacilityAddressForCreation"},"Address":{"properties":{"additionalAddressInfo":{"type":"string"},"city":{"pattern":"^.+$","type":"string"},"country":{"description":"A two-digit country code as per ISO 3166-1 alpha-2","pattern":"^[A-Z]{2}$","type":"string"},"customAttributes":{"description":"Attributes that can be added to the address. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"houseNumber":{"pattern":"^.+$","type":"string"},"phoneNumbers":{"items":{"properties":{"customAttributes":{"description":"Attributes that can be added to the phonenumber. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"label":{"description":"Can be used to give a description for the number, like \"private\", \"business number\", etc.","type":"string"},"type":{"enum":["MOBILE","PHONE"],"type":"string"},"value":{"description":"The number itself. We do not enforce any format (yet).","type":"string"}},"required":["value","type"],"type":"object"},"maxItems":500,"type":"array"},"postalCode":{"pattern":"^.+$","type":"string"},"province":{"pattern":"^.+$","type":"string"},"street":{"pattern":"^.+$","type":"string"}},"required":["street","city","postalCode","country"],"type":"object","title":"Address","description":"Address"},"Coordinates":{"description":"Coordinates of the WGS84 geodetic reference system in Mercator projection, as used e.g. by the Google Maps API","properties":{"lat":{"description":"Latitude value","type":"number"},"lon":{"description":"Longitude value","type":"number"}},"required":["lat","lon"],"type":"object","title":"Coordinates"},"TimeZoneForCreation":{"description":"Self-provided timezone for determining the local time of a facility","properties":{"timeZoneId":{"description":"official id of the timezone","type":"string"}},"required":["timeZoneId"],"type":"object","title":"TimeZoneForCreation"},"TimeZone":{"description":"Timezone for information retrieved e.g. by the Google Maps API","properties":{"offsetInSeconds":{"description":"offset in seconds to standard time. Does not account for daylight saving time.","type":"number"},"source":{"description":"source of the timezone information","type":"string"},"timeZoneId":{"description":"official id of the timezone","type":"string"},"timeZoneName":{"description":"descriptive name of the timezone","type":"string"}},"required":["timeZoneId","timeZoneName","offsetInSeconds"],"type":"object","title":"TimeZone"},"CarrierCountryServiceMapping":{"properties":{"additionalShippingArticleAttributes":{"description":"Article Attributes that will be displayed in the client as additional. They are not mandatory but could benefit the process.","items":{"$ref":"#/components/schemas/AdditionalShippingArticleAttribute"},"maxItems":20,"type":"array"},"additionalShippingAttributes":{"description":"Shipping Attributes that will be displayed in the client as additional. They are not mandatory but could benefit the process.","items":{"$ref":"#/components/schemas/AdditionalShippingAttribute"},"maxItems":30,"type":"array"},"carrierProductCategory":{"description":"Desired product class to choose when ordering a label","enum":["STANDARD","EXPRESS","VALUE","FORWARDING"],"type":"string"},"carrierServices":{"description":"Services which can be provided by the carrier","items":{"enum":["SIGNATURE","CUSTOMER_SIGNATURE","ADULT_SIGNATURE","SATURDAY_DELIVERY","IDENTITY_CHECK_COMPANY","IDENTITY_CHECK_PRIVATE","ADDITIONAL_TRANSPORTATION_INSURANCE","IDENTITY_AGE_CHECK_18","NO_NEIGHBOR_DELIVERY","HANDOVER_TO_RECIPIENT_ONLY"],"type":"string"},"maxItems":10,"type":"array"},"countAsTransitDayBefore":{"description":"Time before which this day counts as a transit day","type":"string"},"deliveryCosts":{"description":"Delivery costs for this mapping","items":{"$ref":"#/components/schemas/DeliveryCost"},"maxItems":1,"type":"array"},"destinationCountries":{"deprecated":true,"description":"deprecated - Use destinations instead.","items":{"type":"string"},"maxItems":250,"type":"array"},"destinations":{"description":"The destination regions this mapping should be applied to.","items":{"$ref":"#/components/schemas/RegionInformation"},"maxItems":250,"type":"array"},"id":{"description":"Unique identifier for a countryServiceMapping","type":"string"},"mandatoryShippingArticleAttributes":{"items":{"$ref":"#/components/schemas/MandatoryShippingArticleAttribute"},"maxItems":20,"type":"array"},"mandatoryShippingAttributes":{"items":{"$ref":"#/components/schemas/MandatoryShippingAttribute"},"maxItems":30,"type":"array"},"mandatoryShippingItemAttributes":{"deprecated":true,"description":"Deprecated - use mandatoryShippingArticleAttributes instead","items":{"$ref":"#/components/schemas/MandatoryShippingItemAttribute"},"maxItems":30,"type":"array"},"products":{"description":"Array of products for the given mapping","items":{"type":"string"},"maxItems":50,"type":"array"},"source":{"allOf":[{"$ref":"#/components/schemas/RegionInformation"}],"description":"Source region for this mapping"},"sourceCountry":{"deprecated":true,"description":"deprecated - Use source instead.","type":"string"},"staticCCSMRef":{"description":"Reference to a static country service mapping","type":"string"},"transitTime":{"allOf":[{"$ref":"#/components/schemas/CarrierTransitTime"}],"description":"Transit time configuration for this mapping"}},"required":["id","source","destinations"],"title":"CarrierCountryServiceMapping","type":"object","description":"CarrierCountryServiceMapping"},"AdditionalShippingArticleAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this shipping article attribute"},"category":{"description":"The category of this shipping article attribute","enum":["customs","dimensions","insurance"],"type":"string"},"dataType":{"description":"The data type of this shipping article attribute","enum":["NUMBER","STRING"],"type":"string"},"description":{"description":"Description of this shipping article attribute","type":"string"},"referencedField":{"description":"The referenced field for this shipping article attribute","enum":["attributes.weightPerUnit","attributes.hsCode","attributes.currency","attributes.valuePerUnit","attributes.countryOfManufacture"],"type":"string"}},"required":["referencedField","dataType","category","descriptionLocalized"],"title":"AdditionalShippingArticleAttribute","type":"object","description":"AdditionalShippingArticleAttribute"},"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"},"AdditionalShippingAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this shipping attribute"},"dataType":{"description":"The data type of this shipping attribute","enum":["Number","String","Date","Boolean"],"type":"string"},"description":{"description":"Description of this shipping attribute","type":"string"},"referencedField":{"description":"- dimensions.weight: will be calculated from MandatoryShippingArticleAttribute.attributes.weightPerUnit if items with weightPerUnit is set on all items\n- productValue: will be calculated from MandatoryShippingArticleAttribute.attributes.pricePerUnit if items with pricePerUnit is set on all items","enum":["dimensions.weight","productValue","pickUpInformation.startTime","pickUpInformation.endTime","services.BulkyGoods","services.Signature","services.AdultSignature","services.CustomerSignature","services.SaturdayDelivery","services.IdentityCheckPrivate","services.IdentityCheckCompany","services.AdditionalTransportInsurance","carrierInformation.shippingContainerNumber","services.NoNeighborDelivery","services.HandoverToRecipientOnly","services.IdentityAgeCheck18"],"type":"string"}},"title":"AdditionalShippingAttribute","type":"object","description":"AdditionalShippingAttribute"},"DeliveryCost":{"properties":{"cost":{"description":"The cost of sending with a carrier","type":"number"},"currency":{"description":"The currency of the price as an ISO 4217 code.","type":"string"}},"required":["cost","currency"],"title":"DeliveryCost","type":"object","description":"DeliveryCost"},"RegionInformation":{"properties":{"countryCode":{"description":"ISO 3166 ALPHA-2 of country","maxLength":2,"minLength":2,"type":"string"},"postalCodes":{"description":"List of postal codes for this region","items":{"type":"string"},"maxItems":100,"type":"array"}},"required":["countryCode"],"title":"RegionInformation","type":"object","description":"RegionInformation"},"MandatoryShippingArticleAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this shipping article attribute"},"category":{"description":"The category of this shipping article attribute","enum":["customs","dimensions","insurance"],"type":"string"},"dataType":{"description":"The data type of this shipping article attribute","enum":["NUMBER","STRING"],"type":"string"},"description":{"description":"Description of this shipping article attribute","type":"string"},"referencedField":{"description":"The referenced field for this shipping article attribute","enum":["attributes.weightPerUnit","attributes.hsCode","attributes.currency","attributes.valuePerUnit","attributes.countryOfManufacture"],"type":"string"}},"required":["referencedField","dataType","category","descriptionLocalized"],"title":"MandatoryShippingArticleAttribute","type":"object","description":"MandatoryShippingArticleAttribute"},"MandatoryShippingAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this shipping attribute"},"dataType":{"description":"The data type of this shipping attribute","enum":["Number","String","Date","Boolean"],"type":"string"},"description":{"description":"Description of this shipping attribute","type":"string"},"referencedField":{"description":"- dimensions.weight: will be calculated from MandatoryShippingArticleAttribute.attributes.weightPerUnit if items with weightPerUnit is set on all items\n- productValue: will be calculated from MandatoryShippingArticleAttribute.attributes.pricePerUnit if items with pricePerUnit is set on all items","enum":["dimensions.weight","productValue","pickUpInformation.startTime","pickUpInformation.endTime","services.BulkyGoods","services.Signature","services.AdultSignature","services.CustomerSignature","services.SaturdayDelivery","services.IdentityCheckPrivate","services.IdentityCheckCompany","services.AdditionalTransportInsurance","carrierInformation.shippingContainerNumber","services.NoNeighborDelivery","services.HandoverToRecipientOnly","services.IdentityAgeCheck18"],"type":"string"}},"title":"MandatoryShippingAttribute","type":"object","description":"MandatoryShippingAttribute"},"MandatoryShippingItemAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this attribute"},"dataType":{"description":"The data type of this attribute","enum":["Number","String","Date","Boolean"],"type":"string"},"description":{"description":"Description of this attribute","type":"string"},"referencedField":{"deprecated":true,"description":"Deprecated: description: article.title will be used instead, weightInGram: use MandatoryShippingArticleAttribute.attributes.weightPerUnit","enum":["description","weightInGram","quantity","parcelItemValue.value","parcelItemValue.currency","countryOfManufacture","tenantArticleId"],"type":"string"}},"title":"MandatoryShippingItemAttribute","type":"object","description":"MandatoryShippingItemAttribute"},"CarrierTransitTime":{"properties":{"maxTransitDays":{"description":"Maximum days a carrier needs for transit","format":"int32","minimum":0,"type":"number"},"minTransitDays":{"description":"Minimum days a carrier needs for transit","format":"int32","minimum":0,"type":"number"}},"required":["minTransitDays","maxTransitDays"],"title":"CarrierTransitTime","type":"object","description":"CarrierTransitTime"},"CarrierPickUpTime":{"properties":{"end":{"allOf":[{"$ref":"#/components/schemas/TimeStamp"}],"description":"End time of the pick up window"},"start":{"allOf":[{"$ref":"#/components/schemas/TimeStamp"}],"description":"Start time of the pick up window"}},"required":["start","end"],"title":"CarrierPickUpTime","type":"object","description":"CarrierPickUpTime"},"TimeStamp":{"properties":{"hour":{"maximum":23,"minimum":0,"type":"number"},"minute":{"maximum":59,"minimum":0,"type":"number"}},"required":["hour","minute"],"type":"object","title":"TimeStamp","description":"TimeStamp"},"NonDeliveryDaysPerCountryAndProvince":{"properties":{"country":{"description":"The country code","type":"string"},"nonDeliveryDays":{"description":"Non-delivery days for this country","items":{"$ref":"#/components/schemas/NonDeliveryDays"},"maxItems":500,"type":"array"},"nonDeliveryDaysPerProvince":{"description":"Non-delivery days per province within this country","items":{"$ref":"#/components/schemas/NonDeliveryDaysPerProvince"},"maxItems":500,"type":"array"},"recurringNonDeliveryWeekdays":{"description":"Recurring non-delivery weekdays for this country","items":{"enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":"string"},"maxItems":7,"type":"array"}},"required":["country","nonDeliveryDays","recurringNonDeliveryWeekdays","nonDeliveryDaysPerProvince"],"title":"NonDeliveryDaysPerCountryAndProvince","type":"object","description":"NonDeliveryDaysPerCountryAndProvince"},"NonDeliveryDays":{"properties":{"nonDeliveryDay":{"description":"The non-delivery day in YYYY-MM-DD format","format":"date","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"},"nonDeliveryType":{"default":"SINGLE","description":"Type of non-delivery day","enum":["SINGLE","RECURRING"],"type":"string"}},"required":["nonDeliveryDay"],"title":"NonDeliveryDays","type":"object","description":"NonDeliveryDays"},"NonDeliveryDaysPerProvince":{"properties":{"nonDeliveryDays":{"description":"Non-delivery days for this province","items":{"$ref":"#/components/schemas/NonDeliveryDays"},"maxItems":500,"type":"array"},"province":{"description":"The province identifier","type":"string"},"recurringNonDeliveryWeekdays":{"description":"Recurring non-delivery weekdays for this province","items":{"enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":"string"},"maxItems":7,"type":"array"}},"required":["province","nonDeliveryDays","recurringNonDeliveryWeekdays"],"title":"NonDeliveryDaysPerProvince","type":"object","description":"NonDeliveryDaysPerProvince"},"ThresholdPriceValue":{"properties":{"priceRange":{"allOf":[{"$ref":"#/components/schemas/PriceRange"}],"description":"Price range for which this threshold applies"},"priority":{"description":"The lower the value the higher is the priority, e.g. priority 1 is higher than priority 10. The priority is used when comparing multiple carriers.","minimum":1,"type":"number"}},"required":["priority","priceRange"],"title":"ThresholdPriceValue","type":"object","description":"ThresholdPriceValue"},"PriceRange":{"properties":{"currency":{"description":"The currency of the price as an ISO 4217 code.","type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency","format":"int32","minimum":0,"type":"integer"},"from":{"description":"Lowest total parcel value that this carrier will be selected for. Value is configured in the smallest subunit, e.g. cents.","minimum":0,"type":"number"},"to":{"description":"Highest total parcel value that this carrier will be selected for. Value is configured in the smallest subunit, e.g. cents.","minimum":1,"type":"number"}},"required":["from","to","currency","decimalPlaces"],"title":"PriceRange","type":"object","description":"PriceRange"},"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}/configuration":{"get":{"deprecated":false,"description":"Retrieves the configuration for a specific carrier by its ID. If no configuration exists, a default one is created and returned.","operationId":"getCarrierConfiguration","parameters":[{"in":"path","name":"carrierId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CarrierConfiguration"}}},"description":"Carrier Configuration 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 config","tags":["Carriers Configuration (Operations)"]}}}}
```

## Update carrier config

> 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.

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update and read carriers configuration.","name":"Carriers Configuration (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":{"CarrierConfiguration":{"properties":{"additionalWeightInPercent":{"description":"It is an amount of percentage for packaging weight which will be added to the calculated shipping weight","minimum":0,"type":"number"},"alternativeReturnAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddress"}],"description":"Alternative return address for this carrier"},"alternativeSendAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddress"}],"description":"Alternative send address for this carrier"},"carrierRef":{"description":"Reference to the carrier this configuration belongs to","type":"string"},"countryServiceMappings":{"description":"Country service mappings for this carrier configuration","items":{"$ref":"#/components/schemas/CarrierCountryServiceMapping"},"maxItems":100,"type":"array"},"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"defaultPickUpTime":{"allOf":[{"$ref":"#/components/schemas/CarrierPickUpTime"}],"description":"Default pick up time configuration for carriers supporting pick up scheduling, will be used to calculate the next possible pick up date"},"fallBackTrackAndTraceEmail":{"description":"EmailAddress used to receive track and trace information when no other emailaddress was provided","format":"email","minLength":1,"type":"string"},"id":{"description":"The id of the carrier configuration","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"mustBeWeighed":{"default":false,"description":"Indicates if the content of a parcel must be weighed before ordering a label","type":"boolean"},"nonDeliveryDaysPerCountryAndProvince":{"description":"Non-delivery days per country and province","items":{"$ref":"#/components/schemas/NonDeliveryDaysPerCountryAndProvince"},"maxItems":500,"type":"array"},"returnLabel":{"default":false,"description":"When enabled, a return label will be created by creating a shipping label","type":"boolean"},"serviceUrl":{"description":"Service URL for this carrier configuration","type":"string"},"thresholdPriceValue":{"allOf":[{"$ref":"#/components/schemas/ThresholdPriceValue"}],"description":"Threshold price value for carrier selection"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","type":"integer"}},"required":["version","carrierRef","returnLabel"],"title":"CarrierConfiguration","type":"object","description":"CarrierConfiguration"},"FacilityAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddressForCreation"},{"properties":{"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZone"}},"type":"object"}],"type":"object","xml":{"name":"FacilityAddress"},"title":"FacilityAddress","description":"FacilityAddress"},"FacilityAddressForCreation":{"allOf":[{"$ref":"#/components/schemas/Address"},{"properties":{"companyName":{"type":"string"},"emailAddresses":{"items":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"type":"string"}},"required":["value"],"type":"object"},"maxItems":10,"type":"array"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZoneForCreation","description":"User-specified time zone in identifier format (e.g., \"America/Los_Angeles\"). Used to determine local time. Relevant only if the country spans multiple time zones; otherwise, the time zone is automatically determined from the country or via Google if unspecified."}},"required":["companyName"],"type":"object"}],"type":"object","xml":{"name":"FacilityAddressForCreation"},"title":"FacilityAddressForCreation","description":"FacilityAddressForCreation"},"Address":{"properties":{"additionalAddressInfo":{"type":"string"},"city":{"pattern":"^.+$","type":"string"},"country":{"description":"A two-digit country code as per ISO 3166-1 alpha-2","pattern":"^[A-Z]{2}$","type":"string"},"customAttributes":{"description":"Attributes that can be added to the address. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"houseNumber":{"pattern":"^.+$","type":"string"},"phoneNumbers":{"items":{"properties":{"customAttributes":{"description":"Attributes that can be added to the phonenumber. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"label":{"description":"Can be used to give a description for the number, like \"private\", \"business number\", etc.","type":"string"},"type":{"enum":["MOBILE","PHONE"],"type":"string"},"value":{"description":"The number itself. We do not enforce any format (yet).","type":"string"}},"required":["value","type"],"type":"object"},"maxItems":500,"type":"array"},"postalCode":{"pattern":"^.+$","type":"string"},"province":{"pattern":"^.+$","type":"string"},"street":{"pattern":"^.+$","type":"string"}},"required":["street","city","postalCode","country"],"type":"object","title":"Address","description":"Address"},"Coordinates":{"description":"Coordinates of the WGS84 geodetic reference system in Mercator projection, as used e.g. by the Google Maps API","properties":{"lat":{"description":"Latitude value","type":"number"},"lon":{"description":"Longitude value","type":"number"}},"required":["lat","lon"],"type":"object","title":"Coordinates"},"TimeZoneForCreation":{"description":"Self-provided timezone for determining the local time of a facility","properties":{"timeZoneId":{"description":"official id of the timezone","type":"string"}},"required":["timeZoneId"],"type":"object","title":"TimeZoneForCreation"},"TimeZone":{"description":"Timezone for information retrieved e.g. by the Google Maps API","properties":{"offsetInSeconds":{"description":"offset in seconds to standard time. Does not account for daylight saving time.","type":"number"},"source":{"description":"source of the timezone information","type":"string"},"timeZoneId":{"description":"official id of the timezone","type":"string"},"timeZoneName":{"description":"descriptive name of the timezone","type":"string"}},"required":["timeZoneId","timeZoneName","offsetInSeconds"],"type":"object","title":"TimeZone"},"CarrierCountryServiceMapping":{"properties":{"additionalShippingArticleAttributes":{"description":"Article Attributes that will be displayed in the client as additional. They are not mandatory but could benefit the process.","items":{"$ref":"#/components/schemas/AdditionalShippingArticleAttribute"},"maxItems":20,"type":"array"},"additionalShippingAttributes":{"description":"Shipping Attributes that will be displayed in the client as additional. They are not mandatory but could benefit the process.","items":{"$ref":"#/components/schemas/AdditionalShippingAttribute"},"maxItems":30,"type":"array"},"carrierProductCategory":{"description":"Desired product class to choose when ordering a label","enum":["STANDARD","EXPRESS","VALUE","FORWARDING"],"type":"string"},"carrierServices":{"description":"Services which can be provided by the carrier","items":{"enum":["SIGNATURE","CUSTOMER_SIGNATURE","ADULT_SIGNATURE","SATURDAY_DELIVERY","IDENTITY_CHECK_COMPANY","IDENTITY_CHECK_PRIVATE","ADDITIONAL_TRANSPORTATION_INSURANCE","IDENTITY_AGE_CHECK_18","NO_NEIGHBOR_DELIVERY","HANDOVER_TO_RECIPIENT_ONLY"],"type":"string"},"maxItems":10,"type":"array"},"countAsTransitDayBefore":{"description":"Time before which this day counts as a transit day","type":"string"},"deliveryCosts":{"description":"Delivery costs for this mapping","items":{"$ref":"#/components/schemas/DeliveryCost"},"maxItems":1,"type":"array"},"destinationCountries":{"deprecated":true,"description":"deprecated - Use destinations instead.","items":{"type":"string"},"maxItems":250,"type":"array"},"destinations":{"description":"The destination regions this mapping should be applied to.","items":{"$ref":"#/components/schemas/RegionInformation"},"maxItems":250,"type":"array"},"id":{"description":"Unique identifier for a countryServiceMapping","type":"string"},"mandatoryShippingArticleAttributes":{"items":{"$ref":"#/components/schemas/MandatoryShippingArticleAttribute"},"maxItems":20,"type":"array"},"mandatoryShippingAttributes":{"items":{"$ref":"#/components/schemas/MandatoryShippingAttribute"},"maxItems":30,"type":"array"},"mandatoryShippingItemAttributes":{"deprecated":true,"description":"Deprecated - use mandatoryShippingArticleAttributes instead","items":{"$ref":"#/components/schemas/MandatoryShippingItemAttribute"},"maxItems":30,"type":"array"},"products":{"description":"Array of products for the given mapping","items":{"type":"string"},"maxItems":50,"type":"array"},"source":{"allOf":[{"$ref":"#/components/schemas/RegionInformation"}],"description":"Source region for this mapping"},"sourceCountry":{"deprecated":true,"description":"deprecated - Use source instead.","type":"string"},"staticCCSMRef":{"description":"Reference to a static country service mapping","type":"string"},"transitTime":{"allOf":[{"$ref":"#/components/schemas/CarrierTransitTime"}],"description":"Transit time configuration for this mapping"}},"required":["id","source","destinations"],"title":"CarrierCountryServiceMapping","type":"object","description":"CarrierCountryServiceMapping"},"AdditionalShippingArticleAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this shipping article attribute"},"category":{"description":"The category of this shipping article attribute","enum":["customs","dimensions","insurance"],"type":"string"},"dataType":{"description":"The data type of this shipping article attribute","enum":["NUMBER","STRING"],"type":"string"},"description":{"description":"Description of this shipping article attribute","type":"string"},"referencedField":{"description":"The referenced field for this shipping article attribute","enum":["attributes.weightPerUnit","attributes.hsCode","attributes.currency","attributes.valuePerUnit","attributes.countryOfManufacture"],"type":"string"}},"required":["referencedField","dataType","category","descriptionLocalized"],"title":"AdditionalShippingArticleAttribute","type":"object","description":"AdditionalShippingArticleAttribute"},"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"},"AdditionalShippingAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this shipping attribute"},"dataType":{"description":"The data type of this shipping attribute","enum":["Number","String","Date","Boolean"],"type":"string"},"description":{"description":"Description of this shipping attribute","type":"string"},"referencedField":{"description":"- dimensions.weight: will be calculated from MandatoryShippingArticleAttribute.attributes.weightPerUnit if items with weightPerUnit is set on all items\n- productValue: will be calculated from MandatoryShippingArticleAttribute.attributes.pricePerUnit if items with pricePerUnit is set on all items","enum":["dimensions.weight","productValue","pickUpInformation.startTime","pickUpInformation.endTime","services.BulkyGoods","services.Signature","services.AdultSignature","services.CustomerSignature","services.SaturdayDelivery","services.IdentityCheckPrivate","services.IdentityCheckCompany","services.AdditionalTransportInsurance","carrierInformation.shippingContainerNumber","services.NoNeighborDelivery","services.HandoverToRecipientOnly","services.IdentityAgeCheck18"],"type":"string"}},"title":"AdditionalShippingAttribute","type":"object","description":"AdditionalShippingAttribute"},"DeliveryCost":{"properties":{"cost":{"description":"The cost of sending with a carrier","type":"number"},"currency":{"description":"The currency of the price as an ISO 4217 code.","type":"string"}},"required":["cost","currency"],"title":"DeliveryCost","type":"object","description":"DeliveryCost"},"RegionInformation":{"properties":{"countryCode":{"description":"ISO 3166 ALPHA-2 of country","maxLength":2,"minLength":2,"type":"string"},"postalCodes":{"description":"List of postal codes for this region","items":{"type":"string"},"maxItems":100,"type":"array"}},"required":["countryCode"],"title":"RegionInformation","type":"object","description":"RegionInformation"},"MandatoryShippingArticleAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this shipping article attribute"},"category":{"description":"The category of this shipping article attribute","enum":["customs","dimensions","insurance"],"type":"string"},"dataType":{"description":"The data type of this shipping article attribute","enum":["NUMBER","STRING"],"type":"string"},"description":{"description":"Description of this shipping article attribute","type":"string"},"referencedField":{"description":"The referenced field for this shipping article attribute","enum":["attributes.weightPerUnit","attributes.hsCode","attributes.currency","attributes.valuePerUnit","attributes.countryOfManufacture"],"type":"string"}},"required":["referencedField","dataType","category","descriptionLocalized"],"title":"MandatoryShippingArticleAttribute","type":"object","description":"MandatoryShippingArticleAttribute"},"MandatoryShippingAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this shipping attribute"},"dataType":{"description":"The data type of this shipping attribute","enum":["Number","String","Date","Boolean"],"type":"string"},"description":{"description":"Description of this shipping attribute","type":"string"},"referencedField":{"description":"- dimensions.weight: will be calculated from MandatoryShippingArticleAttribute.attributes.weightPerUnit if items with weightPerUnit is set on all items\n- productValue: will be calculated from MandatoryShippingArticleAttribute.attributes.pricePerUnit if items with pricePerUnit is set on all items","enum":["dimensions.weight","productValue","pickUpInformation.startTime","pickUpInformation.endTime","services.BulkyGoods","services.Signature","services.AdultSignature","services.CustomerSignature","services.SaturdayDelivery","services.IdentityCheckPrivate","services.IdentityCheckCompany","services.AdditionalTransportInsurance","carrierInformation.shippingContainerNumber","services.NoNeighborDelivery","services.HandoverToRecipientOnly","services.IdentityAgeCheck18"],"type":"string"}},"title":"MandatoryShippingAttribute","type":"object","description":"MandatoryShippingAttribute"},"MandatoryShippingItemAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this attribute"},"dataType":{"description":"The data type of this attribute","enum":["Number","String","Date","Boolean"],"type":"string"},"description":{"description":"Description of this attribute","type":"string"},"referencedField":{"deprecated":true,"description":"Deprecated: description: article.title will be used instead, weightInGram: use MandatoryShippingArticleAttribute.attributes.weightPerUnit","enum":["description","weightInGram","quantity","parcelItemValue.value","parcelItemValue.currency","countryOfManufacture","tenantArticleId"],"type":"string"}},"title":"MandatoryShippingItemAttribute","type":"object","description":"MandatoryShippingItemAttribute"},"CarrierTransitTime":{"properties":{"maxTransitDays":{"description":"Maximum days a carrier needs for transit","format":"int32","minimum":0,"type":"number"},"minTransitDays":{"description":"Minimum days a carrier needs for transit","format":"int32","minimum":0,"type":"number"}},"required":["minTransitDays","maxTransitDays"],"title":"CarrierTransitTime","type":"object","description":"CarrierTransitTime"},"CarrierPickUpTime":{"properties":{"end":{"allOf":[{"$ref":"#/components/schemas/TimeStamp"}],"description":"End time of the pick up window"},"start":{"allOf":[{"$ref":"#/components/schemas/TimeStamp"}],"description":"Start time of the pick up window"}},"required":["start","end"],"title":"CarrierPickUpTime","type":"object","description":"CarrierPickUpTime"},"TimeStamp":{"properties":{"hour":{"maximum":23,"minimum":0,"type":"number"},"minute":{"maximum":59,"minimum":0,"type":"number"}},"required":["hour","minute"],"type":"object","title":"TimeStamp","description":"TimeStamp"},"NonDeliveryDaysPerCountryAndProvince":{"properties":{"country":{"description":"The country code","type":"string"},"nonDeliveryDays":{"description":"Non-delivery days for this country","items":{"$ref":"#/components/schemas/NonDeliveryDays"},"maxItems":500,"type":"array"},"nonDeliveryDaysPerProvince":{"description":"Non-delivery days per province within this country","items":{"$ref":"#/components/schemas/NonDeliveryDaysPerProvince"},"maxItems":500,"type":"array"},"recurringNonDeliveryWeekdays":{"description":"Recurring non-delivery weekdays for this country","items":{"enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":"string"},"maxItems":7,"type":"array"}},"required":["country","nonDeliveryDays","recurringNonDeliveryWeekdays","nonDeliveryDaysPerProvince"],"title":"NonDeliveryDaysPerCountryAndProvince","type":"object","description":"NonDeliveryDaysPerCountryAndProvince"},"NonDeliveryDays":{"properties":{"nonDeliveryDay":{"description":"The non-delivery day in YYYY-MM-DD format","format":"date","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"},"nonDeliveryType":{"default":"SINGLE","description":"Type of non-delivery day","enum":["SINGLE","RECURRING"],"type":"string"}},"required":["nonDeliveryDay"],"title":"NonDeliveryDays","type":"object","description":"NonDeliveryDays"},"NonDeliveryDaysPerProvince":{"properties":{"nonDeliveryDays":{"description":"Non-delivery days for this province","items":{"$ref":"#/components/schemas/NonDeliveryDays"},"maxItems":500,"type":"array"},"province":{"description":"The province identifier","type":"string"},"recurringNonDeliveryWeekdays":{"description":"Recurring non-delivery weekdays for this province","items":{"enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":"string"},"maxItems":7,"type":"array"}},"required":["province","nonDeliveryDays","recurringNonDeliveryWeekdays"],"title":"NonDeliveryDaysPerProvince","type":"object","description":"NonDeliveryDaysPerProvince"},"ThresholdPriceValue":{"properties":{"priceRange":{"allOf":[{"$ref":"#/components/schemas/PriceRange"}],"description":"Price range for which this threshold applies"},"priority":{"description":"The lower the value the higher is the priority, e.g. priority 1 is higher than priority 10. The priority is used when comparing multiple carriers.","minimum":1,"type":"number"}},"required":["priority","priceRange"],"title":"ThresholdPriceValue","type":"object","description":"ThresholdPriceValue"},"PriceRange":{"properties":{"currency":{"description":"The currency of the price as an ISO 4217 code.","type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency","format":"int32","minimum":0,"type":"integer"},"from":{"description":"Lowest total parcel value that this carrier will be selected for. Value is configured in the smallest subunit, e.g. cents.","minimum":0,"type":"number"},"to":{"description":"Highest total parcel value that this carrier will be selected for. Value is configured in the smallest subunit, e.g. cents.","minimum":1,"type":"number"}},"required":["from","to","currency","decimalPlaces"],"title":"PriceRange","type":"object","description":"PriceRange"},"GlsCarrierConfiguration":{"properties":{"additionalWeightInPercent":{"description":"It is an amount of percentage for packaging weight which will be added to the calculated shipping weight","minimum":0,"type":"number"},"alternativeReturnAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddress"}],"description":"Alternative return address for this carrier"},"alternativeReturnAddressLocationId":{"description":"Alternative return address location ID","type":"string"},"alternativeSendAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddress"}],"description":"Alternative send address for this carrier"},"alternativeSendAddressLocationId":{"description":"Alternative send address location ID","type":"string"},"carrierRef":{"description":"Reference to the carrier this configuration belongs to","type":"string"},"countryServiceMappings":{"description":"Country service mappings for this carrier configuration","items":{"$ref":"#/components/schemas/CarrierCountryServiceMapping"},"maxItems":100,"type":"array"},"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"defaultPickUpTime":{"allOf":[{"$ref":"#/components/schemas/CarrierPickUpTime"}],"description":"Default pick up time configuration for carriers supporting pick up scheduling, will be used to calculate the next possible pick up date"},"fallBackTrackAndTraceEmail":{"description":"EmailAddress used to receive track and trace information when no other emailaddress was provided","format":"email","minLength":1,"type":"string"},"id":{"description":"The id of the carrier configuration","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"mustBeWeighed":{"default":false,"description":"Indicates if the content of a parcel must be weighed before ordering a label","type":"boolean"},"nonDeliveryDaysPerCountryAndProvince":{"description":"Non-delivery days per country and province","items":{"$ref":"#/components/schemas/NonDeliveryDaysPerCountryAndProvince"},"maxItems":500,"type":"array"},"returnLabel":{"default":false,"description":"When enabled, a return label will be created by creating a shipping label","type":"boolean"},"serviceUrl":{"description":"Service URL for this carrier configuration","type":"string"},"thresholdPriceValue":{"allOf":[{"$ref":"#/components/schemas/ThresholdPriceValue"}],"description":"Threshold price value for carrier selection"},"trackAndTraceUrl":{"description":"Track and trace URL","type":"string"},"trackAndTraceWsdlUrl":{"description":"WSDL URL for track and trace","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","type":"integer"}},"required":["version","carrierRef","returnLabel"],"title":"GlsCarrierConfiguration","type":"object","description":"GlsCarrierConfiguration"},"FedexCarrierConfiguration":{"properties":{"additionalWeightInPercent":{"description":"It is an amount of percentage for packaging weight which will be added to the calculated shipping weight","minimum":0,"type":"number"},"alternativeReturnAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddress"}],"description":"Alternative return address for this carrier"},"alternativeSendAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddress"}],"description":"Alternative send address for this carrier"},"carrierRef":{"description":"Reference to the carrier this configuration belongs to","type":"string"},"countryServiceMappings":{"description":"Country service mappings for this carrier configuration","items":{"$ref":"#/components/schemas/CarrierCountryServiceMapping"},"maxItems":100,"type":"array"},"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"defaultCommodityDescription":{"description":"Default commodity description","type":"string"},"defaultManufactureCountry":{"description":"Default manufacture country","type":"string"},"defaultPickUpTime":{"allOf":[{"$ref":"#/components/schemas/CarrierPickUpTime"}],"description":"Default pick up time configuration for carriers supporting pick up scheduling, will be used to calculate the next possible pick up date"},"defaultPriceCurrency":{"description":"Default price currency for shipments","type":"string"},"defaultPriceValue":{"description":"Default price value for shipments","type":"number"},"fallBackTrackAndTraceEmail":{"description":"EmailAddress used to receive track and trace information when no other emailaddress was provided","format":"email","minLength":1,"type":"string"},"id":{"description":"The id of the carrier configuration","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"mustBeWeighed":{"default":false,"description":"Indicates if the content of a parcel must be weighed before ordering a label","type":"boolean"},"nonDeliveryDaysPerCountryAndProvince":{"description":"Non-delivery days per country and province","items":{"$ref":"#/components/schemas/NonDeliveryDaysPerCountryAndProvince"},"maxItems":500,"type":"array"},"returnLabel":{"default":false,"description":"When enabled, a return label will be created by creating a shipping label","type":"boolean"},"serviceUrl":{"description":"Service URL for this carrier configuration","type":"string"},"thresholdPriceValue":{"allOf":[{"$ref":"#/components/schemas/ThresholdPriceValue"}],"description":"Threshold price value for carrier selection"},"trackAndTraceUrl":{"description":"Track and trace URL","type":"string"},"useEconomyService":{"description":"Whether to use the economy service","type":"boolean"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","type":"integer"}},"required":["version","carrierRef","returnLabel","useEconomyService","defaultPriceValue","defaultPriceCurrency","defaultManufactureCountry","defaultCommodityDescription"],"title":"FedexCarrierConfiguration","type":"object","description":"FedexCarrierConfiguration"},"BringCarrierConfiguration":{"properties":{"additionalWeightInPercent":{"description":"It is an amount of percentage for packaging weight which will be added to the calculated shipping weight","minimum":0,"type":"number"},"alternativeReturnAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddress"}],"description":"Alternative return address for this carrier"},"alternativeSendAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddress"}],"description":"Alternative send address for this carrier"},"carrierRef":{"description":"Reference to the carrier this configuration belongs to","type":"string"},"countryServiceMappings":{"description":"Country service mappings for this carrier configuration","items":{"$ref":"#/components/schemas/CarrierCountryServiceMapping"},"maxItems":100,"type":"array"},"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"customerId":{"description":"Customer ID for Bring carrier","type":"string"},"defaultPickUpTime":{"allOf":[{"$ref":"#/components/schemas/CarrierPickUpTime"}],"description":"Default pick up time configuration for carriers supporting pick up scheduling, will be used to calculate the next possible pick up date"},"fallBackTrackAndTraceEmail":{"description":"EmailAddress used to receive track and trace information when no other emailaddress was provided","format":"email","minLength":1,"type":"string"},"id":{"description":"The id of the carrier configuration","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"mustBeWeighed":{"default":false,"description":"Indicates if the content of a parcel must be weighed before ordering a label","type":"boolean"},"nonDeliveryDaysPerCountryAndProvince":{"description":"Non-delivery days per country and province","items":{"$ref":"#/components/schemas/NonDeliveryDaysPerCountryAndProvince"},"maxItems":500,"type":"array"},"returnLabel":{"default":false,"description":"When enabled, a return label will be created by creating a shipping label","type":"boolean"},"returnProduct":{"description":"Return product code","type":"string"},"serviceUrl":{"description":"Service URL for this carrier configuration","type":"string"},"shipmentProduct":{"description":"Shipment product code","type":"string"},"supportPhoneNumber":{"description":"Support phone number","type":"string"},"thresholdPriceValue":{"allOf":[{"$ref":"#/components/schemas/ThresholdPriceValue"}],"description":"Threshold price value for carrier selection"},"trackAndTraceUrl":{"description":"Track and trace URL","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","type":"integer"},"webhookFftHost":{"description":"Webhook FFT host","type":"string"}},"required":["version","carrierRef","returnLabel","customerId","supportPhoneNumber"],"title":"BringCarrierConfiguration","type":"object","description":"BringCarrierConfiguration"},"DpdChCarrierConfiguration":{"properties":{"additionalWeightInPercent":{"description":"It is an amount of percentage for packaging weight which will be added to the calculated shipping weight","minimum":0,"type":"number"},"alternativeReturnAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddress"}],"description":"Alternative return address for this carrier"},"alternativeSendAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddress"}],"description":"Alternative send address for this carrier"},"carrierRef":{"description":"Reference to the carrier this configuration belongs to","type":"string"},"countryServiceMappings":{"description":"Country service mappings for this carrier configuration","items":{"$ref":"#/components/schemas/CarrierCountryServiceMapping"},"maxItems":100,"type":"array"},"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"defaultPickUpTime":{"allOf":[{"$ref":"#/components/schemas/CarrierPickUpTime"}],"description":"Default pick up time configuration for carriers supporting pick up scheduling, will be used to calculate the next possible pick up date"},"fallBackTrackAndTraceEmail":{"description":"EmailAddress used to receive track and trace information when no other emailaddress was provided","format":"email","minLength":1,"type":"string"},"id":{"description":"The id of the carrier configuration","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"mustBeWeighed":{"default":false,"description":"Indicates if the content of a parcel must be weighed before ordering a label","type":"boolean"},"nonDeliveryDaysPerCountryAndProvince":{"description":"Non-delivery days per country and province","items":{"$ref":"#/components/schemas/NonDeliveryDaysPerCountryAndProvince"},"maxItems":500,"type":"array"},"returnLabel":{"default":false,"description":"When enabled, a return label will be created by creating a shipping label","type":"boolean"},"serviceUrl":{"description":"Service URL for this carrier configuration","type":"string"},"thresholdPriceValue":{"allOf":[{"$ref":"#/components/schemas/ThresholdPriceValue"}],"description":"Threshold price value for carrier selection"},"trackAndTraceUrl":{"description":"Track and trace URL","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","type":"integer"}},"required":["version","carrierRef","returnLabel"],"title":"DpdChCarrierConfiguration","type":"object","description":"DpdChCarrierConfiguration"},"DhlV2CarrierConfiguration":{"properties":{"additionalWeightInPercent":{"description":"It is an amount of percentage for packaging weight which will be added to the calculated shipping weight","minimum":0,"type":"number"},"alternativeReturnAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddress"}],"description":"Alternative return address for this carrier"},"alternativeSendAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddress"}],"description":"Alternative send address for this carrier"},"alwaysDoTrackAndTrace":{"description":"Whether to always perform track and trace","type":"boolean"},"carrierRef":{"description":"Reference to the carrier this configuration belongs to","type":"string"},"countryServiceMappings":{"description":"Country service mappings for this carrier configuration","items":{"$ref":"#/components/schemas/CarrierCountryServiceMapping"},"maxItems":100,"type":"array"},"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"defaultPickUpTime":{"allOf":[{"$ref":"#/components/schemas/CarrierPickUpTime"}],"description":"Default pick up time configuration for carriers supporting pick up scheduling, will be used to calculate the next possible pick up date"},"fallBackTrackAndTraceEmail":{"description":"EmailAddress used to receive track and trace information when no other emailaddress was provided","format":"email","minLength":1,"type":"string"},"id":{"description":"The id of the carrier configuration","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"mustBeWeighed":{"default":false,"description":"Indicates if the content of a parcel must be weighed before ordering a label","type":"boolean"},"nonDeliveryDaysPerCountryAndProvince":{"description":"Non-delivery days per country and province","items":{"$ref":"#/components/schemas/NonDeliveryDaysPerCountryAndProvince"},"maxItems":500,"type":"array"},"returnLabel":{"default":false,"description":"When enabled, a return label will be created by creating a shipping label","type":"boolean"},"serviceUrl":{"description":"Service URL for this carrier configuration","type":"string"},"sftpConfiguration":{"allOf":[{"$ref":"#/components/schemas/SftpConfiguration"}],"description":"SFTP configuration for track and trace"},"shipperRef":{"description":"Shipper reference","type":"string"},"thresholdPriceValue":{"allOf":[{"$ref":"#/components/schemas/ThresholdPriceValue"}],"description":"Threshold price value for carrier selection"},"trackAndTraceUrl":{"description":"Track and trace URL","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","type":"integer"}},"required":["version","carrierRef","returnLabel"],"title":"DhlV2CarrierConfiguration","type":"object","description":"DhlV2CarrierConfiguration"},"SftpConfiguration":{"properties":{"useSftpForTandT":{"description":"Indicates if the carrier uses sftp for getting track and trace data","type":"boolean"}},"required":["useSftpForTandT"],"title":"SftpConfiguration","type":"object","description":"SftpConfiguration"},"VceCarrierConfiguration":{"properties":{"additionalWeightInPercent":{"description":"It is an amount of percentage for packaging weight which will be added to the calculated shipping weight","minimum":0,"type":"number"},"alternativeReturnAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddress"}],"description":"Alternative return address for this carrier"},"alternativeSendAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddress"}],"description":"Alternative send address for this carrier"},"carrierRef":{"description":"Reference to the carrier this configuration belongs to","type":"string"},"countryServiceMappings":{"description":"Country service mappings for this carrier configuration","items":{"$ref":"#/components/schemas/CarrierCountryServiceMapping"},"maxItems":100,"type":"array"},"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"defaultPickUpTime":{"allOf":[{"$ref":"#/components/schemas/CarrierPickUpTime"}],"description":"Default pick up time configuration for carriers supporting pick up scheduling, will be used to calculate the next possible pick up date"},"fallBackTrackAndTraceEmail":{"description":"EmailAddress used to receive track and trace information when no other emailaddress was provided","format":"email","minLength":1,"type":"string"},"id":{"description":"The id of the carrier configuration","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"mustBeWeighed":{"default":false,"description":"Indicates if the content of a parcel must be weighed before ordering a label","type":"boolean"},"nonDeliveryDaysPerCountryAndProvince":{"description":"Non-delivery days per country and province","items":{"$ref":"#/components/schemas/NonDeliveryDaysPerCountryAndProvince"},"maxItems":500,"type":"array"},"returnLabel":{"default":false,"description":"When enabled, a return label will be created by creating a shipping label","type":"boolean"},"serviceUrl":{"description":"Service URL for this carrier configuration","type":"string"},"thresholdPriceValue":{"allOf":[{"$ref":"#/components/schemas/ThresholdPriceValue"}],"description":"Threshold price value for carrier selection"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","type":"integer"}},"required":["version","carrierRef","returnLabel"],"title":"VceCarrierConfiguration","type":"object","description":"VceCarrierConfiguration"},"PostNlCarrierConfiguration":{"properties":{"additionalWeightInPercent":{"description":"It is an amount of percentage for packaging weight which will be added to the calculated shipping weight","minimum":0,"type":"number"},"alternativeReturnAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddress"}],"description":"Alternative return address for this carrier"},"alternativeSendAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddress"}],"description":"Alternative send address for this carrier"},"carrierRef":{"description":"Reference to the carrier this configuration belongs to","type":"string"},"countryServiceMappings":{"description":"Country service mappings for this carrier configuration","items":{"$ref":"#/components/schemas/CarrierCountryServiceMapping"},"maxItems":100,"type":"array"},"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"defaultPickUpTime":{"allOf":[{"$ref":"#/components/schemas/CarrierPickUpTime"}],"description":"Default pick up time configuration for carriers supporting pick up scheduling, will be used to calculate the next possible pick up date"},"fallBackTrackAndTraceEmail":{"description":"EmailAddress used to receive track and trace information when no other emailaddress was provided","format":"email","minLength":1,"type":"string"},"id":{"description":"The id of the carrier configuration","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"mustBeWeighed":{"default":false,"description":"Indicates if the content of a parcel must be weighed before ordering a label","type":"boolean"},"nonDeliveryDaysPerCountryAndProvince":{"description":"Non-delivery days per country and province","items":{"$ref":"#/components/schemas/NonDeliveryDaysPerCountryAndProvince"},"maxItems":500,"type":"array"},"returnLabel":{"default":false,"description":"When enabled, a return label will be created by creating a shipping label","type":"boolean"},"serviceUrl":{"description":"Service URL for this carrier configuration","type":"string"},"thresholdPriceValue":{"allOf":[{"$ref":"#/components/schemas/ThresholdPriceValue"}],"description":"Threshold price value for carrier selection"},"trackAndTraceUrl":{"description":"Track and trace URL","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","type":"integer"}},"required":["version","carrierRef","returnLabel"],"title":"PostNlCarrierConfiguration","type":"object","description":"PostNlCarrierConfiguration"},"SevenSendersCarrierConfiguration":{"properties":{"additionalWeightInPercent":{"description":"It is an amount of percentage for packaging weight which will be added to the calculated shipping weight","minimum":0,"type":"number"},"alternativeReturnAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddress"}],"description":"Alternative return address for this carrier"},"alternativeSendAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddress"}],"description":"Alternative send address for this carrier"},"carrierRef":{"description":"Reference to the carrier this configuration belongs to","type":"string"},"countryServiceMappings":{"description":"Country service mappings for this carrier configuration","items":{"$ref":"#/components/schemas/CarrierCountryServiceMapping"},"maxItems":100,"type":"array"},"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"defaultPickUpTime":{"allOf":[{"$ref":"#/components/schemas/CarrierPickUpTime"}],"description":"Default pick up time configuration for carriers supporting pick up scheduling, will be used to calculate the next possible pick up date"},"fallBackTrackAndTraceEmail":{"description":"EmailAddress used to receive track and trace information when no other emailaddress was provided","format":"email","minLength":1,"type":"string"},"id":{"description":"The id of the carrier configuration","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"mustBeWeighed":{"default":false,"description":"Indicates if the content of a parcel must be weighed before ordering a label","type":"boolean"},"nonDeliveryDaysPerCountryAndProvince":{"description":"Non-delivery days per country and province","items":{"$ref":"#/components/schemas/NonDeliveryDaysPerCountryAndProvince"},"maxItems":500,"type":"array"},"returnLabel":{"default":false,"description":"When enabled, a return label will be created by creating a shipping label","type":"boolean"},"serviceUrl":{"description":"Service URL for this carrier configuration","type":"string"},"thresholdPriceValue":{"allOf":[{"$ref":"#/components/schemas/ThresholdPriceValue"}],"description":"Threshold price value for carrier selection"},"trackAndTraceUrl":{"description":"Track and trace URL","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","type":"integer"},"warehouse":{"description":"Warehouse identifier","type":"string"}},"required":["version","carrierRef","returnLabel"],"title":"SevenSendersCarrierConfiguration","type":"object","description":"SevenSendersCarrierConfiguration"},"UBSendCarrierConfiguration":{"properties":{"additionalWeightInPercent":{"description":"It is an amount of percentage for packaging weight which will be added to the calculated shipping weight","minimum":0,"type":"number"},"alternativeReturnAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddress"}],"description":"Alternative return address for this carrier"},"alternativeSendAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddress"}],"description":"Alternative send address for this carrier"},"carrierRef":{"description":"Reference to the carrier this configuration belongs to","type":"string"},"countryServiceMappings":{"description":"Country service mappings for this carrier configuration","items":{"$ref":"#/components/schemas/CarrierCountryServiceMapping"},"maxItems":100,"type":"array"},"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"defaultPickUpTime":{"allOf":[{"$ref":"#/components/schemas/CarrierPickUpTime"}],"description":"Default pick up time configuration for carriers supporting pick up scheduling, will be used to calculate the next possible pick up date"},"fallBackTrackAndTraceEmail":{"description":"EmailAddress used to receive track and trace information when no other emailaddress was provided","format":"email","minLength":1,"type":"string"},"id":{"description":"The id of the carrier configuration","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"mustBeWeighed":{"default":false,"description":"Indicates if the content of a parcel must be weighed before ordering a label","type":"boolean"},"nonDeliveryDaysPerCountryAndProvince":{"description":"Non-delivery days per country and province","items":{"$ref":"#/components/schemas/NonDeliveryDaysPerCountryAndProvince"},"maxItems":500,"type":"array"},"returnLabel":{"default":false,"description":"When enabled, a return label will be created by creating a shipping label","type":"boolean"},"serviceUrl":{"description":"Service URL for this carrier configuration","type":"string"},"thresholdPriceValue":{"allOf":[{"$ref":"#/components/schemas/ThresholdPriceValue"}],"description":"Threshold price value for carrier selection"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","type":"integer"}},"required":["version","carrierRef","returnLabel"],"title":"UBSendCarrierConfiguration","type":"object","description":"UBSendCarrierConfiguration"},"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}/configuration":{"put":{"deprecated":false,"description":"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.","operationId":"putCarrierConfiguration","parameters":[{"in":"path","name":"carrierId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/CarrierConfiguration"},{"$ref":"#/components/schemas/GlsCarrierConfiguration"},{"$ref":"#/components/schemas/FedexCarrierConfiguration"},{"$ref":"#/components/schemas/BringCarrierConfiguration"},{"$ref":"#/components/schemas/DpdChCarrierConfiguration"},{"$ref":"#/components/schemas/DhlV2CarrierConfiguration"},{"$ref":"#/components/schemas/VceCarrierConfiguration"},{"$ref":"#/components/schemas/PostNlCarrierConfiguration"},{"$ref":"#/components/schemas/SevenSendersCarrierConfiguration"},{"$ref":"#/components/schemas/UBSendCarrierConfiguration"}]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CarrierConfiguration"}}},"description":"Carrier Configuration 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":"Update carrier config","tags":["Carriers Configuration (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/by-pillar/store-operations/carrier-management/custom-carrier-endpoints.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.