Jump to

• Request
• Response

Get a Product Family Menu Item Price Definition

get

/rest/v16/allProductFamilySetups/{varName}/productFamilies/{prodFamVarName}/attributes/{attributeVarName}/menuItems/{menuItem_Id}/prices/{price_Id}

Use this endpoint to retrieve a definition for the specified Product Family attribute menu item price.

Request

Supported Media Types

• application/json

Path Parameters

• attributeVarName(required): string
  Variable Name of the Attribute
• menuItem_Id(required): integer
  Primary Key of the Resource
• price_Id(required): integer
  Primary Key of the Resource
• prodFamVarName(required): string
  Variable Name of the Product Family.
• varName(required): string
  Variable Name of All Product Families '_allProductFamilies'

Back to Top

Response

Supported Media Types

• application/json

Default Response

Body ()

Root Schema : Config Menu Item Prices

Type: object

Title: Config Menu Item Prices

Show Source

• dateAdded: string
  Title: Date Added

  System field indicating the date on which the Resource was created.
• dateModified: string
  Title: Date Modified

  System field indicating the date on which the Resource was last modified.
• id: integer
  Title: Id

  Primary Key of the Resource
• price: object Price
  Title: Price

  Price

{
    "type":"object",
    "properties":{
        "dateAdded":{
            "type":"string",
            "description":"System field indicating the date on which the Resource was created.",
            "title":"Date Added"
        },
        "dateModified":{
            "type":"string",
            "description":"System field indicating the date on which the Resource was last modified.",
            "title":"Date Modified"
        },
        "id":{
            "type":"integer",
            "description":"Primary Key of the Resource",
            "title":"Id"
        },
        "price":{
            "type":"object",
            "description":"Price",
            "title":"Price",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        }
    },
    "title":"Config Menu Item Prices"
}

Nested Schema : Price

Type: object

Title: Price

Price

Show Source

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"Price",
    "title":"Price",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

Back to Top