Retrieve a purchase offer

get /rest/api/purchase_offers/{id}

Retrieves a Purchase Offer resource.

Returns a single purchase offer by id, including its cost, validity period, and the variant, supplier, country and tax it applies to.

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.

Path parameters

Name	Type	Required	Description
id	string	required	Purchase Offer identifier

Response

200 - Purchase Offer resource

Property	Type	Required	Description
@context	object	-
@id	string	required
@type	string	required
id	string	-	The unique identifier of the purchase 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.
supplier	string	required	The supplier resource it belongs to.
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.

404 - Not found

Property	Type	Required	Description
@context	object	-
@id	string	required
@type	string	required
title	string | null	-	A short, human-readable summary of the problem.
detail	string | null	-	A human-readable explanation specific to this occurrence of the problem.
status	number | null	-
instance	string | null	-	A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
type	string	-	A URI reference that identifies the problem type