Retrieve a sale offer

get /api/sale_offers/{id}

Retrieves a Sale Offer resource.

Returns a single sale offer by id, including its prices, validity period, and the variant, country, tax and channels it applies to.

Path parameters

Name	Type	Required	Description
id	string	required	Sale Offer identifier

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.
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}

Response

200 - Sale Offer resource

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	-

404 - Not found

Property	Type	Required	Description
@context	string | object	-
@id	string	required
@type	string	required
code	string	-	Stable identifier of the error in the error code catalogue (see /api/error-codes). Present on catalogued errors only.
description	string | null	-
detail	string | null	-	A human-readable explanation specific to this occurrence of the problem.
instance	string | null	-	A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
message	string	-	End-user message localized in the request locale, with this occurrence's values substituted. Present on catalogued errors only.
slug	string	-	Stable, readable key of the error in the error code catalogue. Present on catalogued errors only.
status	integer | null	-
title	string | null	-	A short, human-readable summary of the problem. For a catalogued error it repeats the slug.
type	string	-	A URI reference that identifies the problem type. For a catalogued error it is the error code resource, /api/error-codes/{code}.