List sale offers

get /rest/api/sale_offers

Retrieves the collection of Sale Offer resources.

Returns a paginated collection of sale offers in the current organization.

Headers

Name	Type	Required	Description
X-Flowkiwi-Organization-Id	string	required	The organization the request acts as. Determines the identity, permissions and ownership applied when reading or modifying data on the instance.

Query parameters

Name	Type	Required	Description
page	integer	-	The collection page number
itemsPerPage	integer	-	The number of items per page

Response

200 - Sale Offer collection

Property	Type	Required	Description
hydra:totalItems	integer	-
hydra:search	object	-
Show hydra:search fields Property Type Required Description @type string - hydra:template string - hydra:variableRepresentation string - hydra:mapping object[] - Show hydra:mapping fields Property Type Required Description @type string - variable string - property string | null - required boolean -
hydra:view	object	-
Show hydra:view fields Property Type Required Description @id string - @type string - hydra:first string - hydra:last string - hydra:previous string - hydra:next string -
hydra:member	Sale.Offer[]	required
Show hydra:member fields Property Type Required Description @context object - @id string required @type string required id string - The unique identifier of the sale offer. status string - The status of the offer. taxExcludedPrice EmbeddedMoneyResource required The price set for the offer, excluding tax. Show taxExcludedPrice fields Property Type Required Description amount string required The monetary amount, as a decimal string. currency string required The ISO 4217 currency code (e.g. EUR). taxExcludedPricePerUnit EmbeddedPricePerUnitResource | null - The tax-excluded price expressed per measurement reference unit. Show taxExcludedPricePerUnit fields Property Type Required Description amount string required The monetary amount, as a decimal string. currency string required The ISO 4217 currency code (e.g. EUR). unit "ml" | "cl" | "l" | "mg" | "g" | "kg" | "mm" | "cm" | "m" | "m2" | "unit" required The reference unit the amount is expressed per. value integer required The number of reference units the amount applies to. price EmbeddedMoneyResource - The tax-included price, computed from taxExcludedPrice and the referenced Tax rate. Show price fields Property Type Required Description amount string required The monetary amount, as a decimal string. currency string required The ISO 4217 currency code (e.g. EUR). pricePerUnit EmbeddedPricePerUnitResource | null - The tax-included price expressed per measurement reference unit. Show pricePerUnit fields Property Type Required Description amount string required The monetary amount, as a decimal string. currency string required The ISO 4217 currency code (e.g. EUR). unit "ml" | "cl" | "l" | "mg" | "g" | "kg" | "mm" | "cm" | "m" | "m2" | "unit" required The reference unit the amount is expressed per. value integer required The number of reference units the amount applies to. discountPrice EmbeddedMoneyResource | null - The discounted tax-included price, when a discount applies. Show discountPrice fields Property Type Required Description amount string required The monetary amount, as a decimal string. currency string required The ISO 4217 currency code (e.g. EUR). discountPricePerUnit EmbeddedPricePerUnitResource | null - The discounted tax-included price per measurement reference unit, when a discount applies. Show discountPricePerUnit fields Property Type Required Description amount string required The monetary amount, as a decimal string. currency string required The ISO 4217 currency code (e.g. EUR). unit "ml" | "cl" | "l" | "mg" | "g" | "kg" | "mm" | "cm" | "m" | "m2" | "unit" required The reference unit the amount is expressed per. value integer required The number of reference units the amount applies to. discountTaxExcludedPrice EmbeddedMoneyResource | null - The discounted tax-excluded price, when a discount applies. Show discountTaxExcludedPrice fields Property Type Required Description amount string required The monetary amount, as a decimal string. currency string required The ISO 4217 currency code (e.g. EUR). discountTaxExcludedPricePerUnit EmbeddedPricePerUnitResource | null - The discounted tax-excluded price per measurement reference unit, when a discount applies. Show discountTaxExcludedPricePerUnit fields Property Type Required Description amount string required The monetary amount, as a decimal string. currency string required The ISO 4217 currency code (e.g. EUR). unit "ml" | "cl" | "l" | "mg" | "g" | "kg" | "mm" | "cm" | "m" | "m2" | "unit" required The reference unit the amount is expressed per. value integer required The number of reference units the amount applies to. startsAt string - Start date of the offer. Defaults to the current date/time if not provided. endsAt string | null - End date of the offer. country string required The country resource it belongs to. tax string required The tax resource it belongs to. variant string required The variant resource it belongs to. channels string[] - A list of Channel IRIs the sale offer is distributed through. createdAt string - The date and time when the resource was created (ISO 8601 format). updatedAt string - The date and time when the resource was last modified (ISO 8601 format).

Errors

403 - Access denied. The caller is missing one or more identity permissions required for this operation.

Content-Type: application/problem+json

Property	Type	Required	Description
@context	object	-
@id	string	required
@type	string	required
type	string	-
title	string	-
status	integer	-
detail	string	-
missingPermissions	string[]	-	Identity permissions that the caller is missing for this operation. Present only when the 403 is caused by a denied identity:* permission.