Square (version v1.*.*)

adjust_inventory#

Adjusts an item variation's current available inventory.

Parameters

location_id (required)#

The ID of the item's associated location.

Type: string

variation_id (required)#

The ID of the variation to adjust inventory information for.

Type: string

$body#

An object containing the fields to POST for the request.
See the corresponding object definition for field details.

Type: object

{
  "quantity_delta" : "The number to adjust the variation's quantity by.",
  "adjustment_type" : "The reason for the inventory adjustment. See [V1AdjustInventoryRequestAdjustmentType](#type-v1adjustinventoryrequestadjustmenttype) for possible values",
  "memo" : "A note about the inventory adjustment."
}

Type: string

$body#

An object containing the fields to POST for the request.
See the corresponding object definition for field details.

Type: object

{
  "order_ids" : [ "string" ]
}

batch_upsert_catalog_objects#

Creates or updates up to 10,000 target objects based on the provided list of objects. The target objects are grouped into batches and each batch is inserted/updated in an all-or-nothing manner. If an object within a batch is malformed in some way, or violates a database constraint, the entire batch containing that item will be disregarded. However, other batches in the same request may still succeed. Each batch may contain up to 1,000 objects, and batches will be processed in order as long as the total object count for the request (items, variations, modifier lists, discounts, and taxes) is no more than 10,000.

Parameters

$body#

An object containing the fields to POST for the request.
See the corresponding object definition for field details.

Type: object

