Square OrderCustomAttributes API

openapi: 3.2.0
info:
  version: '2.0'
  title: Square ApplePay Order Custom Attributes API
  description: 'Supercharge Square for sellers of every size. Our entire connected commerce platform  from elegant hardware to a rich suite of Square APIs  is yours to build with. Whether youre developing an app or composing a bespoke solution, this is the place to make it happen. '
  termsOfService: https://connect.squareup.com/tos
  contact:
    name: Square Developer Platform
    email: developers@squareup.com
    url: https://squareup.com/developers
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  externalDocs:
    description: 'Read the official documentation here:'
    url: https://docs.connect.squareup.com/
  x-server-configuration:
    default-environment: production
    default-server: default
    environments:
    - name: production
      servers:
      - name: default
        url: https://connect.squareup.com
    - name: sandbox
      servers:
      - name: default
        url: https://connect.squareupsandbox.com
    - name: custom
      servers:
      - name: default
        url: '{custom_url}'
    parameters:
    - name: custom_url
      description: Sets the base URL requests are made to. Defaults to `https://connect.squareup.com`
      type: string
      example: https://connect.squareup.com
  x-square-generic-error-codes:
  - ACCESS_TOKEN_EXPIRED
  - ACCESS_TOKEN_REVOKED
  - API_VERSION_INCOMPATIBLE
  - APPLICATION_DISABLED
  - ARRAY_EMPTY
  - ARRAY_LENGTH_TOO_LONG
  - ARRAY_LENGTH_TOO_SHORT
  - BAD_CERTIFICATE
  - BAD_GATEWAY
  - BAD_REQUEST
  - CONFLICT
  - CONFLICTING_PARAMETERS
  - CURRENCY_MISMATCH
  - EXPECTED_ARRAY
  - EXPECTED_BASE64_ENCODED_BYTE_ARRAY
  - EXPECTED_BOOLEAN
  - EXPECTED_FLOAT
  - EXPECTED_INTEGER
  - EXPECTED_JSON_BODY
  - EXPECTED_MAP
  - EXPECTED_OBJECT
  - EXPECTED_STRING
  - FORBIDDEN
  - GATEWAY_TIMEOUT
  - GONE
  - IDEMPOTENCY_KEY_REUSED
  - INCORRECT_TYPE
  - INSUFFICIENT_SCOPES
  - INTERNAL_SERVER_ERROR
  - INVALID_ARRAY_VALUE
  - INVALID_CONTENT_TYPE
  - INVALID_CURSOR
  - INVALID_ENUM_VALUE
  - INVALID_FORM_VALUE
  - INVALID_SORT_ORDER
  - INVALID_SQUARE_VERSION_FORMAT
  - INVALID_TIME
  - INVALID_TIME_RANGE
  - INVALID_VALUE
  - LOCATION_MISMATCH
  - MAP_KEY_LENGTH_TOO_LONG
  - MAP_KEY_LENGTH_TOO_SHORT
  - MERCHANT_SUBSCRIPTION_NOT_FOUND
  - METHOD_NOT_ALLOWED
  - MISSING_REQUIRED_PARAMETER
  - NOT_ACCEPTABLE
  - NOT_FOUND
  - NOT_IMPLEMENTED
  - NO_FIELDS_SET
  - RATE_LIMITED
  - REQUEST_ENTITY_TOO_LARGE
  - REQUEST_TIMEOUT
  - SANDBOX_NOT_SUPPORTED
  - SERVICE_UNAVAILABLE
  - TOO_MANY_MAP_ENTRIES
  - UNAUTHORIZED
  - UNEXPECTED_VALUE
  - UNKNOWN_BODY_PARAMETER
  - UNKNOWN_QUERY_PARAMETER
  - UNPROCESSABLE_ENTITY
  - UNSUPPORTED_MEDIA_TYPE
  - V1_ACCESS_TOKEN
  - V1_APPLICATION
  - VALUE_EMPTY
  - VALUE_REGEX_MISMATCH
  - VALUE_TOO_HIGH
  - VALUE_TOO_LONG
  - VALUE_TOO_LOW
  - VALUE_TOO_SHORT
