• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”
You are viewing an old version of the API

Order custom attribute definition visible created BETA

EVENT order.custom_attribute_definition.visible.created

Published when an order custom attribute definition that is visible to the subscribing app is created.


Permissions
ORDERS_READ
Name Description
merchant_id
string

The ID of the target seller associated with the event.

type
string

The type of this event. The value is "order.custom_attribute_definition.visible.created".

event_id
string

A unique ID for the event.

created_at
string

Read only The timestamp of when the event was created, in RFC 3339 format.

Examples for January 25th, 2020 6:25:34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

data
CustomAttributeDefinitionSquareEventData

The data associated with the event.

Examples

You are viewing an old version of the API
Example payload
{
  "merchant_id": "MLABZFS5JTW5B",
  "type": "order.custom_attribute_definition.visible.created",
  "event_id": "32515c08-b0c3-3835-9606-f43f613e4635",
  "created_at": "2022-11-09T20:59:17.185Z",
  "data": {
    "type": "custom_attribute_definition",
    "id": "sq0ids-tr5sCkWm3b9X9MkpAvJ42A:table-number",
    "object": {
      "created_at": "2022-11-09T20:59:17.185Z",
      "description": "Table number at a location",
      "key": "sq0ids-tr5sCkWm3b9X9MkpAvJ42A:table-number",
      "name": "Table Number",
      "schema": {
        "$ref": "https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.String"
      },
      "updated_at": "2022-11-09T20:59:17.185Z",
      "version": 1,
      "visibility": "VISIBILITY_READ_WRITE_VALUES"
    }
  }
}