{
  "batches" : [ {
    "objects" : [ {
      "category_data" : {
        "name" : "The category's name. Searchable. This field has max length of 255 Unicode code points."
      },
      "measurement_unit_data" : {
        "precision" : "Represents the maximum number of positions allowed after the decimal in quantities measured with this unit. For example, if the precision is 2, then an itemization’s quantity can be 0.01, 0.12, etc. Min: 0 Max: 5 Default: 3",
        "measurement_unit" : {
          "volume_unit" : "Represents a standard volume unit. See [MeasurementUnitVolume](#type-measurementunitvolume) for possible values",
          "weight_unit" : "Represents a standard unit of weight or mass. See [MeasurementUnitWeight](#type-measurementunitweight) for possible values",
          "generic_unit" : "Reserved for API integrations that lack the ability to specify a real measurement unit See [MeasurementUnitGeneric](#type-measurementunitgeneric) for possible values",
          "area_unit" : "Represents a standard area unit. See [MeasurementUnitArea](#type-measurementunitarea) for possible values",
          "type" : "Represents the type of the measurement unit. See [MeasurementUnitUnitType](#type-measurementunitunittype) for possible values",
          "custom_unit" : {
            "name" : "The name of the custom unit, for example \"bushel\".",
            "abbreviation" : "The abbreviation of the custom unit, such as \"bsh\" (bushel). This appears in the cart for the Point of Sale app, and in reports."
          },
          "length_unit" : "Represents a standard length unit. See [MeasurementUnitLength](#type-measurementunitlength) for possible values"
        }
      },
      "discount_data" : {
        "pin_required" : "Indicates whether a mobile staff member needs to enter their PIN to apply the discount to a payment in the Square Point of Sale app.",
        "label_color" : "The color of the discount's display label in the Square Point of Sale app. This must be a valid hex color code.",
        "percentage" : "The percentage of the discount as a string representation of a decimal number, using a `.` as the decimal separator and without a `%` sign. A value of `7.5` corresponds to `7.5%`. Specify a percentage of `0` if `discount_type` is `VARIABLE_PERCENTAGE`. Do not include this field for amount-based or variable discounts.",
        "name" : "The discount's name. Searchable. This field has max length of 255 Unicode code points.",
        "amount_money" : {
          "amount" : "The amount of money, in the smallest denomination of the currency indicated by `currency`. For example, when `currency` is `USD`, `amount` is in cents. Monetary amounts can be positive or negative. See the specific API documentation to determine the meaning of the sign in a particular case.",
          "currency" : "The type of currency, in __ISO 4217 format__. For example, the currency code for US dollars is `USD`. See [Currency](#type-currency) for possible values. See [Currency](#type-currency) for possible values"
        },
        "discount_type" : "Indicates whether the discount is a fixed amount or percentage, or entered at the time of sale. See [CatalogDiscountType](#type-catalogdiscounttype) for possible values"
      },
      "item_option_value_data" : {
        "item_option_id" : "Unique ID of the associated item option.",
        "color" : "The HTML color for this value in the format #FFRRGGBB or #RRGGBB (e.g., \"#ff8d4e85\"). Only displayed if parent Item Option's `show_colors` flag is enabled. value.",
        "name" : "Name of this item option value. Searchable.",
        "description" : "The option value's human-readable description.",
        "item_variation_count" : "The number of [CatalogItemVariation(#type-catalogitemvariation)s that currently make use of this Item Option value. Present only if `retrieve_counts` was specified on the request used to retrieve the parent Item Option of this value. Maximum: 100 counts.",
        "ordinal" : "Determines where this option value appears in a list of option values."
      },
      "catalog_v1_ids" : [ {
        "location_id" : "The ID of the [location](#type-location) this Connect V1 ID is associated with.",
        "catalog_v1_id" : "The ID for an object in Connect V1, if different from its Connect V2 ID."
      } ],
      "absent_at_location_ids" : [ "string" ],
      "modifier_list_data" : {
        "selection_type" : "Indicates whether multiple options from the [CatalogModifierList](#type-catalogmodifierlist) can be applied to a single [CatalogItem](#type-catalogitem). See [CatalogModifierListSelectionType](#type-catalogmodifierlistselectiontype) for possible values",
        "name" : "The [CatalogModifierList](#type-catalogmodifierlist)'s name. Searchable. This field has max length of 255 Unicode code points.",
        "modifiers" : [ "CatalogObject" ]
      },
      "type" : "The type of this object. Each object type has expected properties expressed in a structured format within its corresponding `*_data` field below. See [CatalogObjectType](#type-catalogobjecttype) for possible values",
      "version" : "The version of the object. When updating an object, the version supplied must match the version in the database, otherwise the write will be rejected as conflicting.",
      "present_at_location_ids" : [ "string" ],
      "tax_data" : {
        "calculation_phase" : "Whether the tax is calculated based on a payment's subtotal or total. See [TaxCalculationPhase](#type-taxcalculationphase) for possible values",
        "percentage" : "The percentage of the tax in decimal form, using a `'.'` as the decimal separator and without a `'%'` sign. A value of `7.5` corresponds to 7.5%.",
        "name" : "The tax's name. Searchable. This field has max length of 255 Unicode code points.",
        "inclusion_type" : "Whether the tax is `ADDITIVE` or `INCLUSIVE`.\nSee [TaxInclusionType](#type-taxinclusiontype) for possible values",
        "applies_to_custom_amounts" : "If `true`, the fee applies to custom amounts entered into the Square Point of Sale app that are not associated with a particular [CatalogItem](#type-catalogitem).",
        "enabled" : "If `true`, the tax will be shown as enabled in the Square Point of Sale app."
      },
      "item_data" : {
        "item_options" : [ {
          "item_option_id" : "The unique id of the item option, used to form the dimensions of the item option matrix in a specified order."
        } ],
        "tax_ids" : [ "string" ],
        "label_color" : "The color of the item's display label in the Square Point of Sale app. This must be a valid hex color code.",
        "description" : "The item's description. Searchable. This field has max length of 4096 Unicode code points.",
        "modifier_list_info" : [ {
          "max_selected_modifiers" : "If zero or larger, the largest number of [CatalogModifier](#type-catalogmodifier)s that can be selected from this [CatalogModifierList](#type-catalogmodifierlist).",
          "modifier_list_id" : "The ID of the [CatalogModifierList](#type-catalogmodifierlist) controlled by this [CatalogModifierListInfo](#type-catalogmodifierlistinfo).",
          "modifier_overrides" : [ {
            "on_by_default" : "If `true`, this [CatalogModifier](#type-catalogmodifier) should be selected by default for this [CatalogItem](#type-catalogitem).",
            "modifier_id" : "The ID of the [CatalogModifier](#type-catalogmodifier) whose default behavior is being overridden."
          } ],
          "enabled" : "If `true`, enable this [CatalogModifierList](#type-catalogmodifierlist).",
          "min_selected_modifiers" : "If zero or larger, the smallest number of [CatalogModifier](#type-catalogmodifier)s that must be selected from this [CatalogModifierList](#type-catalogmodifierlist)."
        } ],
        "abbreviation" : "The text of the item's display label in the Square Point of Sale app. Only up to the first five characters of the string are used. Searchable. This field has max length of 24 Unicode code points.",
        "available_electronically" : "If `true`, the item can be added to electronically fulfilled orders from the merchant's online store.",
        "product_type" : "The product type of the item. May not be changed once an item has been created. Only items of product type `REGULAR` or `APPOINTMENTS_SERVICE` may be created by this API; items with other product types are read-only. See [CatalogItemProductType](#type-catalogitemproducttype) for possible values",
        "category_id" : "The ID of the item's category, if any.",
        "variations" : [ "CatalogObject" ],
        "name" : "The item's name. Searchable. This field must not be empty. This field has max length of 512 Unicode code points.",
        "skip_modifier_screen" : "If `false`, the Square Point of Sale app will present the [CatalogItem](#type-catalogitem)'s details screen immediately, allowing the merchant to choose [CatalogModifier](#type-catalogmodifier)s before adding the item to the cart. This is the default behavior. If `true`, the Square Point of Sale app will immediately add the item to the cart with the pre-selected modifiers, and merchants can edit modifiers by drilling down onto the item's details. Third-party clients are encouraged to implement similar behaviors.",
        "available_online" : "If `true`, the item can be added to shipping orders from the merchant's online store.",
        "available_for_pickup" : "If `true`, the item can be added to pickup orders from the merchant's online store."
      },
      "present_at_all_locations" : "If `true`, this object is present at all locations (including future locations), except where specified in the `absent_at_location_ids` field. If `false`, this object is not present at any locations (including future locations), except where specified in the `present_at_location_ids` field. If not specified, defaults to `true`.",
      "product_set_data" : {
        "product_ids_all" : [ "string" ],
        "all_products" : "If set to `true`, the product set will include every item in the catalog. Only one of `product_ids_all`, `product_ids_any`, or `all_products` can be set.",
        "quantity_min" : "If set, there must be at least this many items from `products_any` or `products_all` in a cart for the discount to apply. See `quantity_exact`. Defaults to 0 if `quantity_exact`, `quantity_min` and `quantity_max` are all unspecified.",
        "name" : "User-defined name for the product set. For example, \"Clearance Items\"\nor \"Winter Sale Items\".",
        "quantity_exact" : "If set, there must be exactly this many items from `products_any` or `products_all` in the cart for the discount to apply. Cannot be combined with either `quantity_min` or `quantity_max`.",
        "quantity_max" : "If set, the pricing rule will apply to a maximum of this many items from `products_any` or `products_all`.",
        "product_ids_any" : [ "string" ]
      },
      "is_deleted" : "If `true`, the object has been deleted from the database. Must be `false` for new objects being inserted. When deleted, the `updated_at` field will equal the deletion time.",
      "updated_at" : "Last modification [timestamp](#workingwithdates) in RFC 3339 format, e.g., `\"2016-08-15T23:59:33.123Z\"` would indicate the UTC time (denoted by `Z`) of August 15, 2016 at 23:59:33 and 123 milliseconds.",
      "item_variation_data" : {
        "item_option_values" : [ {
          "item_option_id" : "The unique id of an item option.",
          "item_option_value_id" : "The unique id of the selected value for the item option."
        } ],
        "price_money" : {
          "amount" : "The amount of money, in the smallest denomination of the currency indicated by `currency`. For example, when `currency` is `USD`, `amount` is in cents. Monetary amounts can be positive or negative. See the specific API documentation to determine the meaning of the sign in a particular case.",
          "currency" : "The type of currency, in __ISO 4217 format__. For example, the currency code for US dollars is `USD`. See [Currency](#type-currency) for possible values. See [Currency](#type-currency) for possible values"
        },
        "item_id" : "The ID of the [CatalogItem](#type-catalogitem) associated with this item variation. Searchable.",
        "upc" : "The item variation's UPC, if any. Searchable in the Connect API. This field is only exposed in the Connect API. It is not exposed in Square's Dashboard, Square Point of Sale app or Retail Point of Sale app.",
        "location_overrides" : [ {
          "pricing_type" : "The pricing type (fixed or variable) for the [CatalogItemVariation](#type-catalogitemvariation) at the given [location](#type-location). See [CatalogPricingType](#type-catalogpricingtype) for possible values",
          "price_money" : {
            "amount" : "The amount of money, in the smallest denomination of the currency indicated by `currency`. For example, when `currency` is `USD`, `amount` is in cents. Monetary amounts can be positive or negative. See the specific API documentation to determine the meaning of the sign in a particular case.",
            "currency" : "The type of currency, in __ISO 4217 format__. For example, the currency code for US dollars is `USD`. See [Currency](#type-currency) for possible values. See [Currency](#type-currency) for possible values"
          },
          "inventory_alert_threshold" : "If the inventory quantity for the variation is less than or equal to this value and `inventory_alert_type` is `LOW_QUANTITY`, the variation displays an alert in the merchant dashboard. This value is always an integer.",
          "track_inventory" : "If `true`, inventory tracking is active for the [CatalogItemVariation](#type-catalogitemvariation) at this [location](#type-location).",
          "location_id" : "The ID of the [location](#type-location).",
          "inventory_alert_type" : "Indicates whether the [CatalogItemVariation](#type-catalogitemvariation) displays an alert when its inventory quantity is less than or equal to its `inventory_alert_threshold`. See [InventoryAlertType](#type-inventoryalerttype) for possible values"
        } ],
        "user_data" : "Arbitrary user metadata to associate with the item variation. Cannot exceed 255 characters. Searchable.",
        "service_duration" : "If the [CatalogItem](#type-catalogitem) that owns this item variation is of type `APPOINTMENTS_SERVICE`, then this is the duration of the service in milliseconds. For example, a 30 minute appointment would have the value `1800000`, which is equal to 30 (minutes) * 60 (seconds per minute) * 1000 (milliseconds per second).",
        "pricing_type" : "Indicates whether the item variation's price is fixed or determined at the time of sale. See [CatalogPricingType](#type-catalogpricingtype) for possible values",
        "inventory_alert_threshold" : "If the inventory quantity for the variation is less than or equal to this value and `inventory_alert_type` is `LOW_QUANTITY`, the variation displays an alert in the merchant dashboard. This value is always an integer.",
        "measurement_unit_id" : "ID of the ‘CatalogMeasurementUnit’ that is used to measure the quantity sold of this item variation. If left unset, the item will be sold in whole quantities.",
        "name" : "The item variation's name. Searchable. This field has max length of 255 Unicode code points.",
        "track_inventory" : "If `true`, inventory tracking is active for the variation.",
        "sku" : "The item variation's SKU, if any. Searchable.",
        "ordinal" : "The order in which this item variation should be displayed. This value is read-only. On writes, the ordinal for each item variation within a parent [CatalogItem](#type-catalogitem) is set according to the item variations's position. On reads, the value is not guaranteed to be sequential or unique.",
        "inventory_alert_type" : "Indicates whether the item variation displays an alert when its inventory quantity is less than or equal to its `inventory_alert_threshold`. See [InventoryAlertType](#type-inventoryalerttype) for possible values"
      },
      "time_period_data" : {
        "event" : "An iCalendar (RFC5545) [event](https://tools.ietf.org/html/rfc5545#section-3.6.1), which specifies the name, timing, duration and recurrence of this time period. Example: ``` DTSTART:20190707T180000 DURATION:P2H RRULE:FREQ=WEEKLY;BYDAY=MO,WE,FR ``` Only `SUMMARY`, `DTSTART`, `DURATION` and `RRULE` fields are supported. `DTSTART` must be in local (unzoned) time format. Note that while `BEGIN:VEVENT` and `END:VEVENT` is not required in the request. The response will always include them."
      },
      "image_data" : {
        "name" : "The internal name of this image. Identifies this image in calls to the Connect APIs.",
        "caption" : "A caption that describes what is shown in the image. Displayed in the Square Online Store.",
        "url" : "The URL of this image. Generated by Square after an image is uploaded to the CreateCatalogImage endpoint."
      },
      "item_option_data" : {
        "item_count" : "The number of [CatalogItem](#type-catalogitem)s currently associated with this item option. Present only if the `include_counts` was specified in the request. Any count over 100 will be returned as `100`.",
        "values" : [ "CatalogObject" ],
        "name" : "The item option's display name for the seller. Must be unique across\nall item options. Searchable.",
        "description" : "The item option's human-readable description. Displays for in the Square Point of Sale app for the seller and in the Online Store or on receipts for the buyer.",
        "show_colors" : "If true, display colors for entries in `values` when present.",
        "display_name" : "The item option's display name for the customer. Searchable."
      },
      "id" : "An identifier to reference this object in the catalog. When a new CatalogObject is inserted, the client should set the id to a temporary identifier starting with a `'#'` character. Other objects being inserted or updated within the same request may use this identifier to refer to the new object. When the server receives the new object, it will supply a unique identifier that replaces the temporary identifier for all future references.",
      "image_id" : "Identifies the `CatalogImage` attached to this `CatalogObject`.",
      "pricing_rule_data" : {
        "time_period_ids" : [ "string" ],
        "exclude_products_id" : "Identifies the [CatalogProductSet](#type-catalogproductset) to exclude from this pricing rule. An exclude rule matches within the subset of the cart that fits the match rules (the match set). An exclude rule can only match once in the match set. If not supplied, the pricing will be applied to all products in the match set. Other products retain their base price, or a price generated by other rules.",
        "valid_until_date" : "Represents the date the pricing rule will become inactive.\nRepresented in RFC3339 full-date format (YYYY-MM-DD).",
        "name" : "User-defined name for the pricing rule. For example, \"Buy one get one free\" or \"10% off\".",
        "apply_products_id" : "The [CatalogProductSet](#type-catalogproductset) to apply the pricing rule to within the set of matched products specified by `match_products_id`. An apply rule can only match once within the set of matched products. If left unset, the pricing rule will be applied to all products within the set of matched products.",
        "match_products_id" : "Unique ID for the [CatalogProductSet](#type-catalogproductset) that will be matched by this rule. A match rule matches within the entire cart.",
        "valid_from_date" : "Represents the date the Pricing Rule is valid from. Represented in\nRFC3339 full-date format (YYYY-MM-DD).",
        "valid_from_local_time" : "Represents the local time the pricing rule should be valid from. Time zone is determined by the device running the Point of Sale app. Represented in RFC3339 partial-time format (HH:MM:SS). Partial seconds will be truncated.",
        "valid_until_local_time" : "Represents the local time at which the pricing rule will become inactive. Time zone is determined by the device running the Point of Sale app. Represented in RFC3339 partial-time format (HH:MM:SS). Partial seconds will be truncated.",
        "discount_id" : "Unique ID for the [CatalogDiscount](#type-catalogdiscount) to take off the price of all matched items. Only one of `total_price_money`, `item_price`, or `discount` can be supplied."
      },
      "modifier_data" : {
        "price_money" : {
          "amount" : "The amount of money, in the smallest denomination of the currency indicated by `currency`. For example, when `currency` is `USD`, `amount` is in cents. Monetary amounts can be positive or negative. See the specific API documentation to determine the meaning of the sign in a particular case.",
          "currency" : "The type of currency, in __ISO 4217 format__. For example, the currency code for US dollars is `USD`. See [Currency](#type-currency) for possible values. See [Currency](#type-currency) for possible values"
        },
        "name" : "The modifier's name. Searchable. This field has max length of 255 Unicode code points."
      }
    } ]
  } ],
  "idempotency_key" : "A value you specify that uniquely identifies this\nrequest among all your requests. A common way to create\na valid idempotency key is to use a Universally unique\nidentifier (UUID).\nIf you're unsure whether a particular request was successful,\nyou can reattempt it with the same idempotency key without\nworrying about creating duplicate objects.\nSee [Idempotency](/basics/api101/idempotency) for more information."
}

