Salla Docs
Merchant API
  • Merchant API
  • Salla OAuth 2.0
Partner APIs
  • App API
  • Shipment API
Storefront
  • Twilight Engine
  • Twilight SDK
  • Web Components
  • Change Log
Salla CLI
Merchant API
  • Merchant API
  • Salla OAuth 2.0
Partner APIs
  • App API
  • Shipment API
Storefront
  • Twilight Engine
  • Twilight SDK
  • Web Components
  • Change Log
Salla CLI
Salla - Opensource
Salla - Developers Community
  1. Product
  • Overview
  • Languages
  • Notify
  • Event
  • Storage
  • Configuration
  • Forms
  • Helpers
  • Auth
    • Login
    • Logout
    • Verify
    • Resend
    • Register
    • Refresh
  • Cart
    • Latest
    • Details
    • Quick Add
    • Add Item
    • Delete Item
    • Delete Image
    • Add Coupon
    • Remove Coupon
    • Get Upload Image
    • Get Quick Order Settings
    • Create Quick Order
    • Order Status
    • Get Current Cart Id
    • Price Quote
  • Wishlist
    • Add
    • Remove
    • Toggle
  • Loyalty
    • Get Program
    • Exchange
    • Reset
  • Comment
    • Add Comment
    • Fetch
    • Get Page Comments
    • Get Product Comments
  • Profile
    • Update profile
    • Update contact
  • Product
    • Get price
    • Product availability
    • Categories
    • Offer details
    • Search products
    • Get Gift Details
    • Add Gift To Cart
    • Upload Gift Image
    • Get Product Details
    • Fetch
    • Fetch Options
    • Size Guides
  • Order
    • Create cart from order
    • Cancel
    • Send invoice
    • Show order
  • Booking
    • Add
  • Rating
    • Order
    • Store
    • Products
    • Shipping
  • Currency
    • Change
    • List
  • Component
    • Reviews
    • Menus
  1. Product

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
id
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.
Previous
Categories
Next
Search products