Modifiers

Lists all modifiers

get

Authorizations

api-key

api-keystringRequired

API Key

Header parameters

organization-idstringRequired

Organization ID

Responses

200Success

application/json

get

/v1/core/modifiers

HTTPcURLJavaScriptPython

GET /v1/core/modifiers HTTP/1.1
Host: 
api-key: YOUR_API_KEY
organization-id: text
Accept: */*

200Success

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "items": [
      {
        "locales": {
          "ar": {
            "name": "text",
            "description": "text"
          },
          "en": {
            "name": "text",
            "description": "text"
          }
        },
        "minSelection": 1,
        "maxSelection": 1,
        "createdAt": "text",
        "createdVia": "text",
        "createdBy": "text",
        "updatedAt": "text",
        "updatedVia": "text",
        "updatedBy": "text",
        "uid": "text",
        "id": "text",
        "options": [
          {
            "uid": "text",
            "id": "text",
            "locales": {
              "ar": {
                "name": "text",
                "description": "text"
              },
              "en": {
                "name": "text",
                "description": "text"
              }
            },
            "price": 1,
            "isActive": true,
            "sortNumber": 1,
            "multiple": true,
            "createdAt": "text",
            "createdVia": "text",
            "createdBy": "text",
            "updatedAt": "text",
            "updatedVia": "text",
            "updatedBy": "text",
            "uomAssignmentUid": "text",
            "uomUid": "text",
            "productUid": "text"
          }
        ]
      }
    ]
  }
}

Creates a new modifier

post

Authorizations

api-key

api-keystringRequired

API Key

Header parameters

organization-idstringRequired

Organization ID

Body

application/json

Responses

200Success

application/json

post

/v1/core/modifiers

HTTPcURLJavaScriptPython

POST /v1/core/modifiers HTTP/1.1
Host: 
api-key: YOUR_API_KEY
organization-id: text
Content-Type: application/json
Accept: */*
Content-Length: 142

{
  "params": {
    "locales": {
      "ar": {
        "name": "text",
        "description": "text"
      },
      "en": {
        "name": "text",
        "description": "text"
      }
    },
    "minSelection": 1,
    "maxSelection": 1
  }
}

200Success

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "item": {
      "locales": {
        "ar": {
          "name": "text",
          "description": "text"
        },
        "en": {
          "name": "text",
          "description": "text"
        }
      },
      "minSelection": 1,
      "maxSelection": 1,
      "createdAt": "text",
      "createdVia": "text",
      "createdBy": "text",
      "updatedAt": "text",
      "updatedVia": "text",
      "updatedBy": "text",
      "uid": "text",
      "id": "text",
      "options": [
        {
          "uid": "text",
          "id": "text",
          "locales": {
            "ar": {
              "name": "text",
              "description": "text"
            },
            "en": {
              "name": "text",
              "description": "text"
            }
          },
          "price": 1,
          "isActive": true,
          "sortNumber": 1,
          "multiple": true,
          "createdAt": "text",
          "createdVia": "text",
          "createdBy": "text",
          "updatedAt": "text",
          "updatedVia": "text",
          "updatedBy": "text",
          "uomAssignmentUid": "text",
          "uomUid": "text",
          "productUid": "text"
        }
      ]
    }
  }
}

Returns a modifier

get

Authorizations

api-key

api-keystringRequired

API Key

Path parameters

uidstringRequired

Header parameters

organization-idstringRequired

Organization ID

Responses

200Success

application/json

400

Functional Error

application/json

get

/v1/core/modifiers/{uid}

HTTPcURLJavaScriptPython