cancel_payment#

An object containing the fields to POST for the request.
See the corresponding object definition for field details.

Type: object

{
  "idempotency_key" : "Unique string value to insure idempotency of the operation",
  "break_type" : {
    "updated_at" : "A read-only timestamp in RFC 3339 format.",
    "break_name" : "A human-readable name for this type of break. Will be displayed to\nemployees in Square products.",
    "expected_duration" : "Format: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. The expected length of\nthis break. Precision below minutes is truncated.",
    "created_at" : "A read-only timestamp in RFC 3339 format.",
    "id" : "UUID for this object.",
    "is_paid" : "Whether this break counts towards time worked for compensation\npurposes.",
    "version" : "Used for resolving concurrency issues; request will fail if version provided does not match server version at time of request. If a value is not provided, Square's servers execute a \"blind\" write; potentially overwriting another writer's data.",
    "location_id" : "The ID of the business location this type of break applies to."
  }
}

create_category#

Creates an item category.

Parameters

location_id (required)#

The ID of the location to create an item for.

Type: string

$body#

An object containing the fields to POST for the request.
See the corresponding object definition for field details.

Type: object

{
  "name" : "The category's name.",
  "v2_id" : "The ID of the CatalogObject in the Connect v2 API. Objects that are shared across multiple locations share the same v2 ID.",
  "id" : "The category's unique ID."
}