servers:
- url: https://connect.squareup.com
  variables: {}
tags:
- name: OrderCustomAttributes
paths:
  /v2/orders/custom-attribute-definitions:
    get:
      tags:
      - OrderCustomAttributes
      summary: Square List Order Custom Attribute Definitions
      operationId: ListOrderCustomAttributeDefinitions
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: 'Lists the order-related [custom attribute definitions](entity:CustomAttributeDefinition) that belong to a Square seller account.


        When all response pages are retrieved, the results include all custom attribute definitions

        that are visible to the requesting application, including those that are created by other

        applications and set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. Note that

        seller-defined custom attributes (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.'
      x-release-status: BETA
      security:
      - oauth2:
        - ORDERS_READ
      parameters:
      - name: visibility_filter
        description: Requests that all of the custom attributes be returned, or only those that are read-only or read-write.
        schema:
          $ref: '#/components/schemas/VisibilityFilter'
        in: query
        required: false
      - name: cursor
        description: "The cursor returned in the paged response from the previous call to this endpoint. \nProvide this cursor to retrieve the next page of results for your original request. \nFor more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination)."
        schema:
          type: string
        in: query
        required: false
      - name: limit
        description: "The maximum number of results to return in a single paged response. This limit is advisory. \nThe response might contain more or fewer results. The minimum value is 1 and the maximum value is 100. \nThe default value is 20.\nFor more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination)."
        schema:
          type: integer
        in: query
        required: false
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListOrderCustomAttributeDefinitionsResponse'
    post:
      tags:
      - OrderCustomAttributes
      summary: Square Create Order Custom Attribute Definition
      operationId: CreateOrderCustomAttributeDefinition
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: 'Creates an order-related custom attribute definition.  Use this endpoint to

        define a custom attribute that can be associated with orders.


        After creating a custom attribute definition, you can set the custom attribute for orders

        in the Square seller account.'
      x-release-status: BETA
      security:
      - oauth2:
        - ORDERS_WRITE
      parameters: []
      requestBody:
        required: true
        description: 'An object containing the fields to POST for the request.


          See the corresponding object definition for field details.'
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateOrderCustomAttributeDefinitionRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateOrderCustomAttributeDefinitionResponse'
  /v2/orders/custom-attribute-definitions/{key}:
    delete:
      tags:
      - OrderCustomAttributes
      summary: Square Delete Order Custom Attribute Definition
      operationId: DeleteOrderCustomAttributeDefinition
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: 'Deletes an order-related [custom attribute definition](entity:CustomAttributeDefinition) from a Square seller account.


        Only the definition owner can delete a custom attribute definition.'
      x-release-status: BETA
      security:
      - oauth2:
        - ORDERS_WRITE
      parameters:
      - name: key
        description: The key of the custom attribute definition to delete.
        schema:
          type: string
        in: path
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteOrderCustomAttributeDefinitionResponse'
    get:
      tags:
      - OrderCustomAttributes
      summary: Square Retrieve Order Custom Attribute Definition
      operationId: RetrieveOrderCustomAttributeDefinition
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: 'Retrieves an order-related [custom attribute definition](entity:CustomAttributeDefinition) from a Square seller account.


        To retrieve a custom attribute definition created by another application, the `visibility`

        setting must be `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes

        (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.'
      x-release-status: BETA
      security:
      - oauth2:
        - ORDERS_READ
      parameters:
      - name: key
        description: The key of the custom attribute definition to retrieve.
        schema:
          type: string
        in: path
        required: true
      - name: version
        description: 'To enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency)

          control, include this optional field and specify the current version of the custom attribute.'
        schema:
          type: integer
        in: query
        required: false
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrieveOrderCustomAttributeDefinitionResponse'
    put:
      tags:
      - OrderCustomAttributes
      summary: Square Update Order Custom Attribute Definition
      operationId: UpdateOrderCustomAttributeDefinition
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: 'Updates an order-related custom attribute definition for a Square seller account.


        Only the definition owner can update a custom attribute definition. Note that sellers can view all custom attributes in exported customer data, including those set to `VISIBILITY_HIDDEN`.'
      x-release-status: BETA
      security:
      - oauth2:
        - ORDERS_WRITE
      parameters:
      - name: key
        description: The key of the custom attribute definition to update.
        schema:
          type: string
        in: path
        required: true
      requestBody:
        required: true
        description: 'An object containing the fields to POST for the request.


          See the corresponding object definition for field details.'
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateOrderCustomAttributeDefinitionRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateOrderCustomAttributeDefinitionResponse'
  /v2/orders/custom-attributes/bulk-delete:
    post:
      tags:
      - OrderCustomAttributes
      summary: Square Bulk Delete Order Custom Attributes
      operationId: BulkDeleteOrderCustomAttributes
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: 'Deletes order [custom attributes](entity:CustomAttribute) as a bulk operation.


        Use this endpoint to delete one or more custom attributes from one or more orders.

        A custom attribute is based on a custom attribute definition in a Square seller account.  (To create a

        custom attribute definition, use the [CreateOrderCustomAttributeDefinition](api-endpoint:OrderCustomAttributes-CreateOrderCustomAttributeDefinition) endpoint.)


        This `BulkDeleteOrderCustomAttributes` endpoint accepts a map of 1 to 25 individual delete

        requests and returns a map of individual delete responses. Each delete request has a unique ID

        and provides an order ID and custom attribute. Each delete response is returned with the ID

        of the corresponding request.


        To delete a custom attribute owned by another application, the `visibility` setting

        must be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes

        (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.'
      x-release-status: BETA
      security:
      - oauth2:
        - ORDERS_WRITE
      parameters: []
      requestBody:
        required: true
        description: 'An object containing the fields to POST for the request.


          See the corresponding object definition for field details.'
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkDeleteOrderCustomAttributesRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkDeleteOrderCustomAttributesResponse'
  /v2/orders/custom-attributes/bulk-upsert:
    post:
      tags:
      - OrderCustomAttributes
      summary: Square Bulk Upsert Order Custom Attributes
      operationId: BulkUpsertOrderCustomAttributes
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: 'Creates or updates order [custom attributes](entity:CustomAttribute) as a bulk operation.


        Use this endpoint to delete one or more custom attributes from one or more orders.

        A custom attribute is based on a custom attribute definition in a Square seller account.  (To create a

        custom attribute definition, use the [CreateOrderCustomAttributeDefinition](api-endpoint:OrderCustomAttributes-CreateOrderCustomAttributeDefinition) endpoint.)


        This `BulkUpsertOrderCustomAttributes` endpoint accepts a map of 1 to 25 individual upsert

        requests and returns a map of individual upsert responses. Each upsert request has a unique ID

        and provides an order ID and custom attribute. Each upsert response is returned with the ID

        of the corresponding request.


        To create or update a custom attribute owned by another application, the `visibility` setting

        must be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes

        (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.'
      x-release-status: BETA
      security:
      - oauth2:
        - ORDERS_WRITE
      parameters: []
      requestBody:
        required: true
        description: 'An object containing the fields to POST for the request.


          See the corresponding object definition for field details.'
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkUpsertOrderCustomAttributesRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkUpsertOrderCustomAttributesResponse'
  /v2/orders/{order_id}/custom-attributes:
    get:
      tags:
      - OrderCustomAttributes
      summary: Square List Order Custom Attributes
      operationId: ListOrderCustomAttributes
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: 'Lists the [custom attributes](entity:CustomAttribute) associated with an order.


        You can use the `with_definitions` query parameter to also retrieve custom attribute definitions

        in the same call.


        When all response pages are retrieved, the results include all custom attributes that are

        visible to the requesting application, including those that are owned by other applications

        and set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.'
      x-release-status: BETA
      security:
      - oauth2:
        - ORDERS_READ
      parameters:
      - name: order_id
        description: The ID of the target [order](entity:Order).
        schema:
          type: string
        in: path
        required: true
      - name: visibility_filter
        description: Requests that all of the custom attributes be returned, or only those that are read-only or read-write.
        schema:
          $ref: '#/components/schemas/VisibilityFilter'
        in: query
        required: false
      - name: cursor
        description: "The cursor returned in the paged response from the previous call to this endpoint. \nProvide this cursor to retrieve the next page of results for your original request. \nFor more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination)."
        schema:
          type: string
        in: query
        required: false
      - name: limit
        description: "The maximum number of results to return in a single paged response. This limit is advisory. \nThe response might contain more or fewer results. The minimum value is 1 and the maximum value is 100. \nThe default value is 20.\nFor more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination)."
        schema:
          type: integer
        in: query
        required: false
      - name: with_definitions
        description: "Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of each\ncustom attribute. Set this parameter to `true` to get the name and description of each custom attribute, \ninformation about the data type, or other definition details. The default value is `false`."
        schema:
          type: boolean
          default: false
        in: query
        required: false
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListOrderCustomAttributesResponse'
  /v2/orders/{order_id}/custom-attributes/{custom_attribute_key}:
    delete:
      tags:
      - OrderCustomAttributes
      summary: Square Delete Order Custom Attribute
      operationId: DeleteOrderCustomAttribute
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: 'Deletes a [custom attribute](entity:CustomAttribute) associated with a customer profile.


        To delete a custom attribute owned by another application, the `visibility` setting must be

        `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes

        (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.'
      x-release-status: BETA
      security:
      - oauth2:
        - ORDERS_WRITE
      parameters:
      - name: order_id
        description: The ID of the target [order](entity:Order).
        schema:
          type: string
        in: path
        required: true
      - name: custom_attribute_key
        description: 'The key of the custom attribute to delete.  This key must match the key of an

          existing custom attribute definition.'
        schema:
          type: string
        in: path
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteOrderCustomAttributeResponse'
    get:
      tags:
      - OrderCustomAttributes
      summary: Square Retrieve Order Custom Attribute
      operationId: RetrieveOrderCustomAttribute
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: 'Retrieves a [custom attribute](entity:CustomAttribute) associated with an order.


        You can use the `with_definition` query parameter to also retrieve the custom attribute definition

        in the same call.


        To retrieve a custom attribute owned by another application, the `visibility` setting must be

        `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes

        also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.'
      x-release-status: BETA
      security:
      - oauth2:
        - ORDERS_READ
      parameters:
      - name: order_id
        description: The ID of the target [order](entity:Order).
        schema:
          type: string
        in: path
        required: true
      - name: custom_attribute_key
        description: 'The key of the custom attribute to retrieve.  This key must match the key of an

          existing custom attribute definition.'
        schema:
          type: string
        in: path
        required: true
      - name: version
        description: 'To enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency)

          control, include this optional field and specify the current version of the custom attribute.'
        schema:
          type: integer
        in: query
        required: false
      - name: with_definition
        description: "Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of each \ncustom attribute. Set this parameter to `true` to get the name and description of each custom attribute, \ninformation about the data type, or other definition details. The default value is `false`."
        schema:
          type: boolean
          default: false
        in: query
        required: false
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrieveOrderCustomAttributeResponse'
    post:
      tags:
      - OrderCustomAttributes
      summary: Square Upsert Order Custom Attribute
      operationId: UpsertOrderCustomAttribute
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: 'Creates or updates a [custom attribute](entity:CustomAttribute) for an order.


        Use this endpoint to set the value of a custom attribute for a specific order.

        A custom attribute is based on a custom attribute definition in a Square seller account. (To create a

        custom attribute definition, use the [CreateOrderCustomAttributeDefinition](api-endpoint:OrderCustomAttributes-CreateOrderCustomAttributeDefinition) endpoint.)


        To create or update a custom attribute owned by another application, the `visibility` setting

        must be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes

        (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.'
      x-release-status: BETA
      security:
      - oauth2:
        - ORDERS_WRITE
      parameters:
      - name: order_id
        description: The ID of the target [order](entity:Order).
        schema:
          type: string
        in: path
        required: true
      - name: custom_attribute_key
        description: "The key of the custom attribute to create or update.  This key must match the key \nof an existing custom attribute definition."
        schema:
          type: string
        in: path
        required: true
      requestBody:
        required: true
        description: 'An object containing the fields to POST for the request.


          See the corresponding object definition for field details.'
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpsertOrderCustomAttributeRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpsertOrderCustomAttributeResponse'
components:
  schemas:
    CustomAttributeDefinition:
      type: object
      description: 'Represents a definition for custom attribute values. A custom attribute definition

        specifies the key, visibility, schema, and other properties for a custom attribute.'
      x-release-status: PUBLIC
      properties:
        key:
          type:
          - string
          - 'null'
          description: 'The identifier

            of the custom attribute definition and its corresponding custom attributes. This value

            can be a simple key, which is the key that is provided when the custom attribute definition

            is created, or a qualified key, if the requesting

            application is not the definition owner. The qualified key consists of the application ID

            of the custom attribute definition owner

            followed by the simple key that was provided when the definition was created. It has the

            format application_id:simple key.


            The value for a simple key can contain up to 60 alphanumeric characters, periods (.),

            underscores (_), and hyphens (-).


            This field can not be changed

            after the custom attribute definition is created. This field is required when creating

            a definition and must be unique per application, seller, and resource type.'
          minLength: 1
          pattern: ^([a-zA-Z0-9\._-]+:)?[a-zA-Z0-9\._-]{1,60}$
        schema:
          type:
          - object
          - 'null'
          description: 'The JSON schema for the custom attribute definition, which determines the data type of the corresponding custom attributes. For more information,

            see [Custom Attributes Overview](https://developer.squareup.com/docs/devtools/customattributes/overview). This field is required when creating a definition.'
        name:
          type:
          - string
          - 'null'
          description: 'The name of the custom attribute definition for API and seller-facing UI purposes. The name must

            be unique within the seller and application pair. This field is required if the

            `visibility` field is `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.'
          maxLength: 255
        description:
          type:
          - string
          - 'null'
          description: 'Seller-oriented description of the custom attribute definition, including any constraints

            that the seller should observe. May be displayed as a tooltip in Square UIs. This field is

            required if the `visibility` field is `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.'
          maxLength: 255
        visibility:
          $ref: '#/components/schemas/CustomAttributeDefinitionVisibility'
          description: 'Specifies how the custom attribute definition and its values should be shared with

            the seller and other applications. If no value is specified, the value defaults to `VISIBILITY_HIDDEN`.

            See [Visibility](#type-visibility) for possible values'
        version:
          type: integer
          description: 'Read only. The current version of the custom attribute definition.

            The value is incremented each time the custom attribute definition is updated.

            When updating a custom attribute definition, you can provide this field

            and specify the current version of the custom attribute definition to enable

            [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency).


            On writes, this field must be set to the latest version. Stale writes are rejected.


            This field can also be used to enforce strong consistency for reads. For more information about strong consistency for reads,

            see [Custom Attributes Overview](https://developer.squareup.com/docs/devtools/customattributes/overview).'
        updated_at:
          type: string
          description: 'The timestamp that indicates when the custom attribute definition was created or most recently updated,

            in RFC 3339 format.'
          readOnly: true
        created_at:
          type: string
          description: The timestamp that indicates when the custom attribute definition was created, in RFC 3339 format.
          readOnly: true
    ListOrderCustomAttributeDefinitionsResponse:
      type: object
      description: Represents a response from listing order custom attribute definitions.
      x-release-status: BETA
      required:
      - custom_attribute_definitions
      properties:
        custom_attribute_definitions:
          type: array
          items:
            $ref: '#/components/schemas/CustomAttributeDefinition'
          description: The retrieved custom attribute definitions. If no custom attribute definitions are found, Square returns an empty object (`{}`).
        cursor:
          type: string
          description: "The cursor to provide in your next call to this endpoint to retrieve the next page of results for your original request. \nThis field is present only if the request succeeded and additional results are available.\nFor more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination)."
          minLength: 1
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
          description: Any errors that occurred during the request.
      example:
        custom_attribute_definitions:
        - created_at: '2022-11-16T18:03:44.051Z'
          description: The number of people seated at a table
          key: cover-count
          name: Cover count
          schema:
            $ref: https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.Number
          updated_at: '2022-11-16T18:03:44.051Z'
          version: 1
          visibility: VISIBILITY_READ_WRITE_VALUES
        - created_at: '2022-11-16T18:04:32.059Z'
          description: The identifier for a particular seat
          key: seat-number
          name: Seat number
          schema:
            $ref: https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.Number
          updated_at: '2022-11-16T18:04:32.059Z'
          version: 1
          visibility: VISIBILITY_READ_WRITE_VALUES
        - created_at: '2022-11-16T18:04:21.912Z'
          description: The identifier for a particular table
          key: table-number
          name: Table number
          schema:
            $ref: https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.Number
          updated_at: '2022-11-16T18:04:21.912Z'
          version: 1
          visibility: VISIBILITY_READ_WRITE_VALUES
    CustomAttribute:
      type: object
      description: 'A custom attribute value. Each custom attribute value has a corresponding

        `CustomAttributeDefinition` object.'
      x-release-status: PUBLIC
      properties:
        key:
          type:
          - string
          - 'null'
          description: 'The identifier

            of the custom attribute definition and its corresponding custom attributes. This value

            can be a simple key, which is the key that is provided when the custom attribute definition

            is created, or a qualified key, if the requesting

            application is not the definition owner. The qualified key consists of the application ID

            of the custom attribute definition owner

            followed by the simple key that was provided when the definition was created. It has the

            format application_id:simple key.


            The value for a simple key can contain up to 60 alphanumeric characters, periods (.),

            underscores (_), and hyphens (-).'
          minLength: 1
          pattern: ^([a-zA-Z0-9\._-]+:)?[a-zA-Z0-9\._-]{1,60}$
        value:
          description: 'The value assigned to the custom attribute. It is validated against the custom

            attribute definition''s schema on write operations. For more information about custom

            attribute values,

            see [Custom Attributes Overview](https://developer.squareup.com/docs/devtools/customattributes/overview).'
        version:
          type: integer
          description: 'Read only. The current version of the custom attribute. This field is incremented when the custom attribute is changed.

            When updating an existing custom attribute value, you can provide this field

            and specify the current version of the custom attribute to enable

            [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency).

            This field can also be used to enforce strong consistency for reads. For more information about strong consistency for reads,

            see [Custom Attributes Overview](https://developer.squareup.com/docs/devtools/customattributes/overview).'
        visibility:
          $ref: '#/components/schemas/CustomAttributeDefinitionVisibility'
          description: 'A copy of the `visibility` field value for the associated custom attribute definition.

            See [CustomAttributeDefinitionVisibility](#type-customattributedefinitionvisibility) for possible value

# --- truncated at 32 KB (96 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/square/refs/heads/main/openapi/square-ordercustomattributes-api-openapi.yml