Offer details

This endpoint is used to fetch any offered items related to the product. Other products may be offered along with the product as an offer from the merchant. This endpoint displays all of the items as an offer.

TIP

The product offers endpoint has been implemented in the Offer Web Component, and It's all setup to save developer's time and effort.

Payload

OfferDetailsPayload

product_id

number

required

The id of the offered product.

Response

Success

Error

product.offerDetails.success

success

boolean

success

required

Response flag

status

enum<number>

status

required

Allowed values:

200201202

data

array[object (Offer) {5}]

data

optional

Data is available when the success is true

string

optional

Offer id

name

string

optional

Offer name

message

string

optional

Offer messge

expiry_date

string

optional

Offer expiry date

formatted_date

string

optional

Offer formatted date

Usage

To perform the action of fetching any offered items related to the product, the developer may run the details() method as below.

Events

This endpoint may trigger two events, the onOfferExisted, onOffersFetched and onFetchOffersFailed events.

onOfferExisted

This event is triggered when fetching any existed offer related to the product is done without having any errors coming back from the backend.

onOffersFetched

This event is triggered when fetching any offered items related to the product is done without having any errors coming back from the backend.

onFetchOffersFailed

This event is triggered when fetching any offered items related to the product is not completed and an error has occurred.

Payload#

Response#

Usage#

Events#

onOfferExisted#

onOffersFetched#

onFetchOffersFailed#

Payload

Response

Usage

Events

onOfferExisted

onOffersFetched

onFetchOffersFailed