create_checkout#

Type: string

$body#

An object containing the fields to POST for the request.
See the corresponding object definition for field details.

Type: object

{
  "card_nonce" : "A card nonce representing the credit card to link to the customer. Card nonces are generated by the `SqPaymentForm` that buyers enter their card information into. See [Embedding the payment form](/payment-form/payment-form-walkthrough) for more information. __Note:__ Card nonces generated by digital wallets (e.g., Apple Pay) cannot be used to create a customer card.",
  "billing_address" : {
    "country" : "The address's country, in ISO 3166-1-alpha-2 format.\nSee [Country](#type-country) for possible values",
    "administrative_district_level_3" : "A civil entity within the address's `administrative_district_level_2`, if any.",
    "locality" : "The city or town of the address.",
    "sublocality" : "A civil region within the address's `locality`, if any.",
    "last_name" : "Optional last name when it's representing recipient.",
    "administrative_district_level_2" : "A civil entity within the address's `administrative_district_level_1`. In the US, this is the county.",
    "administrative_district_level_1" : "A civil entity within the address's country. In the US, this\nis the state.",
    "sublocality_3" : "A civil region within the address's `sublocality_2`, if any.",
    "sublocality_2" : "A civil region within the address's `sublocality`, if any.",
    "organization" : "Optional organization name when it's representing recipient.",
    "address_line_1" : "The first line of the address. Fields that start with `address_line` provide the address's most specific details, like street number, street name, and building name. They do *not* provide less specific details like city, state/province, or country (these details are provided in other fields).",
    "address_line_3" : "The third line of the address, if any.",
    "address_line_2" : "The second line of the address, if any.",
    "postal_code" : "The address's postal code.",
    "first_name" : "Optional first name when it's representing recipient."
  },
  "cardholder_name" : "The full name printed on the credit card.",
  "verification_token" : "An identifying token generated by `SqPaymentForm.verifyBuyer()`. Verification tokens encapsulate customer device information and 3-D Secure challenge results to indicate that Square has verified the buyer identity."
}

create_discount#

Creates a discount.

Parameters

location_id (required)#

The ID of the location to create an item for.

Type: string

$body#

An object containing the fields to POST for the request.
See the corresponding object definition for field details.

Type: object

{
  "pin_required" : "Indicates whether a mobile staff member needs to enter their PIN to apply the discount to a payment.",
  "color" : "The color of the discount's display label in Square Register, if not the default color. The default color is 9da2a6. See [V1DiscountColor](#type-v1discountcolor) for possible values",
  "rate" : "The rate of the discount, as a string representation of a decimal number. A value of 0.07 corresponds to a rate of 7%. This rate is 0 if discount_type is VARIABLE_PERCENTAGE.",
  "name" : "The discount's name.",
  "v2_id" : "The ID of the CatalogObject in the Connect v2 API. Objects that are shared across multiple locations share the same v2 ID.",
  "amount_money" : {
    "amount" : "Amount in the lowest denominated value of this Currency. E.g. in USD these are cents, in JPY they are Yen (which do not have a 'cent' concept).",
    "currency_code" : "See [Currency](#type-currency) for possible values"
  },
  "id" : "The discount's unique ID.",
  "discount_type" : "Indicates whether the discount is a FIXED value or entered at the time of sale. See [V1DiscountDiscountType](#type-v1discountdiscounttype) for possible values"
}

create_employee#

Use the CreateEmployee endpoint to add an employee to a Square
account. Employees created with the Connect API have an initial status
of INACTIVE. Inactive employees cannot sign in to Square Point of Sale
until they are activated from the Square Dashboard. Employee status
cannot be changed with the Connect API.

Employee entities cannot be deleted. To disable employee profiles,
set the employee's status to INACTIVE

Parameters

$body#

An object containing the fields to POST for the request.
See the corresponding object definition for field details.

Type: object

{
  "updated_at" : "The time when the employee entity was most recently updated, in ISO 8601 format.",
  "last_name" : "The employee's last name.",
  "created_at" : "The time when the employee entity was created, in ISO 8601 format.",
  "external_id" : "An ID the merchant can set to associate the employee with an entity in another system.",
  "id" : "The employee's unique ID.",
  "first_name" : "The employee's first name.",
  "role_ids" : [ "string" ],
  "email" : "The employee's email address.",
  "authorized_location_ids" : [ "string" ],
  "status" : "CWhether the employee is ACTIVE or INACTIVE. Inactive employees cannot sign in to Square Register.Merchants update this field from the Square Dashboard. See [V1EmployeeStatus](#type-v1employeestatus) for possible values"
}

create_employee_role#

Creates an employee role you can then assign to employees. Square accounts can include any number of roles that can be assigned to employees. These roles define the actions and permissions granted to an employee with that role. For example, an employee with a "Shift Manager" role might be able to issue refunds in Square Point of Sale, whereas an employee with a "Clerk" role might not. Roles are assigned with the V1UpdateEmployee endpoint. An employee can have only one role at a time. If an employee has no role, they have none of the permissions associated with roles. All employees can accept payments with Square Point of Sale.

Parameters

$body#

An EmployeeRole object with a name and permissions, and an optional owner flag.

Type: object

{
  "updated_at" : "The time when the employee entity was most recently updated, in ISO 8601 format. Is set by Square when the Role updated.",
  "permissions" : [ "string" ],
  "is_owner" : "If true, employees with this role have all permissions, regardless of the values indicated in permissions.",
  "name" : "The role's merchant-defined name.",
  "created_at" : "The time when the employee entity was created, in ISO 8601 format. Is set by Square when the Role is created.",
  "id" : "The role's unique ID, Can only be set by Square."
}

create_fee#

Creates a fee (tax).

Parameters

location_id (required)#

The ID of the location to create a fee for.

Type: string

$body#

An object containing the fields to POST for the request.
See the corresponding object definition for field details.

Type: object

