Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-134699335.3 KB
Modifier Groups

Create Modifier Group

Create Modifier Group

post/pos/modifier-groups

Query parameters

rawboolean

Include raw response. Mostly used for debugging purposes

Headers

x-apideck-consumer-idstring required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring required

The ID of your Unify application

x-apideck-service-idstring

Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.

Request body

idstring

A unique identifier for an object.

namestring
alternate_namestring
minimum_requiredinteger
maximum_allowedinteger
selection_type'single' | 'multiple'
present_at_all_locationsboolean
deletedboolean nullable

Flag to indicate if the object is deleted.

custom_mappingsCustomMappings nullable

When custom mappings are configured on the resource, the result is included here.

row_versionstring nullable

A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.

updated_bystring nullable

The user who last updated the object.

created_bystring nullable

The user who created the object.

updated_atstring date-time nullable

The date and time when the object was last updated.

created_atstring date-time nullable

The date and time when the object was created.

Example request

{
  "id": "12345",
  "name": "Modifier",
  "alternate_name": "Modifier New",
  "minimum_required": 1,
  "maximum_allowed": 5,
  "selection_type": "single",
  "modifiers": [
    {
      "id": "12345",
      "name": "Modifier",
      "alternate_name": "Modifier New",
      "price_amount": 10,
      "currency": "USD",
      "available": true
    }
  ],
  "deleted": true,
  "row_version": "1-12345",
  "updated_by": "12345",
  "created_by": "12345",
  "updated_at": "2020-09-30T07:43:32.000Z",
  "created_at": "2020-09-30T07:43:32.000Z",
  "pass_through": [
    {
      "extend_paths": [
        {
          "path": "$.nested.property",
          "value": {
            "TaxClassificationRef": {
              "value": "EUC-99990201-V1-00020000"
            }
          }
        }
      ]
    }
  ]
}

Response

ModifierGroups

status_codeinteger required

HTTP Response Status Code

statusstring required

HTTP Response Status

servicestring required

Apideck ID of service provider

resourcestring required

Unified API resource name

operationstring required

Operation performed

_rawRaw nullable

Raw response from the integration when raw=true query param is provided

Example response

{
  "status_code": 200,
  "status": "OK",
  "service": "square",
  "resource": "ModifierGroups",
  "operation": "add",
  "data": {
    "id": "12345"
  }
}