List sale offers

get /api/sale_offers

Retrieves the collection of Sale Offer resources.

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

Query parameters

Name	Type	Required	Description
expand	string	-	Comma-separated list of relations to embed as full objects instead of IRI strings. Supported values: tax, channels, variant, country, product, medias. Tokens are independent; unknown values are silently ignored. product and medias embed the full Product object and the full Media objects on the embedded variant. Must be combined with variant to take visible effect.
page	integer	-	The collection page number
itemsPerPage	integer	-	The number of items per page
properties[]	string[]	-	Allows you to reduce the response to contain only the properties you need. If your desired property is nested, you can address it using nested arrays. Example: properties[]={propertyName}&properties[]={anotherPropertyName}&properties[{nestedPropertyParent}][]={nestedProperty}
id[]	string[]	-	Only the items with one of these ids, each a UUID or the item IRI.
variant	string	-	Filter by the related "variant", given as an IRI or as an identifier.
variant[]	string[]	-	Filter by the related "variant", given as an IRI or as an identifier.
tax	string	-	Filter by the related "tax", given as an IRI or as an identifier.
tax[]	string[]	-	Filter by the related "tax", given as an IRI or as an identifier.
country	string	-	Filter by the related "country", given as an IRI or as an identifier.
country[]	string[]	-	Filter by the related "country", given as an IRI or as an identifier.
channels	string	-	Filter by the related "channels", given as an IRI or as an identifier.
channels[]	string[]	-	Filter by the related "channels", given as an IRI or as an identifier.
status	string	-	Sale Offer status
status[]	string[]	-	Sale Offer status
startsAt[after]	string	-	Sale Offer startsAt
startsAt[before]	string	-	Sale Offer startsAt
startsAt[strictly_after]	string	-	Sale Offer startsAt
startsAt[strictly_before]	string	-	Sale Offer startsAt
endsAt[after]	string	-	Sale Offer endsAt
endsAt[before]	string	-	Sale Offer endsAt
endsAt[strictly_after]	string	-	Sale Offer endsAt
endsAt[strictly_before]	string	-	Sale Offer endsAt
createdAt[after]	string	-	Sale Offer createdAt
createdAt[before]	string	-	Sale Offer createdAt
createdAt[strictly_after]	string	-	Sale Offer createdAt
createdAt[strictly_before]	string	-	Sale Offer createdAt
updatedAt[after]	string	-	Sale Offer updatedAt
updatedAt[before]	string	-	Sale Offer updatedAt
updatedAt[strictly_after]	string	-	Sale Offer updatedAt
updatedAt[strictly_before]	string	-	Sale Offer updatedAt
order[taxExcludedPrice]	string	-	Order by "taxExcludedPrice" (compares raw amounts in minor units)
order[price]	string	-	Order by "price" (compares raw amounts in minor units)
taxExcludedPrice[gte]	string	-	Filter "taxExcludedPrice" gte a bound, as a decimal amount in major units ("12.00") - the same form the taxExcludedPrice.amount field is returned in.
taxExcludedPrice[gt]	string	-	Filter "taxExcludedPrice" gt a bound, as a decimal amount in major units ("12.00") - the same form the taxExcludedPrice.amount field is returned in.
taxExcludedPrice[lte]	string	-	Filter "taxExcludedPrice" lte a bound, as a decimal amount in major units ("12.00") - the same form the taxExcludedPrice.amount field is returned in.
taxExcludedPrice[lt]	string	-	Filter "taxExcludedPrice" lt a bound, as a decimal amount in major units ("12.00") - the same form the taxExcludedPrice.amount field is returned in.
price[gte]	string	-	Filter "price" gte a bound, as a decimal amount in major units ("12.00") - the same form the price.amount field is returned in.
price[gt]	string	-	Filter "price" gt a bound, as a decimal amount in major units ("12.00") - the same form the price.amount field is returned in.
price[lte]	string	-	Filter "price" lte a bound, as a decimal amount in major units ("12.00") - the same form the price.amount field is returned in.
price[lt]	string	-	Filter "price" lt a bound, as a decimal amount in major units ("12.00") - the same form the price.amount field is returned in.
order[tax.name]	string	-	Order by translated field "tax.name" (uses the Flowkiwi-Locale header)
order[status]	string	-	Sale Offer order[status]
order[startsAt]	string	-	Sale Offer order[startsAt]
order[endsAt]	string	-	Sale Offer order[endsAt]
order[createdAt]	string	-	Sale Offer order[createdAt]
order[updatedAt]	string	-	Sale Offer order[updatedAt]

Response

200 - Sale Offer collection

Property	Type	Required	Description
search	object	-
Show search fields Property Type Required Description @type string - mapping object[] - Show mapping fields Property Type Required Description @type string - property string | null - required boolean - variable string - template string - variableRepresentation string -
totalItems	integer	-
view	object	-
Show view fields Property Type Required Description @id string - @type string - first string | null - last string | null - next string | null - previous string | null -
member	Sale.Offer[]	required
Show member fields Property Type Required Description @context string | object - @id string required @type string required channels array - A list of Channel IRIs the sale offer is distributed through. Requires the channels:read scope. Returned empty when the scope is missing. country string | Country | null required The country resource it belongs to. Requires the instance_params:read scope. Returned null when the scope is missing. createdAt string - The date and time when the resource was created (ISO 8601 format). 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. endsAt string | null - End date of the offer. id string - The unique identifier of the sale offer. 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. startsAt string - Start date of the offer. Defaults to the current date/time if not provided. status "/api/statuses/DRAFT" | "/api/statuses/ACTIVE" | "/api/statuses/ARCHIVED" - The status of the offer. tax string | Tax | null required The tax resource it belongs to. Requires the instance_params:read scope. Returned null when the scope is missing. 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. updatedAt string - The date and time when the resource was last modified (ISO 8601 format). variant string | Product.Variant | null required The variant resource it belongs to. Requires the products:read scope. Returned null when the scope is missing.

Errors

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

Content-Type: application/problem+json

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