{
  "calculation_phase" : "Forthcoming See [V1FeeCalculationPhase](#type-v1feecalculationphase) for possible values",
  "rate" : "The rate of the fee, as a string representation of a decimal number. A value of 0.07 corresponds to a rate of 7%.",
  "name" : "The fee's name.",
  "adjustment_type" : "The type of adjustment the fee applies to a payment. Currently, this value is TAX for all fees. See [V1FeeAdjustmentType](#type-v1feeadjustmenttype) for possible values",
  "v2_id" : "The ID of the CatalogObject in the Connect v2 API. Objects that are shared across multiple locations share the same v2 ID.",
  "id" : "The fee's unique ID.",
  "inclusion_type" : "Whether the fee is ADDITIVE or INCLUSIVE. See [V1FeeInclusionType](#type-v1feeinclusiontype) for possible values",
  "type" : "In countries with multiple classifications for sales taxes, indicates which classification the fee falls under. Currently relevant only to Canadian merchants. See [V1FeeType](#type-v1feetype) for possible values",
  "applies_to_custom_amounts" : "If true, the fee applies to custom amounts entered into Square Register that are not associated with a particular item.",
  "enabled" : "If true, the fee is applied to all appropriate items. If false, the fee is not applied at all."
}

create_item#

Type: string

$body#

An object containing the fields to POST for the request.
See the corresponding object definition for field details.

Type: object

{
  "selection_type" : "Indicates whether MULTIPLE options or a SINGLE option from the modifier list can be applied to a single item. See [V1ModifierListSelectionType](#type-v1modifierlistselectiontype) for possible values",
  "name" : "The modifier list's name.",
  "v2_id" : "The ID of the CatalogObject in the Connect v2 API. Objects that are shared across multiple locations share the same v2 ID.",
  "id" : "The modifier list's unique ID.",
  "modifier_options" : [ {
    "price_money" : {
      "amount" : "Amount in the lowest denominated value of this Currency. E.g. in USD these are cents, in JPY they are Yen (which do not have a 'cent' concept).",
      "currency_code" : "See [Currency](#type-currency) for possible values"
    },
    "on_by_default" : "If true, the modifier option is the default option in a modifier list for which selection_type is SINGLE.",
    "name" : "The modifier option's name.",
    "v2_id" : "The ID of the CatalogObject in the Connect v2 API. Objects that are shared across multiple locations share the same v2 ID.",
    "id" : "The modifier option's unique ID.",
    "modifier_list_id" : "The ID of the modifier list the option belongs to.",
    "ordinal" : "Indicates the modifier option's list position when displayed in Square Register and the merchant dashboard. If more than one modifier option in the same modifier list has the same ordinal value, those options are displayed in alphabetical order."
  } ]
}

create_modifier_option#

Type: string

location_id (required)#

The ID of the item's associated location.

Type: string

$body#

An object containing the fields to POST for the request.
See the corresponding object definition for field details.

Type: object

{
  "pricing_type" : "Indicates whether the item variation's price is fixed or determined at the time of sale. See [V1VariationPricingType](#type-v1variationpricingtype) for possible values",
  "price_money" : {
    "amount" : "Amount in the lowest denominated value of this Currency. E.g. in USD these are cents, in JPY they are Yen (which do not have a 'cent' concept).",
    "currency_code" : "See [Currency](#type-currency) for possible values"
  },
  "item_id" : "The ID of the variation's associated item.",
  "inventory_alert_threshold" : "If the inventory quantity for the variation is less than or equal to this value and inventory_alert_type is LOW_QUANTITY, the variation displays an alert in the merchant dashboard.",
  "name" : "The item variation's name.",
  "track_inventory" : "If true, inventory tracking is active for the variation.",
  "v2_id" : "The ID of the CatalogObject in the Connect v2 API. Objects that are shared across multiple locations share the same v2 ID.",
  "id" : "The item variation's unique ID.",
  "user_data" : "Arbitrary metadata associated with the variation. Cannot exceed 255 characters.",
  "sku" : "The item variation's SKU, if any.",
  "ordinal" : "Indicates the variation's list position when displayed in Square Register and the merchant dashboard. If more than one variation for the same item has the same ordinal value, those variations are displayed in alphabetical order",
  "inventory_alert_type" : "Indicates whether the item variation displays an alert when its inventory quantity is less than or equal to its inventory_alert_threshold. See [V1VariationInventoryAlertType](#type-v1variationinventoryalerttype) for possible values"
}

types#

Type: string

batch_token#

A pagination cursor to retrieve the next set of results for your
original query to the endpoint.

Type: string

The order in which results are listed.

ASC - oldest to newest
DESC - newest to oldest (default).

Type: string

sort_order#

The order in which results are listed.

ASC - oldest to newest
DESC - newest to oldest (default).

An object containing the fields to POST for the request.
See the corresponding object definition for field details.

Type: object

{
  "refresh_token" : "A valid refresh token for generating a new OAuth access token. A valid refresh token is required if `grant_type` is set to `refresh_token` , to indicate the application wants a replacement for an expired OAuth access token.",
  "migration_token" : "Legacy OAuth access token obtained using a Connect API version prior to 2019-03-13. This parameter is required if `grant_type` is set to `migration_token` to indicate that the application wants to get a replacement OAuth access token. The response also returns a refresh token. For more information, see [Migrate to Using Refresh Tokens](/authz/oauth/migration).",
  "code" : "The authorization code to exchange. This is required if `grant_type` is set to `authorization_code`, to indicate that the application wants to exchange an authorization code for an OAuth access token.",
  "grant_type" : "Specifies the method to request an OAuth access token. Valid values are: `authorization_code`, `refresh_token`, and `migration_token`",
  "client_secret" : "The Square-issued application secret for your application, available from the [application dashboard](https://connect.squareup.com/apps).",
  "redirect_uri" : "The redirect URL assigned in the [application dashboard](https://connect.squareup.com/apps).",
  "client_id" : "The Square-issued ID of your application, available from the [application dashboard](https://connect.squareup.com/apps)."
}

pay_order#

The ID of the settlements's associated location.

Type: string

settlement_id (required)#

The settlement's Square-issued ID. You obtain this value from Settlement objects returned by the List Settlements endpoint.

Type: string

retrieve_timecard#

Provides the details for a single timecard.

Only approved accounts can manage their employees with Square.
Unapproved accounts cannot use employee management features with the
API.

Parameters

timecard_id (required)#

Type: object

