Load

POST

https://restapi.ordergroove.com/offer_profiles/load/

POST

/offer_profiles/load/

$ curl -X POST https://restapi.ordergroove.com/offer_profiles/load/ \
>      -H "x-api-key: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "public_id": "e8f7a980d43411efae9feee7aa8f6f94",
>   "name": "Offer Profile 1",
>   "weight": 100,
>   "live": true,
>   "initial_coupon": {
>     "public_id": "03d1becf82324562929af698255534a2",
>     "name": "Offer Profile 1 - initial coupon",
>     "code": "rc3_ioi_coupon",
>     "conditions": [
>       {
>         "public_id": "0afbe168bc1c4bc28f380b9f784e9ff0",
>         "premises": "9748",
>         "description": "DO NOT MODIFY - Merchant Acme 3 shipments prepaid condition",
>         "incentives": [
>           {
>             "object": 2,
>             "field": 1,
>             "type": "discount_percent",
>             "value": "90.00",
>             "threshold_field": null,
>             "threshold_value": null,
>             "name": "DO NOT MODIFY - Merchant Acme 3 shipments prepaid discount",
>             "public_id": "a9989cd984fb4d3f8e20db83c4374929",
>             "polymorphic_type": "Discount"
>           }
>         ]
>       },
>       {
>         "public_id": "412432c0f6244e1ea30e4f062587fabf",
>         "premises": "9750",
>         "description": "DO NOT MODIFY - Merchant Acme 4 shipments prepaid condition",
>         "incentives": [
>           {
>             "object": 2,
>             "field": 1,
>             "type": "discount_percent",
>             "value": "95.00",
>             "threshold_field": null,
>             "threshold_value": null,
>             "name": "DO NOT MODIFY - Merchant Acme 4 shipments prepaid discount",
>             "public_id": "78770aa2780145ce8cf7f9dd21fb1b47",
>             "polymorphic_type": "Discount"
>           }
>         ]
>       }
>     ],
>     "incentives": [
>       {
>         "object": 2,
>         "field": 1,
>         "type": "discount_percent",
>         "value": "65.00",
>         "threshold_field": null,
>         "threshold_value": null,
>         "name": "Offer Profile 1 initial discount",
>         "public_id": "210df43d700042ed9cb9f3a976329d0c",
>         "polymorphic_type": "Discount"
>       },
>       {
>         "object": 2,
>         "field": 1,
>         "type": "discount_percent",
>         "value": "90.00",
>         "threshold_field": null,
>         "threshold_value": null,
>         "name": "DO NOT MODIFY - Merchant Acme 3 shipments prepaid discount",
>         "public_id": "a9989cd984fb4d3f8e20db83c4374929",
>         "polymorphic_type": "Discount"
>       },
>       {
>         "object": 2,
>         "field": 1,
>         "type": "discount_percent",
>         "value": "95.00",
>         "threshold_field": null,
>         "threshold_value": null,
>         "name": "DO NOT MODIFY - Merchant Acme 4 shipments prepaid discount",
>         "public_id": "78770aa2780145ce8cf7f9dd21fb1b47",
>         "polymorphic_type": "Discount"
>       }
>     ],
>     "standard_flex_incentives": []
>   },
>   "recurring_coupon": {
>     "public_id": "e324d31f9a0443998a4e0a46d93053cc",
>     "name": "Offer Profile recurring coupon",
>     "code": "rc3_recurring_coupon",
>     "conditions": [
>       {
>         "public_id": "72318d44bd584791b659abfbfc6bee38",
>         "premises": "9749",
>         "description": "DO NOT MODIFY - Merchant Acme 3 shipments prepaid condition",
>         "incentives": [
>           {
>             "object": 2,
>             "field": 1,
>             "type": "discount_percent",
>             "value": "95.00",
>             "threshold_field": null,
>             "threshold_value": null,
>             "name": "DO NOT MODIFY - Merchant Acme 3 shipments prepaid discount",
>             "public_id": "94788a42496246c0a7181954df86fa4a",
>             "polymorphic_type": "Discount"
>           }
>         ]
>       },
>       {
>         "public_id": "844444355bd8423f9578dacabd58ffe1",
>         "premises": "9751",
>         "description": "DO NOT MODIFY - Merchant Acme 4 shipments prepaid condition",
>         "incentives": [
>           {
>             "object": 2,
>             "field": 1,
>             "type": "discount_percent",
>             "value": "97.00",
>             "threshold_field": null,
>             "threshold_value": null,
>             "name": "DO NOT MODIFY - Merchant Acme 4 shipments prepaid discount",
>             "public_id": "f93bc326c42f4f14a7cdcb6e3611e03b",
>             "polymorphic_type": "Discount"
>           }
>         ]
>       },
>       {
>         "public_id": "0000db0df67049e4915e0148389e6348",
>         "premises": "73",
>         "description": "Threshold Condition",
>         "incentives": [
>           {
>             "object": 1,
>             "field": 3,
>             "type": "discount_percent",
>             "value": "50.00",
>             "threshold_field": null,
>             "threshold_value": "1.50",
>             "name": "Offer Profile recurring discount - 0",
>             "public_id": "f09c3b5db20d484086d68f967bd28af8",
>             "polymorphic_type": "Discount"
>           }
>         ]
>       }
>     ],
>     "incentives": [
>       {
>         "object": 1,
>         "field": 3,
>         "type": "discount_percent",
>         "value": "50.00",
>         "threshold_field": null,
>         "threshold_value": "1.50",
>         "name": "Offer Profile recurring discount - 0",
>         "public_id": "f09c3b5db20d484086d68f967bd28af8",
>         "polymorphic_type": "Discount"
>       },
>       {
>         "object": 2,
>         "field": 1,
>         "type": "discount_amount",
>         "value": "0.25",
>         "threshold_field": null,
>         "threshold_value": "2.25",
>         "name": "Offer Profile recurring discount - 1",
>         "public_id": "3e98f94285f94631aab4675f361f57d0",
>         "polymorphic_type": "Discount"
>       },
>       {
>         "object": 2,
>         "field": 1,
>         "type": "discount_percent",
>         "value": "95.00",
>         "threshold_field": null,
>         "threshold_value": null,
>         "name": "DO NOT MODIFY - Merchant Acme 3 shipments prepaid discount",
>         "public_id": "94788a42496246c0a7181954df86fa4a",
>         "polymorphic_type": "Discount"
>       },
>       {
>         "object": 2,
>         "field": 1,
>         "type": "discount_percent",
>         "value": "97.00",
>         "threshold_field": null,
>         "threshold_value": null,
>         "name": "DO NOT MODIFY - Merchant Acme 4 shipments prepaid discount",
>         "public_id": "f93bc326c42f4f14a7cdcb6e3611e03b",
>         "polymorphic_type": "Discount"
>       },
>       {
>         "object": 1,
>         "field": 3,
>         "type": "discount_amount",
>         "value": "10.00",
>         "threshold_field": null,
>         "threshold_value": null,
>         "name": "$10 Off Discoun",
>         "public_id": "6a2ba764b74a487285305a91242d83a0",
>         "polymorphic_type": "Discount"
>       }
>     ],
>     "standard_flex_incentives": []
>   },
>   "offers": [
>     {
>       "public_id": "e9073792d43411ef998a626c4261b4a9",
>       "name": "Standard Offer",
>       "offer_type": 1,
>       "weight": 100,
>       "live": true,
>       "module_view": 1
>     }
>   ],
>   "premises": [
>     {
>       "id": 73,
>       "public_id": "8a61f834ccb94cca935421d7640def29",
>       "slug": "9b3e304bb03f410fa9d8a86f00d95fa5",
>       "premise_type": "Current item is of replenishment type",
>       "operand": "eq",
>       "value": ""
>     },
>     {
>       "id": 9748,
>       "public_id": "51621bc540fc4bd0b419a51a2e45b579",
>       "slug": "a788764df77a4890b9c24b119c15150b",
>       "premise_type": "Number of orders per billing for a prepaid subscription cycle",
>       "operand": "eq",
>       "value": "3"
>     },
>     {
>       "id": 9749,
>       "public_id": "1564d568682d4565a9b32befda8dfb55",
>       "slug": "c23fa72af1a34085bb025cec6381711e",
>       "premise_type": "Number of orders per billing for a prepaid subscription cycle",
>       "operand": "eq",
>       "value": "3"
>     },
>     {
>       "id": 9750,
>       "public_id": "d9cb7b5fcd664aa6a5ec247d779dedf2",
>       "slug": "b33c3a774bb54542a1cfdeda66f2aa55",
>       "premise_type": "Number of orders per billing for a prepaid subscription cycle",
>       "operand": "eq",
>       "value": "4"
>     },
>     {
>       "id": 9751,
>       "public_id": "ed82ea28b6a04a6391df33d8abcfe52a",
>       "slug": "d6b9661b7b554854b4d977eb47272145",
>       "premise_type": "Number of orders per billing for a prepaid subscription cycle",
>       "operand": "eq",
>       "value": "4"
>     }
>   ]
> }'

