> ## Documentation Index > Fetch the complete documentation index at: https://docs.shipstream.io/llms.txt > Use this file to discover all available pages before exploring further. # Create Location Tag > Creates a new `LocationTag` according to the request body. The `name` must be unique among live location tags; deleting a tag renames it with a suffix, so a deleted tag's original name is immediately reusable. ## OpenAPI ````yaml POST /v1/inventory/location-tags openapi: 3.0.3 info: title: ShipStream version: '1.0' license: name: Commercial (Copyright 2025 - All Rights Reserved) url: https://shipstream.io contact: name: ShipStream Support email: help@shipstream.io termsOfService: https://shipstream.io/legal/api-terms/ servers: - url: https://{base_url_domain}/api/global description: Direct API Url variables: base_url_domain: default: example.shipstream.app description: >- The fully qualified domain name for your ShipStream WMS instance. This is either a custom domain, or a subdomain of shipstream.app, and will be the same as the domain name for the page which you use to login to ShipStream WMS. security: - ShipStream_bearerAuth: [] tags: - name: Warehouses x-displayName: Warehouses - name: Products x-displayName: Products - name: ProductProfiles x-displayName: ProductProfiles - name: HandlingClasses x-displayName: HandlingClasses - name: Locations x-displayName: Locations - name: LocationTags x-displayName: LocationTags - name: SlotTypes x-displayName: SlotTypes - name: Levels x-displayName: Levels - name: HoldReasons x-displayName: HoldReasons - name: Holds x-displayName: Holds - name: Replenishment x-displayName: Replenishment - name: LocationProfiles x-displayName: LocationProfiles - name: SlottingRules x-displayName: SlottingRules - name: Deliveries description: Every thing about a Delivery Receiving x-displayName: Deliveries - name: Shipments x-displayName: Shipments - name: Orders x-displayName: Orders - name: Retailers x-displayName: Retailers - name: Users x-displayName: Users - name: User Roles x-displayName: User Roles - name: Merchants x-displayName: Merchants - name: Healthcheck x-displayName: Healthcheck paths: /v1/inventory/location-tags: post: tags: - LocationTags summary: Create Location Tag description: >- Creates a new `LocationTag` according to the request body. The `name` must be unique among live location tags; deleting a tag renames it with a suffix, so a deleted tag's original name is immediately reusable. operationId: createLocationTag parameters: - $ref: '#/components/parameters/Inventory_API_v1_location-tag-fields' requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 230 description: >- The display name of the tag. HTML tags are stripped and surrounding whitespace is trimmed. The limit is short of the field's own 255 characters because the rest is reserved for the suffix the name carries once the tag is deleted. example: Hazmat description: type: string maxLength: 255 nullable: true example: Locations approved to store hazardous materials. description: An explanation of what the tag signifies. color: $ref: '#/components/schemas/Inventory_API_v1_tag_color' sort_order: type: integer minimum: -2147483648 maximum: 2147483647 description: >- The position the tag takes when tags are listed for selection. Defaults to `1`. example: 1 required: - name - color additionalProperties: false responses: '201': description: Location tag created. content: application/json: schema: type: object properties: resource: $ref: '#/components/schemas/Inventory_API_v1_LocationTag' '400': $ref: '#/components/responses/Inventory_API_v1_400-bad-request' '422': $ref: '#/components/responses/Inventory_API_v1_422-unprocessable' '500': $ref: '#/components/responses/Inventory_API_v1_500-internal-server-error' components: parameters: Inventory_API_v1_location-tag-fields: name: fields in: query required: false description: >- Specify additional fields of the `LocationTag` object to be included in the response. See the [selecting fields](/global-api/selecting-fields) page for more information. explode: false schema: $ref: '#/components/schemas/Inventory_API_v1_location-tag-fields-enum' schemas: Inventory_API_v1_tag_color: type: string enum: - black1 - black2 - black3 - black4 - black5 - blue1 - blue2 - blue3 - blue4 - blue5 - brown1 - brown2 - brown3 - brown4 - brown5 - gray1 - gray2 - gray3 - gray4 - gray5 - green1 - green2 - green3 - green4 - green5 - orange1 - orange2 - orange3 - orange4 - orange5 - purple1 - purple2 - purple3 - purple4 - purple5 - red1 - red2 - red3 - red4 - red5 - yellow1 - yellow2 - yellow3 - yellow4 - yellow5 example: blue3 description: >- The palette entry the tag renders with, written as a color family followed by a shade from 1 (lightest) to 5 (darkest). Inventory_API_v1_LocationTag: title: LocationTag type: object description: >- A `LocationTag` is a free-form label that warehouse staff assign to locations to record a property the location schema does not model — "hazmat approved", "cold storage", "mezzanine". Location Profiles match on tags, so the set of tags is part of a warehouse's slotting policy rather than mere decoration. Deleting a tag is a soft delete: the row survives so locations already carrying it keep rendering it, and only its availability for new assignments is withdrawn. properties: type: type: string enum: - LocationTag readOnly: true description: >- This is a read-only property that describes the type of object in the response body. id: type: integer format: int32 description: >- The internal `id` property used as a path parameter in a resource lookup. readOnly: true example: 4 name: type: string maxLength: 255 example: Hazmat description: >- The display name of the tag, unique among location tags. A submitted name is limited to 230 characters; the remainder of the field is reserved for the suffix a deleted tag carries. description: type: string maxLength: 255 nullable: true example: Locations approved to store hazardous materials. description: An explanation of what the tag signifies. color: $ref: '#/components/schemas/Inventory_API_v1_tag_color' sort_order: type: integer example: 1 description: >- The position the tag takes relative to other location tags when they are listed for selection. is_deleted: type: boolean example: false description: >- Whether the tag has been soft-deleted. Deleted tags cannot be assigned to further locations, and their `name` carries a `(Deleted ID: n)` suffix so the original name becomes available again. created_at: type: string format: date-time nullable: true example: '2026-08-01T14:03:22Z' description: |- The UTC date and time the tag was created.\ `Optional Field` updated_at: type: string format: date-time nullable: true example: '2026-08-01T14:03:22Z' description: |- The UTC date and time the tag was last modified.\ `Optional Field` required: - type - id additionalProperties: false Inventory_API_v1_location-tag-fields-enum: title: LocationTag description: >- Specify additional fields of the `LocationTag` object to be included in the response. type: array items: type: string enum: - basic - all - name - description - color - sort_order - is_deleted - created_at - updated_at responses: Inventory_API_v1_400-bad-request: description: >- The request was invalid. The client must change the request. See the response body for more details. content: application/json: schema: type: object properties: errors: type: array items: type: object properties: type: type: string description: The error type code. enum: - parser - parameters - openapi message: type: string description: An English sentence describing the error type. details: type: array description: >- An array of objects describing which keys are responsible for the error and detailed messages describing why they are not valid. items: type: object properties: key: type: string description: The path to the key which relates to the error. message: type: string description: >- An English sentence describing the details of the error. additionalProperties: false additionalProperties: false minItems: 1 additionalProperties: false example: errors: - type: parameters message: The supplied parameters are invalid. Inventory_API_v1_422-unprocessable: description: >- There was an error processing the request. See the response body for more details. content: application/json: schema: type: object properties: errors: type: array items: type: object properties: type: type: string description: The error type code. enum: - application - unable_to_process message: type: string description: An English sentence describing the error type. details: type: array description: >- An array of objects describing which keys are responsible for the error and detailed messages describing why they are not valid. items: type: object properties: key: type: string description: The path to the key which relates to the error. message: type: string description: >- An English sentence describing the details of the error. additionalProperties: false additionalProperties: false minItems: 1 additionalProperties: false example: errors: - type: unable_to_process message: There was an error processing the request. Inventory_API_v1_500-internal-server-error: description: >- Internal Server Error - Something wrong happened at server side. Contact server administrator for more details. securitySchemes: ShipStream_bearerAuth: type: http scheme: bearer bearerFormat: JWT description: >- Generate a JWT access token through a Custom Global Integration and provide it with each request in the `Authorization` header prefixed with "Bearer" and then a single space. ````