{
  "cursor" : "A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Pagination](/basics/api101/pagination) for more information.",
  "location_ids" : [ "string" ],
  "query" : {
    "filter" : {
      "fulfillment_filter" : {
        "fulfillment_states" : [ "string" ],
        "fulfillment_types" : [ "string" ]
      },
      "state_filter" : {
        "states" : [ "string" ]
      },
      "customer_filter" : {
        "customer_ids" : [ "string" ]
      },
      "date_time_filter" : {
        "closed_at" : {
          "end_at" : "A datetime value in RFC-3339 format indicating when the time range\nends.",
          "start_at" : "A datetime value in RFC-3339 format indicating when the time range\nstarts."
        },
        "updated_at" : {
          "end_at" : "A datetime value in RFC-3339 format indicating when the time range\nends.",
          "start_at" : "A datetime value in RFC-3339 format indicating when the time range\nstarts."
        },
        "created_at" : {
          "end_at" : "A datetime value in RFC-3339 format indicating when the time range\nends.",
          "start_at" : "A datetime value in RFC-3339 format indicating when the time range\nstarts."
        }
      },
      "source_filter" : {
        "source_names" : [ "string" ]
      }
    },
    "sort" : {
      "sort_field" : "The field to sort by. __Important:__ When using a [DateTimeFilter](#type-searchordersfilter), `sort_field` must match the timestamp field that the DateTimeFilter uses to filter. For example, If you set your `sort_field` to `CLOSED_AT` and you use a DateTimeFilter, your DateTimeFilter must filter for orders by their `CLOSED_AT` date. If this field does not match the timestamp field in `DateTimeFilter`, SearchOrders will return an error. Default: `CREATED_AT`. See [SearchOrdersSortField](#type-searchorderssortfield) for possible values",
      "sort_order" : "The chronological order in which results are returned. Defaults to `DESC`. See [SortOrder](#type-sortorder) for possible values"
    }
  },
  "limit" : "Maximum number of results to be returned in a single page. It is possible to receive fewer results than the specified limit on a given page. Default: `500`",
  "return_entries" : "Boolean that controls the format of the search results. If `true`, SearchOrders will return [`OrderEntry`](#type-orderentry) objects. If `false`, SearchOrders will return complete Order objects. Default: `false`."
}

search_shifts#

Returns a paginated list of Shift records for a business.
The list to be returned can be filtered by:

Location IDs and
employee IDs and
shift status (OPEN, CLOSED) and
shift start and
shift end and
work day details
The list can be sorted by:
start_at
end_at
created_at
updated_at

Parameters

$body#

An object containing the fields to POST for the request.
See the corresponding object definition for field details.

Type: object

{
  "cursor" : "opaque cursor for fetching the next page.",
  "query" : {
    "filter" : {
      "workday" : {
        "date_range" : {
          "end_date" : "String in `YYYY-MM-DD` format, e.g. `2017-10-31` per the ISO 8601\nextended format for calendar dates.\nThe end of a date range (inclusive)",
          "start_date" : "String in `YYYY-MM-DD` format, e.g. `2017-10-31` per the ISO 8601\nextended format for calendar dates.\nThe beginning of a date range (inclusive)"
        },
        "default_timezone" : "Location-specific timezones convert workdays to datetime filters. Every location included in the query must have a timezone, or this field must be provided as a fallback. Format: the IANA timezone database identifier for the relevant timezone.",
        "match_shifts_by" : "The strategy on which the dates are applied. See [ShiftWorkdayMatcher](#type-shiftworkdaymatcher) for possible values"
      },
      "employee_id" : [ "string" ],
      "start" : {
        "end_at" : "A datetime value in RFC-3339 format indicating when the time range\nends.",
        "start_at" : "A datetime value in RFC-3339 format indicating when the time range\nstarts."
      },
      "end" : {
        "end_at" : "A datetime value in RFC-3339 format indicating when the time range\nends.",
        "start_at" : "A datetime value in RFC-3339 format indicating when the time range\nstarts."
      },
      "location_id" : [ "string" ],
      "status" : "Fetch a `Shift` instance by `Shift.status`.\nSee [ShiftFilterStatus](#type-shiftfilterstatus) for possible values"
    },
    "sort" : {
      "field" : "The field to sort on.\nSee [ShiftSortField](#type-shiftsortfield) for possible values",
      "order" : "The order in which results are returned. Defaults to DESC.\nSee [SortOrder](#type-sortorder) for possible values"
    }
  },
  "limit" : "number of resources in a page (200 by default)."
}

update_break_type#

Updates an existing BreakType.

Parameters

id (required)#

UUID for the BreakType being updated.

Type: string

$body#

An object containing the fields to POST for the request.
See the corresponding object definition for field details.

Type: object

{
  "break_type" : {
    "updated_at" : "A read-only timestamp in RFC 3339 format.",
    "break_name" : "A human-readable name for this type of break. Will be displayed to\nemployees in Square products.",
    "expected_duration" : "Format: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. The expected length of\nthis break. Precision below minutes is truncated.",
    "created_at" : "A read-only timestamp in RFC 3339 format.",
    "id" : "UUID for this object.",
    "is_paid" : "Whether this break counts towards time worked for compensation\npurposes.",
    "version" : "Used for resolving concurrency issues; request will fail if version provided does not match server version at time of request. If a value is not provided, Square's servers execute a \"blind\" write; potentially overwriting another writer's data.",
    "location_id" : "The ID of the business location this type of break applies to."
  }
}

update_category#

Type: string

$body#

An object containing the fields to POST for the request.
See the corresponding object definition for field details.

Type: object

{
  "pin_required" : "Indicates whether a mobile staff member needs to enter their PIN to apply the discount to a payment.",
  "color" : "The color of the discount's display label in Square Register, if not the default color. The default color is 9da2a6. See [V1DiscountColor](#type-v1discountcolor) for possible values",
  "rate" : "The rate of the discount, as a string representation of a decimal number. A value of 0.07 corresponds to a rate of 7%. This rate is 0 if discount_type is VARIABLE_PERCENTAGE.",
  "name" : "The discount's name.",
  "v2_id" : "The ID of the CatalogObject in the Connect v2 API. Objects that are shared across multiple locations share the same v2 ID.",
  "amount_money" : {
    "amount" : "Amount in the lowest denominated value of this Currency. E.g. in USD these are cents, in JPY they are Yen (which do not have a 'cent' concept).",
    "currency_code" : "See [Currency](#type-currency) for possible values"
  },
  "id" : "The discount's unique ID.",
  "discount_type" : "Indicates whether the discount is a FIXED value or entered at the time of sale. See [V1DiscountDiscountType](#type-v1discountdiscounttype) for possible values"
}

update_employee#

UpdateEmployee

Parameters

employee_id (required)#

The ID of the role to modify.

Type: string

$body#

An object containing the fields to POST for the request.
See the corresponding object definition for field details.

Type: object

{
  "updated_at" : "The time when the employee entity was most recently updated, in ISO 8601 format.",
  "last_name" : "The employee's last name.",
  "created_at" : "The time when the employee entity was created, in ISO 8601 format.",
  "external_id" : "An ID the merchant can set to associate the employee with an entity in another system.",
  "id" : "The employee's unique ID.",
  "first_name" : "The employee's first name.",
  "role_ids" : [ "string" ],
  "email" : "The employee's email address.",
  "authorized_location_ids" : [ "string" ],
  "status" : "CWhether the employee is ACTIVE or INACTIVE. Inactive employees cannot sign in to Square Register.Merchants update this field from the Square Dashboard. See [V1EmployeeStatus](#type-v1employeestatus) for possible values"
}

