Dump offer profile configuration

GET

https://restapi.ordergroove.com/offer_profiles/:public_id/dump/

GET

/offer_profiles/:public_id/dump/

curl https://restapi.ordergroove.com/offer_profiles/public_id/dump/ \
     -H "x-api-key: <apiKey>"

200Result

{
  "public_id": "83dc2b6a519111ef869ed637592b5542",
  "name": "Live Offer Profile",
  "weight": 100,
  "live": true,
  "initial_coupon": {
    "public_id": "14e4a6f57a95481fa78e6a05cae53ea3",
    "name": "Initial Coupon",
    "code": "rc3_ioi_coupon",
    "conditions": [
      {
        "public_id": "134cd0c6111143f8b4e74cd48ddd2756",
        "premises": "9228",
        "description": "2 shipments prepaid condition",
        "incentives": [
          {
            "object": 2,
            "field": 1,
            "type": "discount_percent",
            "value": "15.00",
            "name": "2 shipments prepaid discount",
            "public_id": "1338940afcbe433ebfcb8e194a1913fe",
            "polymorphic_type": "Discount"
          }
        ]
      },
      {
        "public_id": "c29f4fde3f614505a22469026bb81d06",
        "premises": "9230",
        "description": "3 shipments prepaid condition",
        "incentives": [
          {
            "object": 2,
            "field": 1,
            "type": "discount_percent",
            "value": "15.00",
            "name": "3 shipments prepaid discount",
            "public_id": "6ca21d33c2fe493cbd501631032fbf52",
            "polymorphic_type": "Discount"
          }
        ]
      }
    ],
    "incentives": [
      {
        "object": 2,
        "field": 1,
        "type": "discount_percent",
        "value": "13.00",
        "name": "Default Initial Discount",
        "public_id": "32a236ddf6851f60b0744450be9bfe28",
        "polymorphic_type": "Discount"
      }
    ],
    "standard_flex_incentives": [
      {
        "public_id": "62cdb4dd50aa488aa017f82ea7485092",
        "standard": "SUBSCRIPTION_ONLY_PSI",
        "incentive_type": "discount_percent",
        "incentive_value": 10,
        "premise_value": [
          "bath",
          "fruits"
        ],
        "type": "initial"
      },
      {
        "public_id": "15bfb343addd4b1a96d7ed3278598215",
        "standard": "PSI",
        "incentive_type": "discount_percent",
        "incentive_value": 5,
        "premise_value": [
          "luxury"
        ],
        "type": "initial"
      }
    ]
  },
  "recurring_coupon": {
    "public_id": "c44ac861afe641ebbf9109a2bcace99e",
    "name": "Recurring Coupon",
    "code": "rc3_roi_coupon",
    "conditions": [
      {
        "public_id": "6c05eeed1cb34e19925821c1fd624c03",
        "premises": "9229",
        "description": "2 shipments prepaid condition",
        "incentives": [
          {
            "object": 2,
            "field": 1,
            "type": "discount_percent",
            "value": "15.00",
            "name": "2 shipments prepaid discount",
            "public_id": "745c26a1d8974119afa9e0ab8e6118b1",
            "polymorphic_type": "Discount"
          }
        ]
      },
      {
        "public_id": "9bdf1614a82c47c6857fabae6ea4503c",
        "premises": "9231",
        "description": "3 shipments prepaid condition",
        "incentives": [
          {
            "object": 2,
            "field": 1,
            "type": "discount_percent",
            "value": "15.00",
            "name": "3 shipments prepaid discount",
            "public_id": "fdc9e571031249d0a392d0029068f519",
            "polymorphic_type": "Discount"
          }
        ]
      }
    ],
    "incentives": [
      {
        "object": 2,
        "field": 1,
        "type": "discount_percent",
        "value": "14.00",
        "threshold_field": 1,
        "name": "Default Recurring Discount",
        "public_id": "bd3e24e35ec447d88ac71136b7e67638",
        "polymorphic_type": "Discount"
      }
    ],
    "standard_flex_incentives": [
      {
        "public_id": "e808f5091718460aa6ad492fef3ebbfb",
        "standard": "NON_SUBSCRIPTION_ONLY_PSI",
        "incentive_type": "discount_percent",
        "incentive_value": 50,
        "premise_value": [
          "fruit",
          "bath"
        ],
        "type": "recurring"
      },
      {
        "public_id": "8a13bcb41f8f40639619f6433bbdedcb",
        "standard": "PSI",
        "incentive_type": "discount_percent",
        "incentive_value": 3,
        "premise_value": [
          "luxury"
        ],
        "type": "recurring"
      },
      {
        "public_id": "222dab261ddf45d4aa426a312c79d361",
        "standard": "PSI",
        "incentive_type": "discount_percent",
        "incentive_value": 3,
        "premise_value": [
          "luxury2"
        ],
        "type": "recurring"
      },
      {
        "public_id": "f79953cbaccc4ba6989d8d334b193a41",
        "standard": "N_SUCCESSFUL_ITEMS_FOR_SUB",
        "incentive_type": "discount_percent",
        "incentive_value": 75,
        "premise_value": [
          "4"
        ],
        "type": "recurring",
        "premise_operand": "EQUAL"
      },
      {
        "public_id": "8537d1a1df294f3899cb19efa14a40f8",
        "standard": "NTH_ORDER_IN_CYCLE_FOR_SUBSCRIBER",
        "incentive_type": "discount_percent",
        "incentive_value": 80,
        "premise_value": [
          "5",
          "4"
        ],
        "type": "recurring"
      },
      {
        "public_id": "cd806658abdf4eba90c0567352c04428",
        "standard": "N_SUCCESSFUL_ITEMS_IN_CYCLE_FOR_SUB",
        "incentive_type": "discount_percent",
        "incentive_value": 90,
        "premise_value": [
          "5",
          "4"
        ],
        "type": "recurring"
      }
    ]
  },
  "offers": [
    {
      "public_id": "83f5a824559111ef861f1a1bb24efa7a",
      "name": "Default Offer",
      "offer_type": 1,
      "weight": 100,
      "live": true
    }
  ],
  "premises": [
    {
      "id": 9228,
      "public_id": "81ce2c4b813642c3b7a85de39e51cd84",
      "slug": "34deca71bfba4ae0aa34dc2d2c5b4b76",
      "premise_type": "Number of orders per billing for a prepaid subscription cycle",
      "operand": "eq",
      "value": "2"
    },
    {
      "id": 9229,
      "public_id": "cfa5bf0ef13e46cbb94febf28829e7ac",
      "slug": "4e7f81448d824ce09468adc52ed1a0c8",
      "premise_type": "Number of orders per billing for a prepaid subscription cycle",
      "operand": "eq",
      "value": "2"
    },
    {
      "id": 9230,
      "public_id": "248718103b6f4c888484d3ccd1f73776",
      "slug": "45ac2f4d929f494eb40cfbcf5e3ae463",
      "premise_type": "Number of orders per billing for a prepaid subscription cycle",
      "operand": "eq",
      "value": "3"
    },
    {
      "id": 9231,
      "public_id": "4fc06bcb37dd40c486567a2772bc944a",
      "slug": "3bc268c1926e4c30a83c72a8aee64ba6",
      "premise_type": "Number of orders per billing for a prepaid subscription cycle",
      "operand": "eq",
      "value": "3"
    }
  ]
}

Get a snapshot of the current offer profile's configuration including all of its incentives and the criteria for them to get applied in the form of conditions

Authentication

x-api-keystring

Application API Scope — server-to-server, sent in the x-api-key header. See Authentication.

authorizationstring

Storefront API Scope — client-side, scoped to one customer, sent as a signature in the authorization header. See Authentication.

Path parameters

public_idstringRequired

Offer Profile's public ID

Response

200

public_idstringOptional

namestringOptional

weightintegerOptionalDefaults to 0

livebooleanOptionalDefaults to true

initial_couponobjectOptional

recurring_couponobjectOptional

offerslist of objectsOptional

premiseslist of objectsOptional