@plentymarkets/shop-api / getOffer

Function: getOffer()

getOffer(context, params): Promise<Data<Offer | GetOfferError>>

Defined in: api/getOffer/index.ts:27

Method getOffer - gets the Offer data.

Parameters

context

PlentysystemsIntegrationContext

params

OfferSearchParams

offerId: int; accessKey: string; postcode: string;

Returns

Promise<Data<Offer | GetOfferError>>

Offer | GetOfferError

Remarks

• Calls /rest/storefront/offers/$
• Method uses OfferSearchParams

Example

const { data } = await useSdk().plentysystems.getOffer({
  offerId: '138',
  accessKey: '4L95RS31F',
  postcode: '34131'
});