GET /v1/core/modifiers/{uid} HTTP/1.1
Host: 
api-key: YOUR_API_KEY
organization-id: text
Accept: */*

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "item": {
      "locales": {
        "ar": {
          "name": "text",
          "description": "text"
        },
        "en": {
          "name": "text",
          "description": "text"
        }
      },
      "minSelection": 1,
      "maxSelection": 1,
      "createdAt": "text",
      "createdVia": "text",
      "createdBy": "text",
      "updatedAt": "text",
      "updatedVia": "text",
      "updatedBy": "text",
      "uid": "text",
      "id": "text",
      "options": [
        {
          "uid": "text",
          "id": "text",
          "locales": {
            "ar": {
              "name": "text",
              "description": "text"
            },
            "en": {
              "name": "text",
              "description": "text"
            }
          },
          "price": 1,
          "isActive": true,
          "sortNumber": 1,
          "multiple": true,
          "createdAt": "text",
          "createdVia": "text",
          "createdBy": "text",
          "updatedAt": "text",
          "updatedVia": "text",
          "updatedBy": "text",
          "uomAssignmentUid": "text",
          "uomUid": "text",
          "productUid": "text"
        }
      ]
    },
    "options": [
      {
        "uid": "text",
        "id": "text",
        "locales": {
          "ar": {
            "name": "text",
            "description": "text"
          },
          "en": {
            "name": "text",
            "description": "text"
          }
        },
        "price": 1,
        "isActive": true,
        "sortNumber": 1,
        "multiple": true,
        "createdAt": "text",
        "createdVia": "text",
        "createdBy": "text",
        "updatedAt": "text",
        "updatedVia": "text",
        "updatedBy": "text",
        "uomAssignmentUid": "text",
        "uomUid": "text",
        "productUid": "text"
      }
    ]
  }
}

Deletes a modifier

delete

Authorizations

api-key

api-keystringRequired

API Key

Path parameters

uidstringRequired

Header parameters

organization-idstringRequired

Organization ID

Responses

200Success

application/json

delete

/v1/core/modifiers/{uid}

HTTPcURLJavaScriptPython

DELETE /v1/core/modifiers/{uid} HTTP/1.1
Host: 
api-key: YOUR_API_KEY
organization-id: text
Accept: */*

200Success

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "succeed": true
  }
}

Updates a modifier

patch

Authorizations

api-key

api-keystringRequired

API Key

Path parameters

uidstringRequired

Header parameters

organization-idstringRequired

Organization ID

Body

application/json

Responses

200Success

application/json

400

Functional Error

application/json

patch

/v1/core/modifiers/{uid}

HTTPcURLJavaScriptPython

PATCH /v1/core/modifiers/{uid} HTTP/1.1
Host: 
api-key: YOUR_API_KEY
organization-id: text
Content-Type: application/json
Accept: */*
Content-Length: 71

{
  "params": {
    "id": "text",
    "locales": {},
    "minSelection": 1,
    "maxSelection": 1
  }
}

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "item": {
      "locales": {
        "ar": {
          "name": "text",
          "description": "text"
        },
        "en": {
          "name": "text",
          "description": "text"
        }
      },
      "minSelection": 1,
      "maxSelection": 1,
      "createdAt": "text",
      "createdVia": "text",
      "createdBy": "text",
      "updatedAt": "text",
      "updatedVia": "text",
      "updatedBy": "text",
      "uid": "text",
      "id": "text",
      "options": [
        {
          "uid": "text",
          "id": "text",
          "locales": {
            "ar": {
              "name": "text",
              "description": "text"
            },
            "en": {
              "name": "text",
              "description": "text"
            }
          },
          "price": 1,
          "isActive": true,
          "sortNumber": 1,
          "multiple": true,
          "createdAt": "text",
          "createdVia": "text",
          "createdBy": "text",
          "updatedAt": "text",
          "updatedVia": "text",
          "updatedBy": "text",
          "uomAssignmentUid": "text",
          "uomUid": "text",
          "productUid": "text"
        }
      ]
    }
  }
}

Exports all modifiers with support for incremental fetching.

get

Authorizations

api-key

api-keystringRequired

API Key

Query parameters

updatedSincestringOptional

offsetstringOptional

Header parameters

organization-idstringRequired

Organization ID

Responses

200Success

application/json

get

/v1/core/modifiers/export

HTTPcURLJavaScriptPython

GET /v1/core/modifiers/export HTTP/1.1
Host: 
api-key: YOUR_API_KEY
organization-id: text
Accept: */*

200Success

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "items": [
      {
        "locales": {
          "ar": {
            "name": "text",
            "description": "text"
          },
          "en": {
            "name": "text",
            "description": "text"
          }
        },
        "minSelection": 1,
        "maxSelection": 1,
        "createdAt": "text",
        "createdVia": "text",
        "createdBy": "text",
        "updatedAt": "text",
        "updatedVia": "text",
        "updatedBy": "text",
        "uid": "text",
        "id": "text",
        "options": [
          {
            "uid": "text",
            "id": "text",
            "locales": {
              "ar": {
                "name": "text",
                "description": "text"
              },
              "en": {
                "name": "text",
                "description": "text"
              }
            },
            "price": 1,
            "isActive": true,
            "sortNumber": 1,
            "multiple": true,
            "createdAt": "text",
            "createdVia": "text",
            "createdBy": "text",
            "updatedAt": "text",
            "updatedVia": "text",
            "updatedBy": "text",
            "uomAssignmentUid": "text",
            "uomUid": "text",
            "productUid": "text"
          }
        ]
      }
    ],
    "next": "text"
  }
}

Creates a new modifier option

post

Authorizations

api-key

api-keystringRequired

API Key

Header parameters

organization-idstringRequired

Organization ID

Body

application/json

Responses

200Success

application/json

post

/v1/core/modifier-options

HTTPcURLJavaScriptPython

POST /v1/core/modifier-options HTTP/1.1
Host: 
api-key: YOUR_API_KEY
organization-id: text
Content-Type: application/json
Accept: */*
Content-Length: 221

{
  "params": {
    "modifierId": "text",
    "locales": {
      "ar": {
        "name": "text",
        "description": "text"
      },
      "en": {
        "name": "text",
        "description": "text"
      }
    },
    "price": 1,
    "isActive": true,
    "sortNumber": 1,
    "multiple": true,
    "productUid": "text",
    "uomUid": "text"
  }
}

200Success

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "item": {
      "uid": "text",
      "id": "text",
      "locales": {
        "ar": {
          "name": "text",
          "description": "text"
        },
        "en": {
          "name": "text",
          "description": "text"
        }
      },
      "price": 1,
      "isActive": true,
      "sortNumber": 1,
      "multiple": true,
      "createdAt": "text",
      "createdVia": "text",
      "createdBy": "text",
      "updatedAt": "text",
      "updatedVia": "text",
      "updatedBy": "text",
      "uomAssignmentUid": "text",
      "uomUid": "text",
      "productUid": "text"
    }
  }
}

Deletes a modifier option

delete

Authorizations

api-key

api-keystringRequired

API Key

Path parameters

modifierIdstringRequired

idstringRequired

Header parameters

organization-idstringRequired

Organization ID

Responses

200Success

application/json

delete

/v1/core/modifier-options/{modifierId}/{id}

HTTPcURLJavaScriptPython

DELETE /v1/core/modifier-options/{modifierId}/{id} HTTP/1.1
Host: 
api-key: YOUR_API_KEY
organization-id: text
Accept: */*

200Success

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "succeed": true
  }
}

Updates a modifier option

patch

Authorizations

api-key

api-keystringRequired

API Key

Path parameters

modifierIdstringRequired

idstringRequired

Header parameters

organization-idstringRequired

Organization ID

Body

application/json

Responses

200Success

application/json

400

Functional Error

application/json

patch

/v1/core/modifier-options/{modifierId}/{id}

HTTPcURLJavaScriptPython

PATCH /v1/core/modifier-options/{modifierId}/{id} HTTP/1.1
Host: 
api-key: YOUR_API_KEY
organization-id: text
Content-Type: application/json
Accept: */*
Content-Length: 160

{
  "params": {
    "modifierId": "text",
    "id": "text",
    "locales": {},
    "price": 1,
    "isActive": true,
    "sortNumber": 1,
    "multiple": true,
    "productUid": "text",
    "uomAssignmentUid": "text"
  }
}

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "item": {
      "uid": "text",
      "id": "text",
      "locales": {
        "ar": {
          "name": "text",
          "description": "text"
        },
        "en": {
          "name": "text",
          "description": "text"
        }
      },
      "price": 1,
      "isActive": true,
      "sortNumber": 1,
      "multiple": true,
      "createdAt": "text",
      "createdVia": "text",
      "createdBy": "text",
      "updatedAt": "text",
      "updatedVia": "text",
      "updatedBy": "text",
      "uomAssignmentUid": "text",
      "uomUid": "text",
      "productUid": "text"
    }
  }
}