Medusa Property Labels API

openapi: 3.2.0
info:
  version: 2.19.0
  title: Medusa Admin Property Labels API
  license:
    name: MIT
    url: https://github.com/medusajs/medusa/blob/develop/LICENSE
servers:
- url: http://localhost:9000
- url: https://api.medusajs.com
tags:
- name: Property Labels
  x-associatedSchema:
    $ref: '#/components/schemas/AdminPropertyLabel'
paths:
  /admin/property-labels:
    get:
      operationId: GetPropertyLabels
      summary: List Property Labels
      description: Retrieve a list of property labels. The property labels can be filtered by fields such as `id`. The property labels can also be sorted or paginated.
      x-authenticated: true
      parameters:
      - name: entity
        in: query
        description: The property label's entity.
        required: false
        schema:
          type: string
          title: entity
          description: The property label's entity.
      - name: property
        in: query
        description: The property label's property.
        required: false
        schema:
          type: string
          title: property
          description: The property label's property.
      - name: q
        in: query
        description: The property label's q.
        required: false
        schema:
          type: string
          title: q
          description: The property label's q.
      - name: limit
        in: query
        description: Limit the number of items returned in the list.
        required: false
        schema:
          type: number
          title: limit
          description: Limit the number of items returned in the list.
          externalDocs:
            url: '#pagination'
      - name: offset
        in: query
        description: The number of items to skip when retrieving a list.
        required: false
        schema:
          type: number
          title: offset
          description: The number of items to skip when retrieving a list.
          externalDocs:
            url: '#pagination'
      - name: order
        in: query
        description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.
        required: false
        schema:
          type: string
          title: order
          description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.
          externalDocs:
            url: '#pagination'
      - name: with_deleted
        in: query
        description: The property label's with deleted.
        required: false
        schema:
          type: boolean
          title: with_deleted
          description: The property label's with deleted.
      - name: fields
        in: query
        description: Comma-separated fields that should be included in the returned data. If a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. Without prefix it will replace the entire default fields.
        required: false
        schema:
          type: string
          title: fields
          description: Comma-separated fields that should be included in the returned data. If a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. Without prefix it will replace the entire default fields.
          externalDocs:
            url: '#select-fields-and-relations'
      security:
      - api_token: []
      - cookie_auth: []
      - jwt_token: []
      x-codeSamples:
      - lang: Shell
        label: cURL
        source: 'curl ''{backend_url}/admin/property-labels'' \

          -H ''Authorization: Bearer {access_token}'''
      tags:
      - Property Labels
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdminPropertyLabelListResponse'
        '400':
          $ref: '#/components/responses/400_error'
        '401':
          $ref: '#/components/responses/unauthorized'
        '404':
          $ref: '#/components/responses/not_found_error'
        '409':
          $ref: '#/components/responses/invalid_state_error'
        '422':
          $ref: '#/components/responses/invalid_request_error'
        '500':
          $ref: '#/components/responses/500_error'
      x-since: 2.10.3
      x-featureFlag: view_configurations
    post:
      operationId: PostPropertyLabels
      summary: Create Property Label
      description: Create a property label.
      x-authenticated: true
      security:
      - api_token: []
      - cookie_auth: []
      - jwt_token: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AdminCreatePropertyLabel'
      x-codeSamples:
      - lang: Shell
        label: cURL
        source: "curl -X POST '{backend_url}/admin/property-labels' \\\n-H 'Authorization: Bearer {access_token}' \\\n-H 'Content-Type: application/json' \\\n--data-raw '{\n  \"entity\": \"{value}\",\n  \"property\": \"{value}\",\n  \"label\": \"{value}\"\n}'"
      tags:
      - Property Labels
      responses:
        '201':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdminPropertyLabelResponse'
        '400':
          $ref: '#/components/responses/400_error'
        '401':
          $ref: '#/components/responses/unauthorized'
        '404':
          $ref: '#/components/responses/not_found_error'
        '409':
          $ref: '#/components/responses/invalid_state_error'
        '422':
          $ref: '#/components/responses/invalid_request_error'
        '500':
          $ref: '#/components/responses/500_error'
      x-workflow: createPropertyLabelsWorkflow
      x-events: []
      x-since: 2.10.3
      x-featureFlag: view_configurations
  /admin/property-labels/batch:
    post:
      operationId: PostPropertyLabelsBatch
      summary: Create Property Label
      description: Create a property label.
      x-authenticated: true
      security:
      - api_token: []
      - cookie_auth: []
      - jwt_token: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AdminBatchPropertyLabels'
      x-codeSamples:
      - lang: Shell
        label: cURL
        source: 'curl -X POST ''{backend_url}/admin/property-labels/batch'' \

          -H ''Authorization: Bearer {access_token}'''
      tags:
      - Property Labels
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdminBatchPropertyLabelResponse'
        '400':
          $ref: '#/components/responses/400_error'
        '401':
          $ref: '#/components/responses/unauthorized'
        '404':
          $ref: '#/components/responses/not_found_error'
        '409':
          $ref: '#/components/responses/invalid_state_error'
        '422':
          $ref: '#/components/responses/invalid_request_error'
        '500':
          $ref: '#/components/responses/500_error'
      x-workflow: batchPropertyLabelsWorkflow
      x-events: []
      x-since: 2.10.3
      x-featureFlag: view_configurations
  /admin/property-labels/{id}:
    get:
      operationId: GetPropertyLabelsId
      summary: Get a Property Label
      description: Retrieve a property label by its ID.
      x-authenticated: true
      parameters:
      - name: id
        in: path
        description: The property label's ID.
        required: true
        schema:
          type: string
      security:
      - api_token: []
      - cookie_auth: []
      - jwt_token: []
      x-codeSamples:
      - lang: Shell
        label: cURL
        source: 'curl ''{backend_url}/admin/property-labels/{id}'' \

          -H ''Authorization: Bearer {access_token}'''
      tags:
      - Property Labels
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdminPropertyLabelResponse'
        '400':
          $ref: '#/components/responses/400_error'
        '401':
          $ref: '#/components/responses/unauthorized'
        '404':
          $ref: '#/components/responses/not_found_error'
        '409':
          $ref: '#/components/responses/invalid_state_error'
        '422':
          $ref: '#/components/responses/invalid_request_error'
        '500':
          $ref: '#/components/responses/500_error'
      x-since: 2.10.3
      x-featureFlag: view_configurations
    post:
      operationId: PostPropertyLabelsId
      summary: Update a Property Label
      description: Update a property label's details.
      x-authenticated: true
      parameters:
      - name: id
        in: path
        description: The property label's ID.
        required: true
        schema:
          type: string
      security:
      - api_token: []
      - cookie_auth: []
      - jwt_token: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AdminUpdatePropertyLabel'
      x-codeSamples:
      - lang: Shell
        label: cURL
        source: 'curl -X POST ''{backend_url}/admin/property-labels/{id}'' \

          -H ''Authorization: Bearer {access_token}'''
      tags:
      - Property Labels
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdminPropertyLabelResponse'
        '400':
          $ref: '#/components/responses/400_error'
        '401':
          $ref: '#/components/responses/unauthorized'
        '404':
          $ref: '#/components/responses/not_found_error'
        '409':
          $ref: '#/components/responses/invalid_state_error'
        '422':
          $ref: '#/components/responses/invalid_request_error'
        '500':
          $ref: '#/components/responses/500_error'
      x-workflow: updatePropertyLabelsWorkflow
      x-events: []
      x-since: 2.10.3
      x-featureFlag: view_configurations
    delete:
      operationId: DeletePropertyLabelsId
      summary: Delete a Property Label
      description: Delete a property label.
      x-authenticated: true
      parameters:
      - name: id
        in: path
        description: The property label's ID.
        required: true
        schema:
          type: string
      security:
      - api_token: []
      - cookie_auth: []
      - jwt_token: []
      x-codeSamples:
      - lang: Shell
        label: cURL
        source: 'curl -X DELETE ''{backend_url}/admin/property-labels/{id}'' \

          -H ''Authorization: Bearer {access_token}'''
      tags:
      - Property Labels
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdminPropertyLabelDeleteResponse'
        '400':
          $ref: '#/components/responses/400_error'
        '401':
          $ref: '#/components/responses/unauthorized'
        '404':
          $ref: '#/components/responses/not_found_error'
        '409':
          $ref: '#/components/responses/invalid_state_error'
        '422':
          $ref: '#/components/responses/invalid_request_error'
        '500':
          $ref: '#/components/responses/500_error'
      x-workflow: deletePropertyLabelsWorkflow
      x-events: []
      x-since: 2.10.3
      x-featureFlag: view_configurations
components:
  schemas:
    AdminCreatePropertyLabel:
      type: object
      description: The details of a property label to create.
      x-schemaName: AdminCreatePropertyLabel
      required:
      - entity
      - property
      - label
      properties:
        entity:
          type: string
          title: entity
          description: The name of the entity the property label belongs to.
        property:
          type: string
          title: property
          description: The property the label is for.
        label:
          type: string
          title: label
          description: The label to use for the property.
        description:
          type: string
          title: description
          description: The description of the property label.
    AdminPropertyLabelResponse:
      type: object
      description: The details of a property label.
      x-schemaName: AdminPropertyLabelResponse
      required:
      - property_label
      properties:
        property_label:
          $ref: '#/components/schemas/AdminPropertyLabel'
    AdminPropertyLabel:
      type: object
      description: The property label's details.
      x-schemaName: AdminPropertyLabel
      required:
      - id
      - entity
      - property
      - label
      - created_at
      - updated_at
      properties:
        id:
          type: string
          title: id
          description: The property label's ID.
        entity:
          type: string
          title: entity
          description: The entity the property label belongs to.
        property:
          type: string
          title: property
          description: The property the label is associated with.
        label:
          type: string
          title: label
          description: The label for the property.
        description:
          type: string
          title: description
          description: The property label's description.
        created_at:
          type: string
          format: date-time
          title: created_at
          description: The date the property label was created.
        updated_at:
          type: string
          format: date-time
          title: updated_at
          description: The date the property label was last updated.
    Error:
      title: Response Error
      type: object
      properties:
        code:
          type: string
          description: A slug code to indicate the type of the error.
          enum:
          - invalid_state_error
          - invalid_request_error
          - api_error
          - unknown_error
        message:
          type: string
          description: Description of the error that occurred.
          example: first_name must be a string
        type:
          type: string
          description: A slug indicating the type of the error.
          enum:
          - QueryRunnerAlreadyReleasedError
          - TransactionAlreadyStartedError
          - TransactionNotStartedError
          - conflict
          - unauthorized
          - payment_authorization_error
          - duplicate_error
          - not_allowed
          - invalid_data
          - not_found
          - database_error
          - unexpected_state
          - invalid_argument
          - unknown_error
    AdminBatchPropertyLabelResponse:
      type: object
      description: The response of managing property labels.
      x-schemaName: AdminBatchPropertyLabelResponse
      required:
      - created
      - updated
      - deleted
      properties:
        created:
          type: array
          description: The created property labels.
          items:
            $ref: '#/components/schemas/AdminPropertyLabel'
        updated:
          type: array
          description: The updated property labels.
          items:
            $ref: '#/components/schemas/AdminPropertyLabel'
        deleted:
          type: array
          description: The deleted property labels.
          items:
            type: object
            description: Details of a deleted property label.
            required:
            - id
            - object
            - deleted
            properties:
              id:
                type: string
                title: id
                description: The ID of the deleted property label.
              object:
                type: string
                title: object
                description: The type of the deleted object.
              deleted:
                type: boolean
                title: deleted
                description: Indicates if the property label was deleted.
    AdminPropertyLabelDeleteResponse:
      type: object
      description: The details of deleting a property label.
      x-schemaName: AdminPropertyLabelDeleteResponse
      required:
      - id
      - object
      - deleted
      properties:
        id:
          type: string
          title: id
          description: The ID of the deleted property label.
        object:
          type: string
          title: object
          description: The type of the deleted object, which is `property_label`.
        deleted:
          type: boolean
          title: deleted
          description: Whether the property label was successfully deleted.
    AdminPropertyLabelListResponse:
      type: object
      description: The paginated list of property labels.
      x-schemaName: AdminPropertyLabelListResponse
      required:
      - property_labels
      - count
      - offset
      - limit
      properties:
        property_labels:
          type: array
          description: TThe list of property labels.
          items:
            $ref: '#/components/schemas/AdminPropertyLabel'
        count:
          type: number
          title: count
          description: The total number of property labels.
        offset:
          type: number
          title: offset
          description: The number of items skipped before retrieving the returned items.
        limit:
          type: number
          title: limit
          description: The maximum number of items returned.
    AdminUpdatePropertyLabel:
      type: object
      description: The details to update in a property label.
      x-schemaName: AdminUpdatePropertyLabel
      properties:
        label:
          type: string
          title: label
          description: The label of the property.
        description:
          type: string
          title: description
          description: The property label's description.
    AdminBatchPropertyLabels:
      type: object
      description: The property labels to manage.
      x-schemaName: AdminBatchPropertyLabels
      properties:
        create:
          type: array
          description: The property labels to create.
          items:
            type: object
            description: The details of a property label to create.
            required:
            - entity
            - property
            - label
            properties:
              entity:
                type: string
                title: entity
                description: The name of the entity the property label belongs to.
              property:
                type: string
                title: property
                description: The property the label is for.
              label:
                type: string
                title: label
                description: The label to use for the property.
              description:
                type: string
                title: description
                description: The description of the property label.
        update:
          type: array
          description: The property labels to update.
          items:
            type: object
            description: The details of a property label to update.
            required:
            - id
            properties:
              id:
                type: string
                title: id
                description: The ID of the property label to update.
              label:
                type: string
                title: label
                description: The updated label of the property label.
              description:
                type: string
                title: description
                description: The updated description of the property label.
        delete:
          type: array
          description: The property labels to delete.
          items:
            type: string
            title: delete
            description: The ID of the property label to delete.
  responses:
    invalid_request_error:
      description: Invalid Request Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            code: invalid_request_error
            message: Discount with code TEST already exists.
            type: duplicate_error
    invalid_state_error:
      description: Invalid State Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            code: unknown_error
            message: The request conflicted with another request. You may retry the request with the provided Idempotency-Key.
            type: QueryRunnerAlreadyReleasedError
    500_error:
      description: Server Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            database:
              $ref: '#/components/examples/database_error'
            unexpected_state:
              $ref: '#/components/examples/unexpected_state_error'
            invalid_argument:
              $ref: '#/components/examples/invalid_argument_error'
            default_error:
              $ref: '#/components/examples/default_error'
    400_error:
      description: Client Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            not_allowed:
              $ref: '#/components/examples/not_allowed_error'
            invalid_data:
              $ref: '#/components/examples/invalid_data_error'
    unauthorized:
      description: User is not authorized. Must log in first
      content:
        text/plain:
          schema:
            type: string
            default: Unauthorized
            example: Unauthorized
    not_found_error:
      description: Not Found Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            message: Entity with id 1 was not found
            type: not_found
  examples:
    unexpected_state_error:
      summary: Unexpected State Error
      value:
        message: cart.total must be defined
        type: unexpected_state
    database_error:
      summary: Database Error
      value:
        code: api_error
        message: An error occured while hashing password
        type: database_error
    default_error:
      summary: Default Error
      value:
        code: unknown_error
        message: An unknown error occurred.
        type: unknown_error
    invalid_argument_error:
      summary: Invalid Argument Error
      value:
        message: cart.total must be defined
        type: unexpected_state
    not_allowed_error:
      summary: Not Allowed Error
      value:
        message: Discount must be set to dynamic
        type: not_allowed
    invalid_data_error:
      summary: Invalid Data Error
      value:
        message: first_name must be a string
        type: invalid_data
  securitySchemes:
    api_token:
      type: http
      x-displayName: API Token
      scheme: basic
    jwt_token:
      type: http
      x-displayName: JWT Token
      scheme: bearer
    cookie_auth:
      type: apiKey
      in: cookie
      name: connect.sid
      x-displayName: Cookie Session ID
    reset_password:
      type: http
      x-displayName: Reset Password Token
      scheme: bearer
      x-is-auth: false