Ordexs API v1 Get an API key

Offers

List offers

GEThttps://api.ordexs.com/v1/offers

Bundles, upsells (quantity packs) and cross-sells, newest first. A store has at most 30.

Query parameters

  • limitinteger

    How many objects to return, 1–100. Default 25.

    1–100

  • cursorstring

    The next_cursor from the previous page. Repeat the same filters with it.

    up to 512 characters

  • typestring

    One of bundle, upsell, cross_sell

  • statusstring

    One of active, paused

Returns

200 OK · A page of offers. OfferList

  • objectstringRequired

    always "list"

  • has_morebooleanRequired
  • next_cursorstring or nullRequired

    Pass as cursor to get the next page. null on the last page.

  • dataarray of OffersRequired
    18 child fields
    • idstring

      starts with ofr_

    • objectstring

      always "offer"

    • typestring

      One of bundle, upsell, cross_sell

    • namestring
    • statusstring

      One of active, paused

    • statestring

      Where the offer is in its schedule now.

      One of active, scheduled, expired, paused

    • starts_atstring or null

      ISO 8601 date-time, UTC

    • ends_atstring or null

      ISO 8601 date-time, UTC

    • show_countdownboolean
    • discountDiscountValue or null
      2 child fields
      • typestringRequired

        One of percent, fixed

      • valuestringRequired
    • free_shippingboolean
    • product_idsarray of strings
    • variant_idsarray of strings or null
    • tiersarray of OfferTiers or null
      6 child fields
      • quantityintegerRequired

        1–999

      • discountDiscountValue or null

        The pack's price break; null or left out for the regular price.

        2 child fields
        • typestringRequired

          One of percent, fixed

        • valuestringRequired
      • free_shippingboolean

        default false

      • labelstring or null

        Left out: "N ×".

        up to 40 characters

      • badgestring or null

        Such as POPULAR or BEST VALUE.

        up to 20 characters

      • image_urlstring or null

        Left out: the product's image.

        up to 1000 characters

    • cross_sellOfferCrossSell or null
      8 child fields
      • trigger_scopestring

        What arms it: carts holding trigger_product_ids, a product of trigger_collection_ids, or every cart.

        One of products, collection, all

      • trigger_product_idsarray of strings

        up to 100 items

      • trigger_collection_idsarray of strings

        up to 50 items

      • suggested_product_idsarray of strings

        up to 50 items

      • placementsarray of strings

        One of order_button, summary, checkout_summary, cart, post_purchase
        at least 1 item

      • priorityinteger

        Higher shows first when several apply.

        -1000–1000

      • max_itemsinteger or null

        1–8

      • auto_fillboolean

        Fill the suggestions with the store's best sellers when suggested_product_ids is short.

    • created_atstring

      ISO 8601 date-time, UTC

    • updated_atstring

      ISO 8601 date-time, UTC

    • livemodeboolean

Errors

Every error has the same shape. This endpoint can answer with: