Query parameters

• businessLocationId integer(int64) Required

  The unique identifier for the business location.

• sku string

  A stock keeping unit.

  Minimum length is 1, maximum length is 32.

• name string

  The name of the item.

  Minimum length is 1, maximum length is 180.

• accountingGroupId integer(int64)

  The unique identifier for the accounting group.

• offset integer(int64)

  Offset allows you to retrieve a subset of records starting from a specified position in the dataset. Offset normally works with amount, which designates how many records to retrieve, starting from the offset position.

  Default value is 0.

• amount integer(int64)

  The number of results to return with each request.

  Maximum value is 100. Default value is 100.

Responses

• 200 application/json

  Item found

  Hide response attributes Show response attributes object

  • id integer(int64)

    The unique identifier for the item.

  • name string

    The name of the item.

  • docketName string

    The name used in the docket for the item.

    Maximum length is 64.

  • sku string

    A stock keeping unit.

    Minimum length is 1, maximum length is 32.

  • active boolean

    Indicates whether or not the item is archived from the menu.

  • barcode string

    The item barcode.

  • barcodes array[string]

    A list of barcodes associated with the item.

  • accountingGroup object

    The accounting group associated with the item.

    Additional properties are allowed.

    Hide accountingGroup attributes Show accountingGroup attributes object

    • id integer(int64)

      The unique identifier for the accounting group.

    • name string

      The name of the accounting group.

  • statisticGroups array[object]

    List of statistic groups associated with the item.

    Hide statisticGroups attributes Show statisticGroups attributes object

    • category string

      The name of the statistic group category.

    • value string

      The statistic group value.

  • costPrice number

    The cost price of the item.

  • prices array[object]

    List of prices associated with the item.

    Hide prices attributes Show prices attributes object

    • amount number

      The item price.

    • name string

      The name for this item price.

  • sharingType string

    How the item is shared.

    Values are GLOBAL_NO_BL, GLOBAL, LOCAL, or SHARED.

  • priceMode string

    The type of price for the item.

    Values are AMOUNT, PERCENT, POSITIVE_OPEN_PRICE, or NEGATIVE_OPEN_PRICE. Default value is AMOUNT.

  • inventorySource string

    Source of inventory for the item.

    Values are PURCHASED or PRODUCED.

  • disabled boolean

    Whether or not stock management is disabled for the item.

  • contentDimension string

    How the item is measured for stock management.

    Values are DIMENSION_LESS, VOLUME, or MASS.

  • contentUom string

    The unit of measure of the item for stock management.

  • contentValue number

    The measurement value.

  • itemType string

    Type of the item.

    Values are ITEM, SEQUENCE, GROUP, or SUB_ITEM.

• 400 */*

  Constraint violation

  Hide response attributes Show response attributes object

  • status string

    Value is 400.

  • timestamp string(date-time)
  • message string
  • apiSubExceptions array[object]
    Hide apiSubExceptions attributes Show apiSubExceptions attributes object

    • field string
    • rejectedValue string
    • message string
• 404 */*

  Not Found

  Hide response attributes Show response attributes object

  • status string

    Value is 404.

  • timestamp string(date-time)
  • message string
  • apiSubExceptions array[object]
    Hide apiSubExceptions attributes Show apiSubExceptions attributes object

    • field string
    • rejectedValue string
    • message string