<- Order Custom Attributes API

Order Custom Attributes API

Create order custom attribute definitionBeta

POST

 /v2/orders/custom-attribute-definitions

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.

Permissions:ORDERS_WRITE

Guide

Create an order custom attribute definition

Try in API Explorer
Link to section

Request body

Example code

Link to section

custom_attribute_definition

Required

The custom attribute definition to create. Note the following:

  • With the exception of the Selection data type, the schema is specified as a simple URL to the JSON schema definition hosted on the Square CDN. For more information, including supported values and constraints, see Specifying the schema.
  • If provided, name must be unique (case-sensitive) across all visible customer-related custom attribute definitions for the seller.
  • All custom attributes are visible in exported customer data, including those set to VISIBILITY_HIDDEN.
Link to section

idempotency_key

string

A unique identifier for this request, used to ensure idempotency. For more information, see Idempotency.

Min Length
1
Max Length
45
Link to section

Response fields

Link to section

custom_attribute_definition

The new custom attribute definition.

Link to section

errors

Any errors that occurred during the request.