Commerce Layer tags API

openapi: 3.1.0
info:
  title: Commerce Layer addresses tags API
  version: 7.10.1
  contact:
    name: API Support
    url: https://commercelayer.io
    email: support@commercelayer.io
  description: Headless Commerce for Global Brands.
servers:
- url: https://{your_organization_slug}.commercelayer.io/api
  description: API
- url: https://core.commercelayer.io/users/sign_in
  description: Sign in
- url: https://docs.commercelayer.io/api
  description: API reference
security:
- bearerAuth: []
tags:
- name: tags
  description: resource type
paths:
  /addresses/{addressId}/tags:
    get:
      operationId: GET/addressId/tags
      summary: Retrieve the tags associated to the address
      description: Retrieve the tags associated to the address
      tags:
      - tags
      parameters:
      - name: addressId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The tags associated to the address
  /bundles/{bundleId}/tags:
    get:
      operationId: GET/bundleId/tags
      summary: Retrieve the tags associated to the bundle
      description: Retrieve the tags associated to the bundle
      tags:
      - tags
      parameters:
      - name: bundleId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The tags associated to the bundle
  /buy_x_pay_y_promotions/{buyXPayYPromotionId}/tags:
    get:
      operationId: GET/buyXPayYPromotionId/tags
      summary: Retrieve the tags associated to the buy x pay y promotion
      description: Retrieve the tags associated to the buy x pay y promotion
      tags:
      - tags
      parameters:
      - name: buyXPayYPromotionId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The tags associated to the buy x pay y promotion
  /coupons/{couponId}/tags:
    get:
      operationId: GET/couponId/tags
      summary: Retrieve the tags associated to the coupon
      description: Retrieve the tags associated to the coupon
      tags:
      - tags
      parameters:
      - name: couponId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The tags associated to the coupon
  /customers/{customerId}/tags:
    get:
      operationId: GET/customerId/tags
      summary: Retrieve the tags associated to the customer
      description: Retrieve the tags associated to the customer
      tags:
      - tags
      parameters:
      - name: customerId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The tags associated to the customer
  /external_promotions/{externalPromotionId}/tags:
    get:
      operationId: GET/externalPromotionId/tags
      summary: Retrieve the tags associated to the external promotion
      description: Retrieve the tags associated to the external promotion
      tags:
      - tags
      parameters:
      - name: externalPromotionId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The tags associated to the external promotion
  /fixed_amount_promotions/{fixedAmountPromotionId}/tags:
    get:
      operationId: GET/fixedAmountPromotionId/tags
      summary: Retrieve the tags associated to the fixed amount promotion
      description: Retrieve the tags associated to the fixed amount promotion
      tags:
      - tags
      parameters:
      - name: fixedAmountPromotionId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The tags associated to the fixed amount promotion
  /fixed_price_promotions/{fixedPricePromotionId}/tags:
    get:
      operationId: GET/fixedPricePromotionId/tags
      summary: Retrieve the tags associated to the fixed price promotion
      description: Retrieve the tags associated to the fixed price promotion
      tags:
      - tags
      parameters:
      - name: fixedPricePromotionId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The tags associated to the fixed price promotion
  /flex_promotions/{flexPromotionId}/tags:
    get:
      operationId: GET/flexPromotionId/tags
      summary: Retrieve the tags associated to the flex promotion
      description: Retrieve the tags associated to the flex promotion
      tags:
      - tags
      parameters:
      - name: flexPromotionId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The tags associated to the flex promotion
  /free_gift_promotions/{freeGiftPromotionId}/tags:
    get:
      operationId: GET/freeGiftPromotionId/tags
      summary: Retrieve the tags associated to the free gift promotion
      description: Retrieve the tags associated to the free gift promotion
      tags:
      - tags
      parameters:
      - name: freeGiftPromotionId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The tags associated to the free gift promotion
  /free_shipping_promotions/{freeShippingPromotionId}/tags:
    get:
      operationId: GET/freeShippingPromotionId/tags
      summary: Retrieve the tags associated to the free shipping promotion
      description: Retrieve the tags associated to the free shipping promotion
      tags:
      - tags
      parameters:
      - name: freeShippingPromotionId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The tags associated to the free shipping promotion
  /gift_cards/{giftCardId}/tags:
    get:
      operationId: GET/giftCardId/tags
      summary: Retrieve the tags associated to the gift card
      description: Retrieve the tags associated to the gift card
      tags:
      - tags
      parameters:
      - name: giftCardId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The tags associated to the gift card
  /line_item_options/{lineItemOptionId}/tags:
    get:
      operationId: GET/lineItemOptionId/tags
      summary: Retrieve the tags associated to the line item option
      description: Retrieve the tags associated to the line item option
      tags:
      - tags
      parameters:
      - name: lineItemOptionId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The tags associated to the line item option
  /line_items/{lineItemId}/tags:
    get:
      operationId: GET/lineItemId/tags
      summary: Retrieve the tags associated to the line item
      description: Retrieve the tags associated to the line item
      tags:
      - tags
      parameters:
      - name: lineItemId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The tags associated to the line item
  /order_subscriptions/{orderSubscriptionId}/tags:
    get:
      operationId: GET/orderSubscriptionId/tags
      summary: Retrieve the tags associated to the order subscription
      description: Retrieve the tags associated to the order subscription
      tags:
      - tags
      parameters:
      - name: orderSubscriptionId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The tags associated to the order subscription
  /orders/{orderId}/tags:
    get:
      operationId: GET/orderId/tags
      summary: Retrieve the tags associated to the order
      description: Retrieve the tags associated to the order
      tags:
      - tags
      parameters:
      - name: orderId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The tags associated to the order
  /percentage_discount_promotions/{percentageDiscountPromotionId}/tags:
    get:
      operationId: GET/percentageDiscountPromotionId/tags
      summary: Retrieve the tags associated to the percentage discount promotion
      description: Retrieve the tags associated to the percentage discount promotion
      tags:
      - tags
      parameters:
      - name: percentageDiscountPromotionId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The tags associated to the percentage discount promotion
  /promotions/{promotionId}/tags:
    get:
      operationId: GET/promotionId/tags
      summary: Retrieve the tags associated to the promotion
      description: Retrieve the tags associated to the promotion
      tags:
      - tags
      parameters:
      - name: promotionId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The tags associated to the promotion
  /returns/{returnId}/tags:
    get:
      operationId: GET/returnId/tags
      summary: Retrieve the tags associated to the return
      description: Retrieve the tags associated to the return
      tags:
      - tags
      parameters:
      - name: returnId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The tags associated to the return
  /shipments/{shipmentId}/tags:
    get:
      operationId: GET/shipmentId/tags
      summary: Retrieve the tags associated to the shipment
      description: Retrieve the tags associated to the shipment
      tags:
      - tags
      parameters:
      - name: shipmentId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The tags associated to the shipment
  /shipping_methods/{shippingMethodId}/tags:
    get:
      operationId: GET/shippingMethodId/tags
      summary: Retrieve the tags associated to the shipping method
      description: Retrieve the tags associated to the shipping method
      tags:
      - tags
      parameters:
      - name: shippingMethodId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The tags associated to the shipping method
  /sku_options/{skuOptionId}/tags:
    get:
      operationId: GET/skuOptionId/tags
      summary: Retrieve the tags associated to the SKU option
      description: Retrieve the tags associated to the SKU option
      tags:
      - tags
      parameters:
      - name: skuOptionId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The tags associated to the SKU option
  /skus/{skuId}/tags:
    get:
      operationId: GET/skuId/tags
      summary: Retrieve the tags associated to the SKU
      description: Retrieve the tags associated to the SKU
      tags:
      - tags
      parameters:
      - name: skuId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The tags associated to the SKU
  /tags:
    get:
      operationId: GET/tags
      summary: List all tags
      description: List all tags
      tags:
      - tags
      responses:
        '200':
          description: A list of tag objects
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/tagResponseList'
    post:
      operationId: POST/tags
      summary: Create a tag
      description: Create a tag
      tags:
      - tags
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/tagCreate'
      responses:
        '201':
          description: The created tag object
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/tagResponse'
  /tags/{tagId}:
    get:
      operationId: GET/tags/tagId
      summary: Retrieve a tag
      description: Retrieve a tag
      tags:
      - tags
      parameters:
      - name: tagId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The tag object
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/tagResponse'
    patch:
      operationId: PATCH/tags/tagId
      summary: Update a tag
      description: Update a tag
      tags:
      - tags
      parameters:
      - name: tagId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/tagUpdate'
      responses:
        '200':
          description: The updated tag object
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/tagResponse'
    delete:
      operationId: DELETE/tags/tagId
      summary: Delete a tag
      description: Delete a tag
      tags:
      - tags
      parameters:
      - name: tagId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '204':
          description: No content