201Legacy Offer Profile

1 {}

Load a dump of an Offer Profile (obtained via the https://developer.ordergroove.com/reference/offer-profile-dump endpoint) and create a replica of the same setup. The dump can be modified before uploading if any changes are required (like updating the Product ID for a Sample SKU, or changing a discount). The request can be made for the same Merchant, or a different one. By using a different Merchant the Offer Profile setup can be moved across Merchants and environments. The new setup will always be created in an inactive state (the live bit on the Offer Profile will be false). New objects will be created and no existing premises, incentives, offers, or coupons will be reused. If a product is provided for a Sample SKU or Gift incentive, there must already be a valid product for that Merchant/Product Public ID.

Load a dump of an Offer Profile (obtained via the https://developer.ordergroove.com/reference/offer-profile-dump endpoint) and create a replica of the same setup. The dump can be modified before uploading if any changes are required (like updating the Product ID for a Sample SKU, or changing a discount). The request can be made for the same Merchant, or a different one. By using a different Merchant the Offer Profile setup can be moved across Merchants and environments. The new setup will always be created in an inactive state (the `live` bit on the Offer Profile will be `false`). New objects will be created and no existing premises, incentives, offers, or coupons will be reused. If a product is provided for a Sample SKU or Gift incentive, there must already be a valid product for that Merchant/Product Public ID.

Authentication

x-api-keystring

API Key authentication via header

Query parameters

preserve_offer_public_idsbooleanOptionalDefaults to false

Determines whether or not the offer public IDs should be preserved

Request

This endpoint expects an object.

RAW_BODYstringOptionalformat: "json"

This should be the output from a call to the dump endpoint (https://developer.ordergroove.com/reference/offer-profile-dump)

Response

201

namestring

public_idstring

weightintegerDefaults to 0

livebooleanDefaults to true

merchantstring

initial_couponobject

recurring_couponobject

offerslist of strings