POST /v2/orders/custom-attributes/bulk-upsert

Bulk upsert order custom attributesBeta

POST

/v2/orders/custom-attributes/bulk-upsert

Creates or updates order custom attributes 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 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.

Link to section

Request body

Example code

Link to section

values

Required

A map of requests that correspond to individual upsert operations for custom attributes.

Link to section

Response fields

Link to section

errors

Any errors that occurred during the request.

Link to section

values

Required

A map of responses that correspond to individual upsert operations for custom attributes.

curl https://connect.squareup.com/v2/orders/custom-attributes/bulk-upsert \ -X POST \ -H 'Square-Version: 2024-11-20' \ -H 'Authorization: Bearer ACCESS_TOKEN' \ -H 'Content-Type: application/json' \ -d '{ "values": { "table-number": { "order_id": "7BbXGEIWNldxAzrtGf9GPVZTwZ4F", "custom_attribute": { "key": "table-number", "value": "11", "version": 4 } }, "cover-count": { "order_id": "7BbXGEIWNldxAzrtGf9GPVZTwZ4F", "custom_attribute": { "key": "cover-count", "value": "6", "version": 2 } } } }'

{ "values": { "table-number": { "custom_attribute": { "key": "table-number", "updated_at": "2022-11-22T21:28:35.726Z", "value": "11", "created_at": "2022-11-22T21:24:57.823Z", "visibility": "VISIBILITY_HIDDEN" } }, "cover-count": { "custom_attribute": { "key": "cover-count", "updated_at": "2022-11-22T21:28:35.721Z", "value": "6", "created_at": "2022-11-22T21:27:33.429Z", "visibility": "VISIBILITY_READ_WRITE_VALUES" } } } }