> For the complete documentation index, see [llms.txt](https://docs.fulfillmenttools.com/documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.fulfillmenttools.com/documentation/apis/api-reference/labels.md).
# Labels
Endpoints to create, update, and read shipping labels.
## Create label
> Create label
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read shipping labels.","name":"Labels"}],"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":{"LabelForCreation":{"properties":{"additionalDocuments":{"description":"Additional documents attached to the label","items":{"$ref":"#/components/schemas/LabelAdditionalDocument"},"maxItems":20,"type":"array"},"carrierData":{"allOf":[{"$ref":"#/components/schemas/LabelCarrierData"}],"description":"Carrier and product details"},"customAttributes":{"additionalProperties":true,"description":"Custom attributes","type":"object"},"labelUrl":{"description":"URL to download the label document","type":"string"},"operativeProcessRef":{"description":"Reference to the operative process","type":"string"},"packageRef":{"description":"Reference to the package","type":"string"},"processRef":{"description":"Reference to the fulfillment process","type":"string"},"recipientAddress":{"description":"Recipient addresses","items":{"$ref":"#/components/schemas/ConsumerAddress"},"maxItems":10,"type":"array"},"senderAddress":{"$ref":"#/components/schemas/FacilityAddress"},"shippingInformationRef":{"description":"Reference to the shipping information","type":"string"},"shortId":{"description":"Short human-readable identifier","type":"string"},"status":{"description":"Current status of the label","enum":["WAITING_FOR_INPUT","REQUESTABLE","REQUESTED","SUCCESSFUL","FAILED","CANCELLED","OBSOLETE"],"type":"string"},"tenantLabelId":{"description":"Tenant-specific label identifier","type":"string"},"tenantOrderId":{"description":"Tenant-specific order identifier","type":"string"},"type":{"description":"Type of label","enum":["SEND_LABEL","RETURN_LABEL"],"type":"string"}},"required":["status","shippingInformationRef","additionalDocuments","carrierData","senderAddress","recipientAddress","type"],"title":"LabelForCreation","type":"object","description":"LabelForCreation"},"LabelAdditionalDocument":{"properties":{"nameLocalized":{"additionalProperties":true,"description":"Localized name of the document","type":"object"},"url":{"description":"URL to the additional document","type":"string"}},"required":["url","nameLocalized"],"title":"LabelAdditionalDocument","type":"object","description":"LabelAdditionalDocument"},"LabelCarrierData":{"properties":{"carrierRef":{"description":"Reference to the carrier","type":"string"},"product":{"description":"Carrier product identifier","type":"string"},"services":{"description":"Additional carrier services","items":{"$ref":"#/components/schemas/CarrierService"},"maxItems":20,"type":"array"}},"required":["carrierRef"],"title":"LabelCarrierData","type":"object","description":"LabelCarrierData"},"CarrierService":{"properties":{"type":{"description":"Service type identifier","type":"string"}},"required":["type"],"title":"CarrierService","type":"object","description":"CarrierService"},"ConsumerAddress":{"allOf":[{"$ref":"#/components/schemas/Address"}],"properties":{"addressType":{"$ref":"#/components/schemas/AddressType"},"companyName":{"type":"string"},"coordinates":{"$ref":"#/components/schemas/Coordinates"},"email":{"format":"email","minLength":1,"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"personalTitle":{"type":"string"},"salutation":{"type":"string"}},"type":"object","title":"ConsumerAddress","description":"ConsumerAddress"},"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"},"AddressType":{"description":"Type of this address, used e.g. for communication with the carrier. Use POSTAL_ADDRESS for the address where the order should be shipped to, INVOICE_ADDRESS for the address where the invoice is sent to and PARCEL_LOCKER if a parcel locker is used for this order.","enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string","title":"AddressType"},"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"},"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":{"allOf":[{"$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"},"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"},"Label":{"properties":{"additionalDocuments":{"description":"Additional documents attached to the label","items":{"$ref":"#/components/schemas/LabelAdditionalDocument"},"maxItems":20,"type":"array"},"anonymized":{"description":"Whether the label data has been anonymized","type":"boolean"},"carrierData":{"allOf":[{"$ref":"#/components/schemas/LabelCarrierData"}],"description":"Carrier and product details"},"created":{"description":"Creation timestamp","format":"date-time","type":"string"},"customAttributes":{"additionalProperties":true,"description":"Custom attributes","type":"object"},"facilityRef":{"description":"Reference to the connected facility","type":"string"},"id":{"description":"Unique identifier of the label","type":"string"},"labelUrl":{"description":"URL to download the label document","type":"string"},"lastModified":{"description":"Last modification timestamp","format":"date-time","type":"string"},"operativeProcessRef":{"description":"Reference to the operative process","type":"string"},"packageRef":{"description":"Reference to the package","type":"string"},"processRef":{"description":"Reference to the fulfillment process","type":"string"},"recipientAddress":{"description":"Recipient addresses","items":{"$ref":"#/components/schemas/ConsumerAddress"},"maxItems":10,"type":"array"},"senderAddress":{"$ref":"#/components/schemas/FacilityAddress"},"shippingInformationRef":{"description":"Reference to the shipping information","type":"string"},"shortId":{"description":"Short human-readable identifier","type":"string"},"status":{"description":"Current status of the label","enum":["WAITING_FOR_INPUT","REQUESTABLE","REQUESTED","SUCCESSFUL","FAILED","CANCELLED","OBSOLETE"],"type":"string"},"tenantLabelId":{"description":"Tenant-specific label identifier","type":"string"},"tenantOrderId":{"description":"Tenant-specific order identifier","type":"string"},"type":{"description":"Type of label","enum":["SEND_LABEL","RETURN_LABEL"],"type":"string"},"version":{"description":"Optimistic locking version","type":"integer"}},"required":["id","status","processRef","operativeProcessRef","facilityRef","shippingInformationRef","additionalDocuments","carrierData","senderAddress","recipientAddress","type","anonymized","created","lastModified","version"],"title":"Label","type":"object","description":"Label"},"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/labels":{"post":{"deprecated":false,"description":"Create label","operationId":"addLabel","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LabelForCreation"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Label"}}},"description":"The label was successfully created."},"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 endpoint"}},"summary":"Create label","tags":["Labels"]}}}}
```
## Get label
> This part of the API is in Alpha status. For details, see the \API release lifecycle documentation\.\
\
Get label
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read shipping labels.","name":"Labels"}],"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":{"Label":{"properties":{"additionalDocuments":{"description":"Additional documents attached to the label","items":{"$ref":"#/components/schemas/LabelAdditionalDocument"},"maxItems":20,"type":"array"},"anonymized":{"description":"Whether the label data has been anonymized","type":"boolean"},"carrierData":{"allOf":[{"$ref":"#/components/schemas/LabelCarrierData"}],"description":"Carrier and product details"},"created":{"description":"Creation timestamp","format":"date-time","type":"string"},"customAttributes":{"additionalProperties":true,"description":"Custom attributes","type":"object"},"facilityRef":{"description":"Reference to the connected facility","type":"string"},"id":{"description":"Unique identifier of the label","type":"string"},"labelUrl":{"description":"URL to download the label document","type":"string"},"lastModified":{"description":"Last modification timestamp","format":"date-time","type":"string"},"operativeProcessRef":{"description":"Reference to the operative process","type":"string"},"packageRef":{"description":"Reference to the package","type":"string"},"processRef":{"description":"Reference to the fulfillment process","type":"string"},"recipientAddress":{"description":"Recipient addresses","items":{"$ref":"#/components/schemas/ConsumerAddress"},"maxItems":10,"type":"array"},"senderAddress":{"$ref":"#/components/schemas/FacilityAddress"},"shippingInformationRef":{"description":"Reference to the shipping information","type":"string"},"shortId":{"description":"Short human-readable identifier","type":"string"},"status":{"description":"Current status of the label","enum":["WAITING_FOR_INPUT","REQUESTABLE","REQUESTED","SUCCESSFUL","FAILED","CANCELLED","OBSOLETE"],"type":"string"},"tenantLabelId":{"description":"Tenant-specific label identifier","type":"string"},"tenantOrderId":{"description":"Tenant-specific order identifier","type":"string"},"type":{"description":"Type of label","enum":["SEND_LABEL","RETURN_LABEL"],"type":"string"},"version":{"description":"Optimistic locking version","type":"integer"}},"required":["id","status","processRef","operativeProcessRef","facilityRef","shippingInformationRef","additionalDocuments","carrierData","senderAddress","recipientAddress","type","anonymized","created","lastModified","version"],"title":"Label","type":"object","description":"Label"},"LabelAdditionalDocument":{"properties":{"nameLocalized":{"additionalProperties":true,"description":"Localized name of the document","type":"object"},"url":{"description":"URL to the additional document","type":"string"}},"required":["url","nameLocalized"],"title":"LabelAdditionalDocument","type":"object","description":"LabelAdditionalDocument"},"LabelCarrierData":{"properties":{"carrierRef":{"description":"Reference to the carrier","type":"string"},"product":{"description":"Carrier product identifier","type":"string"},"services":{"description":"Additional carrier services","items":{"$ref":"#/components/schemas/CarrierService"},"maxItems":20,"type":"array"}},"required":["carrierRef"],"title":"LabelCarrierData","type":"object","description":"LabelCarrierData"},"CarrierService":{"properties":{"type":{"description":"Service type identifier","type":"string"}},"required":["type"],"title":"CarrierService","type":"object","description":"CarrierService"},"ConsumerAddress":{"allOf":[{"$ref":"#/components/schemas/Address"}],"properties":{"addressType":{"$ref":"#/components/schemas/AddressType"},"companyName":{"type":"string"},"coordinates":{"$ref":"#/components/schemas/Coordinates"},"email":{"format":"email","minLength":1,"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"personalTitle":{"type":"string"},"salutation":{"type":"string"}},"type":"object","title":"ConsumerAddress","description":"ConsumerAddress"},"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"},"AddressType":{"description":"Type of this address, used e.g. for communication with the carrier. Use POSTAL_ADDRESS for the address where the order should be shipped to, INVOICE_ADDRESS for the address where the invoice is sent to and PARCEL_LOCKER if a parcel locker is used for this order.","enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string","title":"AddressType"},"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"},"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":{"allOf":[{"$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"},"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"},"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/labels/{id}":{"get":{"deprecated":false,"description":"This part of the API is in Alpha status. For details, see the API release lifecycle documentation.
Get label","operationId":"getLabel","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Label"}}},"description":"Label was found. 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 endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"The requested entity was not found"}},"summary":"Get label","tags":["Labels"]}}}}
```
## Update label
> This part of the API is in Alpha status. For details, see the \API release lifecycle documentation\.\
\
Update label
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read shipping labels.","name":"Labels"}],"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":{"LabelForUpdate":{"properties":{"anonymized":{"description":"Whether the label data has been anonymized","type":"boolean"},"carrierData":{"allOf":[{"$ref":"#/components/schemas/LabelCarrierData"}],"description":"Carrier and product details"},"labelUrl":{"description":"URL to download the label document","type":"string"},"recipientAddress":{"description":"Recipient addresses","items":{"$ref":"#/components/schemas/ConsumerAddress"},"maxItems":10,"type":"array"},"senderAddress":{"$ref":"#/components/schemas/FacilityAddress"},"shortId":{"description":"Short human-readable identifier","type":"string"},"status":{"description":"Current status of the label","enum":["WAITING_FOR_INPUT","REQUESTABLE","REQUESTED","SUCCESSFUL","FAILED","CANCELLED","OBSOLETE"],"type":"string"},"tenantOrderId":{"description":"Tenant-specific order identifier","type":"string"},"type":{"description":"Type of label","enum":["SEND_LABEL","RETURN_LABEL"],"type":"string"},"version":{"description":"Optimistic locking version","type":"integer"}},"required":["version"],"title":"LabelForUpdate","type":"object","description":"LabelForUpdate"},"LabelCarrierData":{"properties":{"carrierRef":{"description":"Reference to the carrier","type":"string"},"product":{"description":"Carrier product identifier","type":"string"},"services":{"description":"Additional carrier services","items":{"$ref":"#/components/schemas/CarrierService"},"maxItems":20,"type":"array"}},"required":["carrierRef"],"title":"LabelCarrierData","type":"object","description":"LabelCarrierData"},"CarrierService":{"properties":{"type":{"description":"Service type identifier","type":"string"}},"required":["type"],"title":"CarrierService","type":"object","description":"CarrierService"},"ConsumerAddress":{"allOf":[{"$ref":"#/components/schemas/Address"}],"properties":{"addressType":{"$ref":"#/components/schemas/AddressType"},"companyName":{"type":"string"},"coordinates":{"$ref":"#/components/schemas/Coordinates"},"email":{"format":"email","minLength":1,"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"personalTitle":{"type":"string"},"salutation":{"type":"string"}},"type":"object","title":"ConsumerAddress","description":"ConsumerAddress"},"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"},"AddressType":{"description":"Type of this address, used e.g. for communication with the carrier. Use POSTAL_ADDRESS for the address where the order should be shipped to, INVOICE_ADDRESS for the address where the invoice is sent to and PARCEL_LOCKER if a parcel locker is used for this order.","enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string","title":"AddressType"},"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"},"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":{"allOf":[{"$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"},"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"},"Label":{"properties":{"additionalDocuments":{"description":"Additional documents attached to the label","items":{"$ref":"#/components/schemas/LabelAdditionalDocument"},"maxItems":20,"type":"array"},"anonymized":{"description":"Whether the label data has been anonymized","type":"boolean"},"carrierData":{"allOf":[{"$ref":"#/components/schemas/LabelCarrierData"}],"description":"Carrier and product details"},"created":{"description":"Creation timestamp","format":"date-time","type":"string"},"customAttributes":{"additionalProperties":true,"description":"Custom attributes","type":"object"},"facilityRef":{"description":"Reference to the connected facility","type":"string"},"id":{"description":"Unique identifier of the label","type":"string"},"labelUrl":{"description":"URL to download the label document","type":"string"},"lastModified":{"description":"Last modification timestamp","format":"date-time","type":"string"},"operativeProcessRef":{"description":"Reference to the operative process","type":"string"},"packageRef":{"description":"Reference to the package","type":"string"},"processRef":{"description":"Reference to the fulfillment process","type":"string"},"recipientAddress":{"description":"Recipient addresses","items":{"$ref":"#/components/schemas/ConsumerAddress"},"maxItems":10,"type":"array"},"senderAddress":{"$ref":"#/components/schemas/FacilityAddress"},"shippingInformationRef":{"description":"Reference to the shipping information","type":"string"},"shortId":{"description":"Short human-readable identifier","type":"string"},"status":{"description":"Current status of the label","enum":["WAITING_FOR_INPUT","REQUESTABLE","REQUESTED","SUCCESSFUL","FAILED","CANCELLED","OBSOLETE"],"type":"string"},"tenantLabelId":{"description":"Tenant-specific label identifier","type":"string"},"tenantOrderId":{"description":"Tenant-specific order identifier","type":"string"},"type":{"description":"Type of label","enum":["SEND_LABEL","RETURN_LABEL"],"type":"string"},"version":{"description":"Optimistic locking version","type":"integer"}},"required":["id","status","processRef","operativeProcessRef","facilityRef","shippingInformationRef","additionalDocuments","carrierData","senderAddress","recipientAddress","type","anonymized","created","lastModified","version"],"title":"Label","type":"object","description":"Label"},"LabelAdditionalDocument":{"properties":{"nameLocalized":{"additionalProperties":true,"description":"Localized name of the document","type":"object"},"url":{"description":"URL to the additional document","type":"string"}},"required":["url","nameLocalized"],"title":"LabelAdditionalDocument","type":"object","description":"LabelAdditionalDocument"},"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/labels/{id}":{"patch":{"deprecated":false,"description":"This part of the API is in Alpha status. For details, see the API release lifecycle documentation.
Update label","operationId":"patchLabel","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LabelForUpdate"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Label"}}},"description":"Label was found and 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 endpoint"},"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 label","tags":["Labels"]}}}}
```
## Performs provided labelAction
> This part of the API is in Alpha status. For details, see the \API release lifecycle documentation\.\
\
Performs provided labelAction
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read shipping labels.","name":"Labels"}],"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":{"RequestLabelAction":{"properties":{"name":{"description":"Identifier of the specified action.","type":"string"},"version":{"description":"Optimistic locking version","type":"integer"}},"required":["name","version"],"title":"RequestLabelAction","type":"object","description":"RequestLabelAction"},"Label":{"properties":{"additionalDocuments":{"description":"Additional documents attached to the label","items":{"$ref":"#/components/schemas/LabelAdditionalDocument"},"maxItems":20,"type":"array"},"anonymized":{"description":"Whether the label data has been anonymized","type":"boolean"},"carrierData":{"allOf":[{"$ref":"#/components/schemas/LabelCarrierData"}],"description":"Carrier and product details"},"created":{"description":"Creation timestamp","format":"date-time","type":"string"},"customAttributes":{"additionalProperties":true,"description":"Custom attributes","type":"object"},"facilityRef":{"description":"Reference to the connected facility","type":"string"},"id":{"description":"Unique identifier of the label","type":"string"},"labelUrl":{"description":"URL to download the label document","type":"string"},"lastModified":{"description":"Last modification timestamp","format":"date-time","type":"string"},"operativeProcessRef":{"description":"Reference to the operative process","type":"string"},"packageRef":{"description":"Reference to the package","type":"string"},"processRef":{"description":"Reference to the fulfillment process","type":"string"},"recipientAddress":{"description":"Recipient addresses","items":{"$ref":"#/components/schemas/ConsumerAddress"},"maxItems":10,"type":"array"},"senderAddress":{"$ref":"#/components/schemas/FacilityAddress"},"shippingInformationRef":{"description":"Reference to the shipping information","type":"string"},"shortId":{"description":"Short human-readable identifier","type":"string"},"status":{"description":"Current status of the label","enum":["WAITING_FOR_INPUT","REQUESTABLE","REQUESTED","SUCCESSFUL","FAILED","CANCELLED","OBSOLETE"],"type":"string"},"tenantLabelId":{"description":"Tenant-specific label identifier","type":"string"},"tenantOrderId":{"description":"Tenant-specific order identifier","type":"string"},"type":{"description":"Type of label","enum":["SEND_LABEL","RETURN_LABEL"],"type":"string"},"version":{"description":"Optimistic locking version","type":"integer"}},"required":["id","status","processRef","operativeProcessRef","facilityRef","shippingInformationRef","additionalDocuments","carrierData","senderAddress","recipientAddress","type","anonymized","created","lastModified","version"],"title":"Label","type":"object","description":"Label"},"LabelAdditionalDocument":{"properties":{"nameLocalized":{"additionalProperties":true,"description":"Localized name of the document","type":"object"},"url":{"description":"URL to the additional document","type":"string"}},"required":["url","nameLocalized"],"title":"LabelAdditionalDocument","type":"object","description":"LabelAdditionalDocument"},"LabelCarrierData":{"properties":{"carrierRef":{"description":"Reference to the carrier","type":"string"},"product":{"description":"Carrier product identifier","type":"string"},"services":{"description":"Additional carrier services","items":{"$ref":"#/components/schemas/CarrierService"},"maxItems":20,"type":"array"}},"required":["carrierRef"],"title":"LabelCarrierData","type":"object","description":"LabelCarrierData"},"CarrierService":{"properties":{"type":{"description":"Service type identifier","type":"string"}},"required":["type"],"title":"CarrierService","type":"object","description":"CarrierService"},"ConsumerAddress":{"allOf":[{"$ref":"#/components/schemas/Address"}],"properties":{"addressType":{"$ref":"#/components/schemas/AddressType"},"companyName":{"type":"string"},"coordinates":{"$ref":"#/components/schemas/Coordinates"},"email":{"format":"email","minLength":1,"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"personalTitle":{"type":"string"},"salutation":{"type":"string"}},"type":"object","title":"ConsumerAddress","description":"ConsumerAddress"},"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"},"AddressType":{"description":"Type of this address, used e.g. for communication with the carrier. Use POSTAL_ADDRESS for the address where the order should be shipped to, INVOICE_ADDRESS for the address where the invoice is sent to and PARCEL_LOCKER if a parcel locker is used for this order.","enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string","title":"AddressType"},"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"},"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":{"allOf":[{"$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"},"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"},"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/labels/{id}/actions":{"post":{"deprecated":false,"description":"This part of the API is in Alpha status. For details, see the API release lifecycle documentation.
Performs provided labelAction","operationId":"performLabelAction","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/RequestLabelAction"}]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Label"}}},"description":"Label was found and provided action 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 endpoint"},"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":"Performs provided labelAction","tags":["Labels"]}}}}
```
## Labels (search)
> This part of the API is in Beta status. For details, see the \API release lifecycle documentation\.\
\
Search for Label
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read shipping labels.","name":"Labels"}],"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":{"LabelSearchPayload":{"properties":{"after":{"deprecated":false,"description":"The cursor to start after for forward pagination. The value is provided in the `pageInfo.endCursor` field of the response. Cannot be used with `before` or `last`.","type":"string"},"before":{"description":"The cursor to start before for backward pagination. The value is provided in the `pageInfo.startCursor` field of the response. Cannot be used with `after` or `size` (first).","type":"string"},"last":{"description":"Number of items to return for backward pagination. Cannot be used with 'size' (first). Default: 20.","maximum":250,"minimum":1,"type":"number"},"options":{"$ref":"#/components/schemas/SearchOptions"},"query":{"$ref":"#/components/schemas/LabelSearchQuery"},"size":{"description":"Number of items to return for forward pagination. Cannot be used with 'last'. Default: 20.","maximum":250,"minimum":1,"type":"number"},"sort":{"description":"Use for sorting the result.","items":{"$ref":"#/components/schemas/LabelSort"},"maxItems":1,"minItems":1,"type":"array"},"startAfterId":{"deprecated":true,"description":"The ID to start after. Deprecated, use `after` with the value provided in `pageInfo.endCursor` instead.","type":"string"}},"required":["query"],"title":"LabelSearchPayload","type":"object","description":"LabelSearchPayload"},"SearchOptions":{"properties":{"withTotal":{"description":"Set to true to include the total count of items in the search result.","type":"boolean"}},"title":"SearchOptions","type":"object","description":"SearchOptions"},"LabelSearchQuery":{"properties":{"and":{"items":{"$ref":"#/components/schemas/LabelSearchQuery"},"maxItems":500,"type":"array"},"created":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search entries by created. Applying a narrow and well-considered filter value is strongly recommended, as it can greatly improve response times, especially when working with large datasets."},"facilityRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by facilityRef"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"lastModified":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by lastModified"},"or":{"items":{"$ref":"#/components/schemas/LabelSearchQuery"},"maxItems":500,"type":"array"},"processRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by processRef"},"tenantLabelId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantLabelId"},"tenantOrderId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantOrderId"}},"title":"LabelSearchQuery","type":"object","description":"LabelSearchQuery"},"DateFilter":{"properties":{"after":{"description":"Search using ISO‑8601 dates relative to today. Prefix with “–” for past dates. Results include events after the specified date. Example: “–P1D” for yesterday, “P1W” for next week.","maxLength":256,"type":"string"},"before":{"description":"Search using ISO‑8601 dates relative to today. Prefix with “–” for past dates. Results include events before the specified date. Example: “–P1D” for yesterday, “P1W” for next week.","maxLength":256,"type":"string"},"eq":{"format":"date-time","type":"string"},"gt":{"format":"date-time","type":"string"},"gte":{"format":"date-time","type":"string"},"lt":{"format":"date-time","type":"string"},"lte":{"format":"date-time","type":"string"},"notEq":{"format":"date-time","type":"string"}},"title":"DateFilter","type":"object","description":"DateFilter"},"StringFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"in":{"items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"},"notEq":{"maxLength":256,"type":"string"},"notIn":{"items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"}},"title":"StringFilter","type":"object","description":"StringFilter"},"LabelSort":{"properties":{"created":{"enum":["ASC","DESC"],"type":"string"},"lastModified":{"enum":["ASC","DESC"],"type":"string"}},"title":"LabelSort","type":"object","description":"LabelSort"},"LabelPaginatedResult":{"properties":{"labels":{"items":{"$ref":"#/components/schemas/Label"},"type":"array"},"pageInfo":{"allOf":[{"$ref":"#/components/schemas/PageInfo"}],"description":"Pagination information for the search result."},"total":{"description":"The total number of items matching the search criteria. Only filled, if withTotal is set to true in the search options.","minimum":0,"type":"number"}},"required":["pageInfo","labels"],"title":"LabelPaginatedResult","type":"object","description":"LabelPaginatedResult"},"Label":{"properties":{"additionalDocuments":{"description":"Additional documents attached to the label","items":{"$ref":"#/components/schemas/LabelAdditionalDocument"},"maxItems":20,"type":"array"},"anonymized":{"description":"Whether the label data has been anonymized","type":"boolean"},"carrierData":{"allOf":[{"$ref":"#/components/schemas/LabelCarrierData"}],"description":"Carrier and product details"},"created":{"description":"Creation timestamp","format":"date-time","type":"string"},"customAttributes":{"additionalProperties":true,"description":"Custom attributes","type":"object"},"facilityRef":{"description":"Reference to the connected facility","type":"string"},"id":{"description":"Unique identifier of the label","type":"string"},"labelUrl":{"description":"URL to download the label document","type":"string"},"lastModified":{"description":"Last modification timestamp","format":"date-time","type":"string"},"operativeProcessRef":{"description":"Reference to the operative process","type":"string"},"packageRef":{"description":"Reference to the package","type":"string"},"processRef":{"description":"Reference to the fulfillment process","type":"string"},"recipientAddress":{"description":"Recipient addresses","items":{"$ref":"#/components/schemas/ConsumerAddress"},"maxItems":10,"type":"array"},"senderAddress":{"$ref":"#/components/schemas/FacilityAddress"},"shippingInformationRef":{"description":"Reference to the shipping information","type":"string"},"shortId":{"description":"Short human-readable identifier","type":"string"},"status":{"description":"Current status of the label","enum":["WAITING_FOR_INPUT","REQUESTABLE","REQUESTED","SUCCESSFUL","FAILED","CANCELLED","OBSOLETE"],"type":"string"},"tenantLabelId":{"description":"Tenant-specific label identifier","type":"string"},"tenantOrderId":{"description":"Tenant-specific order identifier","type":"string"},"type":{"description":"Type of label","enum":["SEND_LABEL","RETURN_LABEL"],"type":"string"},"version":{"description":"Optimistic locking version","type":"integer"}},"required":["id","status","processRef","operativeProcessRef","facilityRef","shippingInformationRef","additionalDocuments","carrierData","senderAddress","recipientAddress","type","anonymized","created","lastModified","version"],"title":"Label","type":"object","description":"Label"},"LabelAdditionalDocument":{"properties":{"nameLocalized":{"additionalProperties":true,"description":"Localized name of the document","type":"object"},"url":{"description":"URL to the additional document","type":"string"}},"required":["url","nameLocalized"],"title":"LabelAdditionalDocument","type":"object","description":"LabelAdditionalDocument"},"LabelCarrierData":{"properties":{"carrierRef":{"description":"Reference to the carrier","type":"string"},"product":{"description":"Carrier product identifier","type":"string"},"services":{"description":"Additional carrier services","items":{"$ref":"#/components/schemas/CarrierService"},"maxItems":20,"type":"array"}},"required":["carrierRef"],"title":"LabelCarrierData","type":"object","description":"LabelCarrierData"},"CarrierService":{"properties":{"type":{"description":"Service type identifier","type":"string"}},"required":["type"],"title":"CarrierService","type":"object","description":"CarrierService"},"ConsumerAddress":{"allOf":[{"$ref":"#/components/schemas/Address"}],"properties":{"addressType":{"$ref":"#/components/schemas/AddressType"},"companyName":{"type":"string"},"coordinates":{"$ref":"#/components/schemas/Coordinates"},"email":{"format":"email","minLength":1,"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"personalTitle":{"type":"string"},"salutation":{"type":"string"}},"type":"object","title":"ConsumerAddress","description":"ConsumerAddress"},"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"},"AddressType":{"description":"Type of this address, used e.g. for communication with the carrier. Use POSTAL_ADDRESS for the address where the order should be shipped to, INVOICE_ADDRESS for the address where the invoice is sent to and PARCEL_LOCKER if a parcel locker is used for this order.","enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string","title":"AddressType"},"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"},"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":{"allOf":[{"$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"},"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"},"PageInfo":{"properties":{"endCursor":{"description":"The cursor to use to fetch the next page of items. Use with parameter `after`.","type":"string"},"hasNextPage":{"description":"If true, there are more items after the current page.","type":"boolean"},"hasPreviousPage":{"description":"If true, there are more items before the current page.","type":"boolean"},"startCursor":{"description":"The cursor to use to fetch the previous page of items.","type":"string"}},"required":["hasNextPage","hasPreviousPage","startCursor","endCursor"],"title":"PageInfo","type":"object","description":"PageInfo"},"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/labels/search":{"post":{"deprecated":false,"description":"This part of the API is in Beta status. For details, see the API release lifecycle documentation.
Search for Label","operationId":"searchLabel","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LabelSearchPayload"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LabelPaginatedResult"}}},"description":"Your search result"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"Labels (search)","tags":["Labels"]}}}}
```
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.
Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:
```
GET https://docs.fulfillmenttools.com/documentation/apis/api-reference/labels.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.
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.