update_employee_role#

Modifies the details of an employee role.

Parameters

role_id (required)#

The ID of the role to modify.

Type: string

$body#

An object containing the fields to POST for the request.
See the corresponding object definition for field details.

Type: object

{
  "updated_at" : "The time when the employee entity was most recently updated, in ISO 8601 format. Is set by Square when the Role updated.",
  "permissions" : [ "string" ],
  "is_owner" : "If true, employees with this role have all permissions, regardless of the values indicated in permissions.",
  "name" : "The role's merchant-defined name.",
  "created_at" : "The time when the employee entity was created, in ISO 8601 format. Is set by Square when the Role is created.",
  "id" : "The role's unique ID, Can only be set by Square."
}

update_fee#

Modifies the details of an existing fee (tax).

Parameters

fee_id (required)#

The ID of the fee to edit.

Type: string

location_id (required)#

The ID of the fee's associated location.

Type: string

$body#

An object containing the fields to POST for the request.
See the corresponding object definition for field details.

Type: object

{
  "calculation_phase" : "Forthcoming See [V1FeeCalculationPhase](#type-v1feecalculationphase) for possible values",
  "rate" : "The rate of the fee, as a string representation of a decimal number. A value of 0.07 corresponds to a rate of 7%.",
  "name" : "The fee's name.",
  "adjustment_type" : "The type of adjustment the fee applies to a payment. Currently, this value is TAX for all fees. See [V1FeeAdjustmentType](#type-v1feeadjustmenttype) for possible values",
  "v2_id" : "The ID of the CatalogObject in the Connect v2 API. Objects that are shared across multiple locations share the same v2 ID.",
  "id" : "The fee's unique ID.",
  "inclusion_type" : "Whether the fee is ADDITIVE or INCLUSIVE. See [V1FeeInclusionType](#type-v1feeinclusiontype) for possible values",
  "type" : "In countries with multiple classifications for sales taxes, indicates which classification the fee falls under. Currently relevant only to Canadian merchants. See [V1FeeType](#type-v1feetype) for possible values",
  "applies_to_custom_amounts" : "If true, the fee applies to custom amounts entered into Square Register that are not associated with a particular item.",
  "enabled" : "If true, the fee is applied to all appropriate items. If false, the fee is not applied at all."
}

update_item#

Modifies the core details of an existing item.

Parameters

item_id (required)#

The ID of the item to modify.

Type: string

location_id (required)#

The ID of the item's associated location.

Type: string

$body#

An object containing the fields to POST for the request.
See the corresponding object definition for field details.

Type: object

{
  "master_image" : {
    "id" : "The image's unique ID.",
    "url" : "The image's publicly accessible URL."
  },
  "fees" : [ {
    "calculation_phase" : "Forthcoming See [V1FeeCalculationPhase](#type-v1feecalculationphase) for possible values",
    "rate" : "The rate of the fee, as a string representation of a decimal number. A value of 0.07 corresponds to a rate of 7%.",
    "name" : "The fee's name.",
    "adjustment_type" : "The type of adjustment the fee applies to a payment. Currently, this value is TAX for all fees. See [V1FeeAdjustmentType](#type-v1feeadjustmenttype) for possible values",
    "v2_id" : "The ID of the CatalogObject in the Connect v2 API. Objects that are shared across multiple locations share the same v2 ID.",
    "id" : "The fee's unique ID.",
    "inclusion_type" : "Whether the fee is ADDITIVE or INCLUSIVE. See [V1FeeInclusionType](#type-v1feeinclusiontype) for possible values",
    "type" : "In countries with multiple classifications for sales taxes, indicates which classification the fee falls under. Currently relevant only to Canadian merchants. See [V1FeeType](#type-v1feetype) for possible values",
    "applies_to_custom_amounts" : "If true, the fee applies to custom amounts entered into Square Register that are not associated with a particular item.",
    "enabled" : "If true, the fee is applied to all appropriate items. If false, the fee is not applied at all."
  } ],
  "color" : "The color of the discount's display label in Square Register, if not the default color. The default color is 9da2a6. See [V1ItemColor](#type-v1itemcolor) for possible values",
  "visibility" : "Indicates whether the item is viewable from the merchant's online store (PUBLIC) or PRIVATE. See [V1ItemVisibility](#type-v1itemvisibility) for possible values",
  "taxable" : "Deprecated. This field is not used.",
  "description" : "The item's description.",
  "v2_id" : "The ID of the CatalogObject in the Connect v2 API. Objects that are shared across multiple locations share the same v2 ID.",
  "type" : "The item's type. This value is NORMAL for almost all items.\nSee [V1ItemType](#type-v1itemtype) for possible values",
  "abbreviation" : "The text of the item's display label in Square Register. Only up to the first five characters of the string are used.",
  "modifier_lists" : [ {
    "selection_type" : "Indicates whether MULTIPLE options or a SINGLE option from the modifier list can be applied to a single item. See [V1ModifierListSelectionType](#type-v1modifierlistselectiontype) for possible values",
    "name" : "The modifier list's name.",
    "v2_id" : "The ID of the CatalogObject in the Connect v2 API. Objects that are shared across multiple locations share the same v2 ID.",
    "id" : "The modifier list's unique ID.",
    "modifier_options" : [ {
      "price_money" : {
        "amount" : "Amount in the lowest denominated value of this Currency. E.g. in USD these are cents, in JPY they are Yen (which do not have a 'cent' concept).",
        "currency_code" : "See [Currency](#type-currency) for possible values"
      },
      "on_by_default" : "If true, the modifier option is the default option in a modifier list for which selection_type is SINGLE.",
      "name" : "The modifier option's name.",
      "v2_id" : "The ID of the CatalogObject in the Connect v2 API. Objects that are shared across multiple locations share the same v2 ID.",
      "id" : "The modifier option's unique ID.",
      "modifier_list_id" : "The ID of the modifier list the option belongs to.",
      "ordinal" : "Indicates the modifier option's list position when displayed in Square Register and the merchant dashboard. If more than one modifier option in the same modifier list has the same ordinal value, those options are displayed in alphabetical order."
    } ]
  } ],
  "category_id" : "The ID of the item's category, if any.",
  "variations" : [ {
    "pricing_type" : "Indicates whether the item variation's price is fixed or determined at the time of sale. See [V1VariationPricingType](#type-v1variationpricingtype) for possible values",
    "price_money" : {
      "amount" : "Amount in the lowest denominated value of this Currency. E.g. in USD these are cents, in JPY they are Yen (which do not have a 'cent' concept).",
      "currency_code" : "See [Currency](#type-currency) for possible values"
    },
    "item_id" : "The ID of the variation's associated item.",
    "inventory_alert_threshold" : "If the inventory quantity for the variation is less than or equal to this value and inventory_alert_type is LOW_QUANTITY, the variation displays an alert in the merchant dashboard.",
    "name" : "The item variation's name.",
    "track_inventory" : "If true, inventory tracking is active for the variation.",
    "v2_id" : "The ID of the CatalogObject in the Connect v2 API. Objects that are shared across multiple locations share the same v2 ID.",
    "id" : "The item variation's unique ID.",
    "user_data" : "Arbitrary metadata associated with the variation. Cannot exceed 255 characters.",
    "sku" : "The item variation's SKU, if any.",
    "ordinal" : "Indicates the variation's list position when displayed in Square Register and the merchant dashboard. If more than one variation for the same item has the same ordinal value, those variations are displayed in alphabetical order",
    "inventory_alert_type" : "Indicates whether the item variation displays an alert when its inventory quantity is less than or equal to its inventory_alert_threshold. See [V1VariationInventoryAlertType](#type-v1variationinventoryalerttype) for possible values"
  } ],
  "name" : "The item's name.",
  "id" : "The item's ID. Must be unique among all entity IDs ever provided on behalf of the merchant. You can never reuse an ID. This value can include alphanumeric characters, dashes (-), and underscores (_).",
  "category" : {
    "name" : "The category's name.",
    "v2_id" : "The ID of the CatalogObject in the Connect v2 API. Objects that are shared across multiple locations share the same v2 ID.",
    "id" : "The category's unique ID."
  },
  "available_online" : "If true, the item can be added to shipping orders from the merchant's online store.",
  "available_for_pickup" : "If true, the item can be added to pickup orders from the merchant's online store. Default value: false"
}

