CLclover
INVENTORY

Get all discounts

Retrieves all discounts associated with an inventory item.

get/v3/merchants/{mId}/discounts

Request

  • Base URL
    https://apisandbox.dev.clover.com
  • URL
    https://apisandbox.dev.clover.com/v3/merchants/{mId}/discounts
  • Auth
    HTTP bearer

Path parameters

mIdstring required

Merchant identifier.

Query parameters

filterstring

Filter fields to display search results: [amount, modifiedtime, percentage, id]

offsetinteger

Position of the first line item returned in the search results. Indicates the number of line items that are excluded from the search results.

limitinteger

Maximum number of line items returned in the search result. Default: 100 Maximum limit: 1000

Headers

User-Agentstring required

Identifies the application, operating system, vendor, and/or version of the requesting user agent. Format: <product> / <product-version> <comment>

Response

Successful response. Displays all discounts associated with an inventory item.

idstring

Unique identifier.

namestring required

Discount name.

amountinteger

Discount amount in fraction of the currency unit, such as Cents, based on currency fraction digits supported.

percentageinteger

Discount amount in percent.

Changes

No recorded changes to this operation across all 2 revisions of this API.