Change Log

  • 19-Jun-2024 | v7.0.0 | All new article

Contributors:

Adam Wilson - Logo Pogo

Module Item Prices API

Create, Retrieve, Update and Delete a Module Item's Prices via the public API endpoint.

GET Module Item Prices List

Retrieves a list of Prices as a JSON response based on your provided query parameters.

/api/v2/admin/module-items/{moduleItemId}/prices

Data / Response:

N/A

{
  "Items": [
    {
      "Id": 0,
      "CurrencyCountry": "string",
      "Currency": "string",
      "Country": "string",
      "CustomerTypeId": 0,
      "TaxId": 0,
      "RecommendedPrice": 0,
      "SellPrice": 0,
      "EnableVolumeDiscount": true,
      "TaxNeverApplies": true,
      "PriceQuantityDiscounts": [
        {
          "MinQuantity": 0,
          "Value": 0
        }
      ]
    }
  ],
  "TotalItemsCount": 0
}

POST Module Item Price Create

Creates a new Price based on the provided data.

/api/v2/admin/module-items/{moduleItemId}/prices

Data / Response:

[
  {
    "CustomerTypeId": 0,
    "TaxId": 0,
    "RecommendedPrice": 0,
    "SellPrice": 0,
    "EnableVolumeDiscount": true,
    "TaxNeverApplies": true,
    "PriceQuantityDiscounts": [
      {
        "MinQuantity": 0,
        "Value": 0
      }
    ]
  }
]

{
  "Items": [
    {
      "Id": 0,
      "CurrencyCountry": "string",
      "Currency": "string",
      "Country": "string",
      "CustomerTypeId": 0,
      "TaxId": 0,
      "RecommendedPrice": 0,
      "SellPrice": 0,
      "EnableVolumeDiscount": true,
      "TaxNeverApplies": true,
      "PriceQuantityDiscounts": [
        {
          "MinQuantity": 0,
          "Value": 0
        }
      ]
    }
  ],
  "TotalItemsCount": 0
}

GET Module Item Price Item

Retrieves a single Price based on the ID passed in the endpoint URL.

/api/v2/admin/module-items/prices/{id}

Data / Response:

N/A

{
  "Id": 0,
  "CurrencyCountry": "string",
  "Currency": "string",
  "Country": "string",
  "CustomerTypeId": 0,
  "TaxId": 0,
  "RecommendedPrice": 0,
  "SellPrice": 0,
  "EnableVolumeDiscount": true,
  "TaxNeverApplies": true,
  "PriceQuantityDiscounts": [
    {
      "MinQuantity": 0,
      "Value": 0
    }
  ]
}

PUT Module Item Price Update

Updates a single Price based on the ID passed in the endpoint URL and data provided.

/api/v2/admin/module-items/{moduleItemId}/prices

Data / Response:

[
  {
    "Id": 0,
    "CustomerTypeId": 0,
    "TaxId": 0,
    "RecommendedPrice": 0,
    "SellPrice": 0,
    "EnableVolumeDiscount": true,
    "TaxNeverApplies": true,
    "PriceQuantityDiscounts": [
      {
        "MinQuantity": 0,
        "Value": 0
      }
    ]
  }
]

{
  "Items": [
    {
      "Id": 0,
      "CurrencyCountry": "string",
      "Currency": "string",
      "Country": "string",
      "CustomerTypeId": 0,
      "TaxId": 0,
      "RecommendedPrice": 0,
      "SellPrice": 0,
      "EnableVolumeDiscount": true,
      "TaxNeverApplies": true,
      "PriceQuantityDiscounts": [
        {
          "MinQuantity": 0,
          "Value": 0
        }
      ]
    }
  ],
  "TotalItemsCount": 0
}

DELETE Module Item Price Delete

Deletes a single Price based on the ID passed in the endpoint URL.

/api/v2/admin/module-items/prices

Data / Response:

[
  0
]

Status 204