update_item_modifier_lists#

Updates the CatalogModifierList objects that apply to the targeted CatalogItem without having to perform an upsert on the entire item.

Parameters

$body#

An object containing the fields to POST for the request.
See the corresponding object definition for field details.

Type: object

{
  "modifier_lists_to_enable" : [ "string" ],
  "item_ids" : [ "string" ],
  "modifier_lists_to_disable" : [ "string" ]
}

update_item_taxes#

Updates the CatalogTax objects that apply to the
targeted CatalogItem without having to perform an
upsert on the entire item.

Parameters

$body#

An object containing the fields to POST for the request.
See the corresponding object definition for field details.

Type: object

{
  "item_ids" : [ "string" ],
  "taxes_to_disable" : [ "string" ],
  "taxes_to_enable" : [ "string" ]
}

update_modifier_list#

Modifies the details of an existing item modifier list.

Parameters

location_id (required)#

The ID of the item's associated location.

Type: string

modifier_list_id (required)#

The ID of the modifier list to edit.

Type: string

$body#

An object containing the fields to POST for the request.
See the corresponding object definition for field details.

Type: object

{
  "selection_type" : "Indicates whether multiple options from the modifier list can be applied to a single item. See [V1UpdateModifierListRequestSelectionType](#type-v1updatemodifierlistrequestselectiontype) for possible values",
  "name" : "The modifier list's name."
}

update_modifier_option#

Type: string

variation_id (required)#

The ID of the variation to modify.

Type: string

$body#

An object containing the fields to POST for the request.
See the corresponding object definition for field details.

Type: object

{
  "pricing_type" : "Indicates whether the item variation's price is fixed or determined at the time of sale. See [V1VariationPricingType](#type-v1variationpricingtype) for possible values",
  "price_money" : {
    "amount" : "Amount in the lowest denominated value of this Currency. E.g. in USD these are cents, in JPY they are Yen (which do not have a 'cent' concept).",
    "currency_code" : "See [Currency](#type-currency) for possible values"
  },
  "item_id" : "The ID of the variation's associated item.",
  "inventory_alert_threshold" : "If the inventory quantity for the variation is less than or equal to this value and inventory_alert_type is LOW_QUANTITY, the variation displays an alert in the merchant dashboard.",
  "name" : "The item variation's name.",
  "track_inventory" : "If true, inventory tracking is active for the variation.",
  "v2_id" : "The ID of the CatalogObject in the Connect v2 API. Objects that are shared across multiple locations share the same v2 ID.",
  "id" : "The item variation's unique ID.",
  "user_data" : "Arbitrary metadata associated with the variation. Cannot exceed 255 characters.",
  "sku" : "The item variation's SKU, if any.",
  "ordinal" : "Indicates the variation's list position when displayed in Square Register and the merchant dashboard. If more than one variation for the same item has the same ordinal value, those variations are displayed in alphabetical order",
  "inventory_alert_type" : "Indicates whether the item variation displays an alert when its inventory quantity is less than or equal to its inventory_alert_threshold. See [V1VariationInventoryAlertType](#type-v1variationinventoryalerttype) for possible values"
}

update_workweek_config#

Type: string

$body#

An object containing the fields to POST for the request.
See the corresponding object definition for field details.

Type: object

{
  "reason" : "The reason for the refund.",
  "request_idempotence_key" : "An optional key to ensure idempotence if you issue the same PARTIAL refund request more than once.",
  "payment_id" : "The ID of the payment to refund. If you are creating a `PARTIAL`\nrefund for a split tender payment, instead provide the id of the\nparticular tender you want to refund.",
  "refunded_money" : {
    "amount" : "Amount in the lowest denominated value of this Currency. E.g. in USD these are cents, in JPY they are Yen (which do not have a 'cent' concept).",
    "currency_code" : "See [Currency](#type-currency) for possible values"
  },
  "type" : "TThe type of refund (FULL or PARTIAL). See [V1CreateRefundRequestType](#type-v1createrefundrequesttype) for possible values"
}

v1_list_locations#

This operation has no parameters

v1_list_payments#

Provides summary information for all payments taken for a given
Square account during a date range. Date ranges cannot exceed 1 year in
length. See Date ranges for details of inclusive and exclusive dates.
Note*: Details for payments processed with Square Point of Sale while
in offline mode may not be transmitted to Square for up to 72 hours.
Offline payments have a created_at value that reflects the time the
payment was originally processed, not the time it was subsequently
transmitted to Square. Consequently, the ListPayments endpoint might
list an offline payment chronologically between online payments that
were seen in a previous request.

Parameters

location_id (required)#

The ID of the location to list payments for. If you specify me, this endpoint returns payments aggregated from all of the business's locations.

Type: string

batch_token#

A pagination cursor to retrieve the next set of results for your
original query to the endpoint.

Type: string

Type: string

$body#

An object containing the fields to POST for the request.
See the corresponding object definition for field details.

Type: object

{
  "completed_note" : "A merchant-specified note about the completion of the order. Only valid if action is COMPLETE.",
  "canceled_note" : "A merchant-specified note about the canceling of the order. Only valid if action is CANCEL.",
  "shipped_tracking_number" : "The tracking number of the shipment associated with the order. Only valid if action is COMPLETE.",
  "action" : "The action to perform on the order (COMPLETE, CANCEL, or REFUND). See [V1UpdateOrderRequestAction](#type-v1updateorderrequestaction) for possible values",
  "refunded_note" : "A merchant-specified note about the refunding of the order. Only valid if action is REFUND."
}