components:
  schemas:
    tag:
      properties:
        data:
          properties:
            attributes:
              type: object
              properties:
                name:
                  type: string
                  description: The tag name.
                  example: new_campaign
                  nullable: false
                created_at:
                  type: string
                  description: Time at which the resource was created.
                  example: '2018-01-01T12:00:00.000Z'
                  nullable: false
                updated_at:
                  type: string
                  description: Time at which the resource was last updated.
                  example: '2018-01-01T12:00:00.000Z'
                  nullable: false
                reference:
                  type: string
                  description: A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.
                  example: ANY-EXTERNAL-REFEFERNCE
                  nullable: true
                reference_origin:
                  type: string
                  description: Any identifier of the third party system that defines the reference code.
                  example: ANY-EXTERNAL-REFEFERNCE-ORIGIN
                  nullable: true
                metadata:
                  type: object
                  description: Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.
                  example:
                    foo: bar
                  nullable: true
    tagResponseList:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/tagResponse/properties/data'
    tagResponse:
      type: object
      properties:
        data:
          type: object
          properties:
            id:
              type: string
              description: Unique identifier for the resource (hash).
              example: XAyRWNUzyN
            type:
              type: string
              description: The resource's type
              enum:
              - tags
            links:
              type: object
              properties:
                self:
                  type: string
                  description: URL
            attributes:
              $ref: '#/components/schemas/tag/properties/data/properties/attributes'
            relationships:
              type: object
              properties:
                event_stores:
                  type: object
                  properties:
                    links:
                      type: object
                      properties:
                        self:
                          type: string
                          description: URL
                        related:
                          type: string
                          description: URL
                    data:
                      type: object
                      properties:
                        type:
                          type: string
                          description: The resource's type
                          enum:
                          - event_stores
                        id:
                          type: string
                          description: The resource ID
    tagUpdate:
      required:
      - data
      type: object
      properties:
        data:
          type: object
          required:
          - type
          - id
          - attributes
          properties:
            type:
              type: string
              description: The resource's type
              enum:
              - tags
            id:
              type: string
              description: Unique identifier for the resource (hash).
              example: XAyRWNUzyN
            attributes:
              type: object
              properties:
                name:
                  type: string
                  description: The tag name.
                  example: new_campaign
                  nullable: false
                reference:
                  type: string
                  description: A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.
                  example: ANY-EXTERNAL-REFEFERNCE
                  nullable: true
                reference_origin:
                  type: string
                  description: Any identifier of the third party system that defines the reference code.
                  example: ANY-EXTERNAL-REFEFERNCE-ORIGIN
                  nullable: true
                metadata:
                  type: object
                  description: Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.
                  example:
                    foo: bar
                  nullable: true
            relationships:
              type: object
              properties: {}
    tagCreate:
      required:
      - data
      type: object
      properties:
        data:
          type: object
          required:
          - type
          - attributes
          properties:
            type:
              type: string
              description: The resource's type
              enum:
              - tags
            attributes:
              type: object
              properties:
                name:
                  type: string
                  description: The tag name.
                  example: new_campaign
                reference:
                  type: string
                  description: A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.
                  example: ANY-EXTERNAL-REFEFERNCE
                reference_origin:
                  type: string
                  description: Any identifier of the third party system that defines the reference code.
                  example: ANY-EXTERNAL-REFEFERNCE-ORIGIN
                metadata:
                  type: object
                  description: Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.
                  example:
                    foo: bar
              required:
              - name
            relationships:
              type: object
              properties: {}
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT