sticky.io JSON API & Integrations
\n\nDon't see a method you are looking for?
Check out our Fully Restful V2 JSON API
This requires Basic Authentication set in the Headers of the request.
\nThis method is used to validate the supplied credentials.
\nMax Requests Per Minute: 120
\nThe customer_find_active_product request parameters are the customer_id and also accepts an optional parameter: campaign_id. campaign_id is used if you need to narrow the valid products returned down to the campaign level. If this is not specified, all valid products are returned for that customer_id, regardless of the campaign. The response will return a list of all valid product_id in sticky.io for the given parameters received in the request.
Max Requests Per Minute: 120
\nThis method is used to display product attribute information (variance information) related to product(s).
\nMax Requests Per Minute: 120
\nThe items inside of the data property are keyed by Product ID. Inside of this object, there will be various attributes for that product. They will be keyed numerically according to their Attribute ID.
Note that each product variant will contain the custom attributes created for it. In addition, it will contain the properties in the table below.
\n","urlObject":{"protocol":"https","host":["{{app_key}}","{{domain}}{{api_ext}}product_attribute_index"],"query":[],"variable":[]}},"response":[{"id":"4dadbb5e-8a9a-4c36-9d15-577ccd30feb2","name":"product_attribute_index","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","disabled":false}],"body":{"mode":"raw","raw":"{\n\t\"product_id\":\n\t[\n\t\t\"7\"\n\t]\n}"},"url":"https://{{app_key}}.{{domain}}{{api_ext}}product_attribute_index"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Connection","value":"keep-alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Length","value":"141","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Thu, 05 Jul 2018 19:48:28 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains;","name":"Strict-Transport-Security","description":"A HSTS Policy informing the HTTP client how long to cache the HTTPS only policy and whether this applies to subdomains."},{"key":"Vary","value":"Authorization","name":"Vary","description":"Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."}],"cookie":[{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":false,"domain":"dev.limelightcrm.com","path":"/","secure":true,"value":"PHPSTORM","key":"XDEBUG_SESSION"}],"responseTime":null,"body":"{\"response_code\":\"100\",\"data\":{\"7\":{\"2\":{\"id\":\"2\",\"name\":\"Condition\",\"children\":{\"4\":\"New\",\"6\":\"Used\",\"8\":\"Refurbished\",\"10\":\"Off Lease\"}}}}}"}],"_postman_id":"1a62da5e-8762-4e3d-8abc-22180a0357c2"},{"name":"product_bundle_index","id":"34092b3d-ea3d-459d-8b72-8be870b11cf5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_username}}"},{"key":"password","value":"{{api_password}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://{{app_key}}.{{domain}}{{api_ext}}product_bundle_index","description":"This method is used to retrieve the active product bundles.
\nMax Requests Per Minute: 60
\nThis method is used to retrieve information about a specific bundle.
\nMax Requests Per Minute: 60
\nThe data object contains information about the specific product bundle. This includes
\nSee Product Bundle Object Properties in product_bundle_index for details about the bundle property.
This method is the easiest way to get started taking template products that are existing in your offers and slightly tweaking them through the API. It could be used for such things as creating products on the fly for membership upgrades. The newly created copied product will reside in the same product category as the copied template. You can specify and optional new_name field to use a name of your choice for the newly created product based off an existing template.
Max Requests Per Minute: 120
\n","urlObject":{"protocol":"https","host":["{{app_key}}","{{domain}}{{api_ext}}product_copy"],"query":[],"variable":[]}},"response":[{"id":"53c055a3-55d0-4fd6-a09a-8e6e82713e20","name":"product_copy","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","disabled":false}],"body":{"mode":"raw","raw":"{\n\t\"product_id\":\"2\",\n\t\"new_name\":\"Copied Product 2\"\n}"},"url":"https://{{app_key}}.{{domain}}{{api_ext}}product_copy"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Connection","value":"keep-alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Length","value":"46","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Thu, 05 Jul 2018 19:58:42 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains;","name":"Strict-Transport-Security","description":"A HSTS Policy informing the HTTP client how long to cache the HTTPS only policy and whether this applies to subdomains."},{"key":"Vary","value":"Authorization","name":"Vary","description":"Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."}],"cookie":[{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":false,"domain":"dev.limelightcrm.com","path":"/","secure":true,"value":"PHPSTORM","key":"XDEBUG_SESSION"}],"responseTime":null,"body":"{\"response_code\":\"100\",\"new_product_id\":\"408\"}"}],"_postman_id":"0e05bdc3-a18b-4f7b-ac5f-2dae59013b26"},{"name":"product_create","id":"af37cbb9-9146-4de1-8e33-492988bd158d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_username}}"},{"key":"password","value":"{{api_password}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"product_name\":\"Product Creation\",\n\t\"category_id\":\"1\",\n\t\"vertical_id\":\"1\",\n\t\"product_sku\":\"product_creation\",\n\t\"product_price\":\"0.99\",\n\t\"product_description\":\"Product Description\",\n\t\"product_max_quantity\":\"100\",\n\t\"customer_purchase_limit\":\"\",\n\t\"taxable\":\"\",\n\t\"shippable\":\"\",\n\t\"signature_confirmation\":\"\",\n\t\"delivery_confirmation\":\"\",\n\t\"preserve_quantity\":\"\",\n\t\"collections\":\"\",\n\t\"shipping_declared_value\":\"\",\n\t\"product_restocking_fee\":\"\",\n\t\"shipping_weight\":\"\",\n\t\"digitally_delievered\":\"\",\n\t\"shipping_digital_delivery_url\":\"\",\n\t\"recurring_discount_max\":\"\",\n\t\"events\":\n\t{\n\t\t\"3\":\"Order Confirmation\"\n\t},\n\t\"paired_products\":[]\n}"},"url":"https://{{app_key}}.{{domain}}{{api_ext}}product_create","description":"This method is used to create new products.
\nMax Requests Per Minute: 120
\n","urlObject":{"protocol":"https","host":["{{app_key}}","{{domain}}{{api_ext}}product_create"],"query":[],"variable":[]}},"response":[{"id":"4e81614a-682e-478d-99f3-436f5429e42f","name":"product_create","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","disabled":false}],"body":{"mode":"raw","raw":"{\n\t\"product_name\":\"Product Creation\",\n\t\"category_id\":\"1\",\n\t\"vertical_id\":\"1\",\n\t\"product_sku\":\"product_creation\",\n\t\"product_price\":\"0.99\",\n\t\"product_description\":\"Product Description\",\n\t\"product_max_quantity\":\"100\",\n\t\"customer_purchase_limit\":\"\",\n\t\"taxable\":\"\",\n\t\"shippable\":\"\",\n\t\"signature_confirmation\":\"\",\n\t\"delivery_confirmation\":\"\",\n\t\"preserve_quantity\":\"\",\n\t\"collections\":\"\",\n\t\"shipping_declared_value\":\"\",\n\t\"product_restocking_fee\":\"\",\n\t\"shipping_weight\":\"\",\n\t\"digitally_delievered\":\"\",\n\t\"shipping_digital_delivery_url\":\"\",\n\t\"recurring_discount_max\":\"\",\n\t\"events\":\n\t{\n\t\t\"1\":\"Shipping Confirmation\"\n\t},\n\t\"paired_products\":\"\"\n}"},"url":"https://{{app_key}}.{{domain}}{{api_ext}}product_create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Connection","value":"keep-alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Length","value":"97","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Thu, 05 Jul 2018 20:16:47 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains;","name":"Strict-Transport-Security","description":"A HSTS Policy informing the HTTP client how long to cache the HTTPS only policy and whether this applies to subdomains."},{"key":"Vary","value":"Authorization","name":"Vary","description":"Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."}],"cookie":[{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":false,"domain":"dev.limelightcrm.com","path":"/","secure":true,"value":"PHPSTORM","key":"XDEBUG_SESSION"}],"responseTime":null,"body":"{\"response_code\":\"100\",\"response_message\":\"Successfully created product.\",\"new_product_id\":\"409\"}"}],"_postman_id":"af37cbb9-9146-4de1-8e33-492988bd158d"},{"name":"product_delete","id":"37810cf6-6b03-4a18-812d-65584ce4cb2c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_username}}"},{"key":"password","value":"{{api_password}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"product_id\":\"409\"\n}"},"url":"https://{{app_key}}.{{domain}}{{api_ext}}product_delete","description":"This method is used to delete a product.
\nMax Requests Per Minute: 120
\n","urlObject":{"protocol":"https","host":["{{app_key}}","{{domain}}{{api_ext}}product_delete"],"query":[],"variable":[]}},"response":[{"id":"4bb0e568-8038-4be4-a476-963326482958","name":"product_delete","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","disabled":false}],"body":{"mode":"raw","raw":"{\n\t\"product_id\":\"409\"\n}"},"url":"https://{{app_key}}.{{domain}}{{api_ext}}product_delete"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Connection","value":"keep-alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Length","value":"100","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 06 Jul 2018 11:07:32 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains;","name":"Strict-Transport-Security","description":"A HSTS Policy informing the HTTP client how long to cache the HTTPS only policy and whether this applies to subdomains."},{"key":"Vary","value":"Authorization","name":"Vary","description":"Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."}],"cookie":[{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":false,"domain":"dev.limelightcrm.com","path":"/","secure":true,"value":"PHPSTORM","key":"XDEBUG_SESSION"}],"responseTime":null,"body":"{\"response_code\":\"100\",\"response_message\":\"Successfully deleted product\",\"deleted_product_id\":\"409\"}"}],"_postman_id":"37810cf6-6b03-4a18-812d-65584ce4cb2c"},{"name":"product_index","id":"0a5a59d7-b5ea-41dd-8dd3-648dcaab6ad1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_username}}"},{"key":"password","value":"{{api_password}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"product_id\":\n\t[\n\t\t1,\n\t\t2\n\t]\n}"},"url":"https://{{app_key}}.{{domain}}{{api_ext}}product_index","description":"This method is used to display product information.
The two accepted parameters are product_id OR criteria
If you pass both product_id AND criteria, ONLY criteria will be evaluated.
Max Requests Per Minute: 120
\nMax Rows Can Be Returned: 1000
\n\n\nPagination is not supported. Please use v2 API
\n
product_id should be an array of product_ids that you would like to get data on. You may also pass the string all instead of the array to retrieve a list of all products. **BE AWARE: We have a 1000 max limit and pagination is not supported.
**criteria is an object of filters that you want to get information on. The current accepted keys are category_id and vertical_id. An example of the criteria can be found in the examples as well as below:
{\n \"criteria\":\n {\n \"vertical_id\":\n [\n 10,\n 11\n ],\n \"category_id\":\n [\n 1,\n 2\n ]\n }\n}\n\nA list of default vertical_id is as follows:
The product_update method is used to update the information on a product.
\nIf all updates are successful, the response will include only the response_code of 100.\nIf there are any failures or updates that did not occur, the response will include a breakdown of each product and each field that was attempted to be updated with their respective response_codes.
Max Requests Per Minute: 120
\n","urlObject":{"protocol":"https","host":["{{app_key}}","{{domain}}{{api_ext}}product_update"],"query":[],"variable":[]}},"response":[{"id":"d8c59eff-0921-454c-a1fa-d88a064b8a31","name":"product_update all success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"product_id\":\n\t{\n\t\t\"404\":\n\t\t{\n\t\t\t\"product_name\":\"Updated Product Name\",\n\t\t\t\"product_price\":\"19.99\",\n\t\t\t\"product_description\":\"This is the product I updated using product_update\",\n\t\t\t\"product_sku\":\"ABC123\",\n\t\t\t\"product_weight\":\"10\",\n\t\t\t\"is_shippable\":\"0\",\n\t\t\t\"signature_confirmation\":\"1\",\n\t\t\t\"delivery_confirmation\":\"1\",\n\t\t\t\"digital_delivery\":\"1\",\n\t\t\t\"digital_delivery_url\":\"https://sticky.io\",\n\t\t\t\"declared_value\":\"9.99\",\n\t\t\t\"max_quantity\":\"1\",\n\t\t\t\"category_id\":\"2\",\n\t\t\t\"vertical_id\":\"2\"\n\t\t}\n\t}\n}","options":{"raw":{"language":"json"}}},"url":"https://{{app_key}}.{{domain}}{{api_ext}}product_update"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Connection","value":"keep-alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Length","value":"23","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 06 Jul 2018 11:46:00 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains;","name":"Strict-Transport-Security","description":"A HSTS Policy informing the HTTP client how long to cache the HTTPS only policy and whether this applies to subdomains."},{"key":"Vary","value":"Authorization","name":"Vary","description":"Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."}],"cookie":[{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":false,"domain":"dev.limelightcrm.com","path":"/","secure":true,"value":"PHPSTORM","key":"XDEBUG_SESSION"}],"responseTime":null,"body":"{\"response_code\":\"100\"}"},{"id":"fd74e8fb-260c-4072-af25-20f4a674d673","name":"product_update with different error codes","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"product_id\":\n\t{\n\t\t\"408\":\n\t\t{\n\t\t\t\"product_name\":\"Updated Product Name\",\n\t\t\t\"product_price\":\"9.99\",\n\t\t\t\"product_description\":\"This is the product I updated using product_update\",\n\t\t\t\"product_sku\":\"ABC123\",\n\t\t\t\"product_weight\":\"10\",\n\t\t\t\"is_shippable\":\"0\",\n\t\t\t\"signature_confirmation\":\"0\",\n\t\t\t\"delivery_confirmation\":\"1\",\n\t\t\t\"digital_delivery\":\"1\",\n\t\t\t\"digital_delivery_url\":\"https://sticky.io\",\n\t\t\t\"declared_value\":\"9.99\",\n\t\t\t\"max_quantity\":\"1\",\n\t\t\t\"category\":\"1\"\n\t\t}\n\t}\n}","options":{"raw":{"language":"json"}}},"url":"https://{{app_key}}.{{domain}}{{api_ext}}product_update"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Connection","value":"keep-alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Length","value":"591","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 06 Jul 2018 11:39:40 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains;","name":"Strict-Transport-Security","description":"A HSTS Policy informing the HTTP client how long to cache the HTTPS only policy and whether this applies to subdomains."},{"key":"Vary","value":"Authorization","name":"Vary","description":"Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."}],"cookie":[{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":false,"domain":"dev.limelightcrm.com","path":"/","secure":true,"value":"PHPSTORM","key":"XDEBUG_SESSION"}],"responseTime":null,"body":"{\"response_code\":\"911\",\"product_id\":{\"408\":{\"product_name\":{\"response_code\":\"100\"},\"product_price\":{\"response_code\":\"100\"},\"product_description\":{\"response_code\":\"100\"},\"product_sku\":{\"response_code\":\"100\"},\"product_weight\":{\"response_code\":\"100\"},\"is_shippable\":{\"response_code\":\"100\"},\"signature_confirmation\":{\"response_code\":\"343\"},\"delivery_confirmation\":{\"response_code\":\"100\"},\"digital_delivery\":{\"response_code\":\"100\"},\"digital_delivery_url\":{\"response_code\":\"100\"},\"declared_value\":{\"response_code\":\"100\"},\"max_quantity\":{\"response_code\":\"100\"},\"category\":{\"response_code\":\"351\"}}}}"}],"_postman_id":"b492ab22-550b-4c87-bc5e-c0bac3057b01"}],"id":"256e61c5-c619-4542-9620-799715a0bfae","_postman_id":"256e61c5-c619-4542-9620-799715a0bfae","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_username}}"},{"key":"password","value":"{{api_password}}"}]},"isInherited":true,"source":{"_postman_id":"9750fd0a-0874-4138-b29f-3d620fdb9e7c","id":"9750fd0a-0874-4138-b29f-3d620fdb9e7c","name":"sticky.io JSON API & Integration v2025.7.31","type":"collection"}}},{"name":"Billing Models and Offers","item":[{"name":"billing_model_view by offer_id","id":"cfe4caf0-4f4b-4639-b181-a86aa3ee6d22","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_username}}"},{"key":"password","value":"{{api_password}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"offer_id\": \"8\"\n}"},"url":"https://{{app_key}}.{{domain}}{{api_ext}}billing_model_view","description":"View the details of a billing models attached to an offer_id
The payload of the data response parameter is returned as an array of JSON objects. Each object contains related billing model details matching the criteria of the request parameters.
To see more granular details on each \"Billing Model\" see billing_model_view by id.
Max Requests Per Minute: 120
\nView the details of a billing model by id. The five types of \"Billing Models\" are:
\nHere is a breakdown of the parameters for each BM type:
\nStraight Sale
\nBill By Cycle
\nBill By Date
\nBill By Day
\nBill By Schedule
\nBill By Relative Date
\nMax Requests Per Minute: 120
\nThis method is used to display offer details. Using campaign_id in the request will return details for all related offers tied to the campaign.
Max Requests Per Minute: 120
\nThis method is used to display offer details. Using offer_id in the request will return specific to the offer_id supplied.
Max Requests Per Minute: 120
\nIn this section you will find information on Offers and Billing Models that are needed for building out different requests related to Orders
\n","event":[{"listen":"prerequest","script":{"id":"8dceb101-d7a3-4307-a72c-1edbb6a739a6","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"17ddcb29-7819-474a-ab42-edbdf209d6c7","type":"text/javascript","exec":[""]}}],"_postman_id":"3415d6b0-b561-4cc7-a740-c4a367eb3c0f","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_username}}"},{"key":"password","value":"{{api_password}}"}]},"isInherited":true,"source":{"_postman_id":"9750fd0a-0874-4138-b29f-3d620fdb9e7c","id":"9750fd0a-0874-4138-b29f-3d620fdb9e7c","name":"sticky.io JSON API & Integration v2025.7.31","type":"collection"}}},{"name":"Shipping and Fulfillment","item":[{"name":"repost_to_fulfillment","id":"0bd2b88d-050c-4889-b4c8-0d24e81007af","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_username}}"},{"key":"password","value":"{{api_password}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"order_id\":\"11431\"\n}"},"url":"https://{{app_key}}.{{domain}}{{api_ext}}repost_to_fulfillment","description":"This method is used to send orders to the fulfillment provider that have already been shipped out once before.
\nMax Requests Per Minute: 120
\n","urlObject":{"protocol":"https","host":["{{app_key}}","{{domain}}{{api_ext}}repost_to_fulfillment"],"query":[],"variable":[]}},"response":[{"id":"6d96e9b7-c415-4ef2-aa5f-56428576a943","name":"repost_to_fulfillment","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","disabled":false}],"body":{"mode":"raw","raw":"{\n\t\"order_id\":\"11431\"\n}"},"url":"https://{{app_key}}.{{domain}}{{api_ext}}repost_to_fulfillment"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Connection","value":"keep-alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Length","value":"23","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 06 Jul 2018 13:16:29 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains;","name":"Strict-Transport-Security","description":"A HSTS Policy informing the HTTP client how long to cache the HTTPS only policy and whether this applies to subdomains."},{"key":"Vary","value":"Authorization","name":"Vary","description":"Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."}],"cookie":[{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":false,"domain":"dev.limelightcrm.com","path":"/","secure":true,"value":"PHPSTORM","key":"XDEBUG_SESSION"}],"responseTime":null,"body":"{\"response_code\":\"100\"}"},{"id":"b042f631-870c-4a38-bfaa-f9a601ac94a1","name":"repost_to_fulfillment","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","disabled":false}],"body":{"mode":"raw","raw":"{\n\t\"order_id\":\"11431\"\n}"},"url":"https://{{app_key}}.{{domain}}{{api_ext}}repost_to_fulfillment"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Connection","value":"keep-alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Length","value":"23","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 06 Jul 2018 13:16:41 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains;","name":"Strict-Transport-Security","description":"A HSTS Policy informing the HTTP client how long to cache the HTTPS only policy and whether this applies to subdomains."},{"key":"Vary","value":"Authorization","name":"Vary","description":"Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."}],"cookie":[{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":false,"domain":"dev.limelightcrm.com","path":"/","secure":true,"value":"PHPSTORM","key":"XDEBUG_SESSION"}],"responseTime":null,"body":"{\"response_code\":\"425\"}"}],"_postman_id":"0bd2b88d-050c-4889-b4c8-0d24e81007af"},{"name":"shipping_method_find","id":"d35050ac-9d99-4033-8312-4e81d80f2832","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_username}}"},{"key":"password","value":"{{api_password}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"campaign_id\":\"all\",\n\t\"search_type\":\"all\",\n\t\"criteria\":\n\t{\n\t\t\"code\":\"first\",\n\t\t\"name\":\"*Shipping\",\n\t\t\"group\":\"First*\"\n\t},\n\t\"return_type\":\"shipping_method_view\"\n}"},"url":"https://{{app_key}}.{{domain}}{{api_ext}}shipping_method_find","description":"This method is used to retrieve a list of shipping_id that match a set of criteria.
Wildcards may be used when full data is not available.
\nAn optional parameter, return_type, may be passed. If return_type is sent as shipping_method_view, in addition to the normal return parameters you will also receive a data parameter that contains an object of the data returned by the shipping_method_view method for each shipping method returned by the request.
See the shipping_method_view definition for return values.
Max Requests Per Minute: 120
\n","urlObject":{"protocol":"https","host":["{{app_key}}","{{domain}}{{api_ext}}shipping_method_find"],"query":[],"variable":[]}},"response":[{"id":"3a98c246-2c31-4eca-9945-00c3927e1c1d","name":"shipping_method_find with criteria","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","disabled":false}],"body":{"mode":"raw","raw":"{\n\t\"campaign_id\":\"all\",\n\t\"search_type\":\"all\",\n\t\"criteria\":\n\t{\n\t\t\"code\":\"first\",\n\t\t\"name\":\"*Shipping\",\n\t\t\"group\":\"First*\"\n\t},\n\t\"return_type\":\"shipping_method_view\"\n}"},"url":"https://{{app_key}}.{{domain}}{{api_ext}}shipping_method_find"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Connection","value":"keep-alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Length","value":"511","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 06 Jul 2018 13:44:33 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains;","name":"Strict-Transport-Security","description":"A HSTS Policy informing the HTTP client how long to cache the HTTPS only policy and whether this applies to subdomains."},{"key":"Vary","value":"Authorization","name":"Vary","description":"Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."}],"cookie":[{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":false,"domain":"dev.limelightcrm.com","path":"/","secure":true,"value":"PHPSTORM","key":"XDEBUG_SESSION"}],"responseTime":null,"body":"{\"response_code\":\"100\",\"total_shipping_methods\":\"2\",\"shipping_id\":[\"2\",\"3\"],\"data\":{\"2\":{\"response_code\":\"100\",\"name\":\"Free Shipping\",\"description\":\"Initial Free - Subscription $1\",\"group_name\":\"First Class Mail\",\"code\":\"FIRST\",\"initial_amount\":\"0.00\",\"subscription_amount\":\"1.00\"},\"3\":{\"response_code\":\"100\",\"name\":\"Overnight Shipping\",\"description\":\"Overnight Shipping. 5.99 - Initial. 4.99 - Subscription\",\"group_name\":\"First Class Mail\",\"code\":\"FIRST\",\"initial_amount\":\"5.99\",\"subscription_amount\":\"4.99\"}}}"},{"id":"ab07c7bd-ae23-462e-9181-375bfa779bb0","name":"shipping_method_find","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","disabled":false}],"body":{"mode":"raw","raw":"{\n\t\"campaign_id\":\"all\",\n\t\"search_type\":\"all\",\n\t\"criteria\":\"all\",\n\t\"return_type\":\"shipping_method_view\"\n}"},"url":"https://{{app_key}}.{{domain}}{{api_ext}}shipping_method_find"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Connection","value":"keep-alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Length","value":"511","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 06 Jul 2018 13:43:08 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains;","name":"Strict-Transport-Security","description":"A HSTS Policy informing the HTTP client how long to cache the HTTPS only policy and whether this applies to subdomains."},{"key":"Vary","value":"Authorization","name":"Vary","description":"Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."}],"cookie":[{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":false,"domain":"dev.limelightcrm.com","path":"/","secure":true,"value":"PHPSTORM","key":"XDEBUG_SESSION"}],"responseTime":null,"body":"{\"response_code\":\"100\",\"total_shipping_methods\":\"2\",\"shipping_id\":[\"2\",\"3\"],\"data\":{\"2\":{\"response_code\":\"100\",\"name\":\"Free Shipping\",\"description\":\"Initial Free - Subscription $1\",\"group_name\":\"First Class Mail\",\"code\":\"FIRST\",\"initial_amount\":\"0.00\",\"subscription_amount\":\"1.00\"},\"3\":{\"response_code\":\"100\",\"name\":\"Overnight Shipping\",\"description\":\"Overnight Shipping. 5.99 - Initial. 4.99 - Subscription\",\"group_name\":\"First Class Mail\",\"code\":\"FIRST\",\"initial_amount\":\"5.99\",\"subscription_amount\":\"4.99\"}}}"}],"_postman_id":"d35050ac-9d99-4033-8312-4e81d80f2832"},{"name":"shipping_method_view","id":"4edf73f6-c95a-4da2-a4b8-b1699dad10ac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_username}}"},{"key":"password","value":"{{api_password}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"shipping_id\":\"2\"\n}"},"url":"https://{{app_key}}.{{domain}}{{api_ext}}shipping_method_view","description":"This method is used view data about a shipping method in the sticky.io platform.
\nMax Requests Per Minute: 120
\n","urlObject":{"protocol":"https","host":["{{app_key}}","{{domain}}{{api_ext}}shipping_method_view"],"query":[],"variable":[]}},"response":[{"id":"6eb1e033-9faf-4810-9d95-61303415de29","name":"shipping_method_view","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","disabled":false}],"body":{"mode":"raw","raw":"{\n\t\"shipping_id\":\"2\"\n}"},"url":"https://{{app_key}}.{{domain}}{{api_ext}}shipping_method_view"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Connection","value":"keep-alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Length","value":"193","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 06 Jul 2018 13:45:40 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains;","name":"Strict-Transport-Security","description":"A HSTS Policy informing the HTTP client how long to cache the HTTPS only policy and whether this applies to subdomains."},{"key":"Vary","value":"Authorization","name":"Vary","description":"Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."}],"cookie":[{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":false,"domain":"dev.limelightcrm.com","path":"/","secure":true,"value":"PHPSTORM","key":"XDEBUG_SESSION"}],"responseTime":null,"body":"{\"response_code\":\"100\",\"name\":\"Free Shipping\",\"description\":\"Initial Free - Subscription $1\",\"group_name\":\"First Class Mail\",\"code\":\"FIRST\",\"initial_amount\":\"0.00\",\"subscription_amount\":\"1.00\"}"}],"_postman_id":"4edf73f6-c95a-4da2-a4b8-b1699dad10ac"}],"id":"17e870a1-23c4-4594-8e61-f7d29feb92a6","_postman_id":"17e870a1-23c4-4594-8e61-f7d29feb92a6","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_username}}"},{"key":"password","value":"{{api_password}}"}]},"isInherited":true,"source":{"_postman_id":"9750fd0a-0874-4138-b29f-3d620fdb9e7c","id":"9750fd0a-0874-4138-b29f-3d620fdb9e7c","name":"sticky.io JSON API & Integration v2025.7.31","type":"collection"}}},{"name":"Campaigns","item":[{"name":"campaign_find_active","id":"8345422e-6d85-49af-967a-40aadb27fa40","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_username}}"},{"key":"password","value":"{{api_password}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://{{app_key}}.{{domain}}{{api_ext}}campaign_find_active","description":"Find all active campaigns that the API User has permission to.
\nMax Requests Per Minute: 120
\n","urlObject":{"protocol":"https","host":["{{app_key}}","{{domain}}{{api_ext}}campaign_find_active"],"query":[],"variable":[]}},"response":[{"id":"8982298a-54fb-460f-8e04-58200e16f6b8","name":"campaign_find_active","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://{{app_key}}.{{domain}}{{api_ext}}campaign_find_active"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"response_code\": \"100\",\n \"campaigns\": {\n \"3\": {\n \"campaign_id\": \"3\",\n \"campaign_name\": \"Straight Sale\"\n },\n \"4\": {\n \"campaign_id\": \"4\",\n \"campaign_name\": \"15 / 30 Day Self Recur\"\n },\n \"5\": {\n \"campaign_id\": \"5\",\n \"campaign_name\": \"15 / 30 / Straight Sale\"\n },\n \"7\": {\n \"campaign_id\": \"7\",\n \"campaign_name\": \"Custom Recur - 15 Days\"\n },\n \"9\": {\n \"campaign_id\": \"9\",\n \"campaign_name\": \"PREPAY 15 Days No Refund\"\n },\n \"10\": {\n \"campaign_id\": \"10\",\n \"campaign_name\": \"Self Recur (15 / 30 Days) - Expires after 2 Cycles\"\n }\n }\n}"}],"_postman_id":"8345422e-6d85-49af-967a-40aadb27fa40"},{"name":"campaign_view","id":"cf37e4ac-fac2-4671-a400-9493aac40664","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_username}}"},{"key":"password","value":"{{api_password}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"campaign_id\":10\n}"},"url":"https://{{app_key}}.{{domain}}{{api_ext}}campaign_view","description":"View the details of a campaign.
\nMax Requests Per Minute: 120
\nIn this section you will find information relating to Campaigns
\n","event":[{"listen":"prerequest","script":{"id":"fb7f10a9-613c-48fd-929a-e1b010b1faad","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"03b60b19-0476-43bf-8fa5-ee7b98a1d5a6","type":"text/javascript","exec":[""]}}],"_postman_id":"ffd59490-8dca-407d-a54b-07c60839e15a","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_username}}"},{"key":"password","value":"{{api_password}}"}]},"isInherited":true,"source":{"_postman_id":"9750fd0a-0874-4138-b29f-3d620fdb9e7c","id":"9750fd0a-0874-4138-b29f-3d620fdb9e7c","name":"sticky.io JSON API & Integration v2025.7.31","type":"collection"}}},{"name":"Prospects","item":[{"name":"new_prospect","id":"0c888f79-8ff8-435f-b5e9-f6b0f6357123","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_username}}"},{"key":"password","value":"{{api_password}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"campaignId\":\"2\",\n\t\"email\":\"testprospect@email.com\",\n\t\"ipAddress\":\"127.0.0.1\",\n\t\"firstName\":\"\",\n\t\"lastName\":\"\",\n\t\"address1\":\"\",\n\t\"address2\":\"\",\n\t\"city\":\"\",\n\t\"state\":\"\",\n\t\"zip\":\"\",\n\t\"country\":\"\",\n\t\"phone\":\"\",\n\t\"AFID\":\"\",\n\t\"SID\":\"\",\n\t\"AFFID\":\"\",\n\t\"C1\":\"\",\n\t\"C2\":\"\",\n\t\"C3\":\"\",\n\t\"AID\":\"\",\n\t\"OPT\":\"\",\n\t\"click_id\":\"\",\n\t\"notes\":\"\"\n}"},"url":"https://{{app_key}}.{{domain}}{{api_ext}}new_prospect","description":"The new_prospect API call is meant to allow you to do a two-step order where you capture initial prospect information and our API will return to you the prospect ID in the system. If you capture all elements initially required for sale, then it is easy to submit the final order like the below new_order_with_prospect post.
We allow our API calls to be flexible, where we only require email, campaignId and ipAddress when you create it in situations where that information is not available. If you use it like this, please ensure to pass the other missing elements when you place the new_order_with_prospect.
Please note that it is recommended to send a complete record with all available fields to pass upon initially sending the prospect through the new_prospect call to reduce confusion of what fields are required during the sale. An example would be if you do not pass ipAddress through the prospect record and do not prompt or require ipAddress during the new_order_with_prospect. Our systems will reject that because there is a blank value on the ipAddress.
Request:
\nResponse:
\n","urlObject":{"protocol":"https","host":["{{app_key}}","{{domain}}{{api_ext}}new_prospect"],"query":[],"variable":[]}},"response":[{"id":"4be645c4-35c6-456e-83d2-d9d2bf9e5564","name":"new_prospect","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"text/plain"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"campaignId\":\"2\",\n\t\"email\":\"testprospect@email.com\",\n\t\"ipAddress\":\"127.0.0.1\",\n\t\"firstName\":\"\",\n\t\"lastName\":\"\",\n\t\"address1\":\"\",\n\t\"address2\":\"\",\n\t\"city\":\"\",\n\t\"state\":\"\",\n\t\"zip\":\"\",\n\t\"country\":\"\",\n\t\"phone\":\"\",\n\t\"AFID\":\"\",\n\t\"SID\":\"\",\n\t\"AFFID\":\"\",\n\t\"C1\":\"\",\n\t\"C2\":\"\",\n\t\"C3\":\"\",\n\t\"AID\":\"\",\n\t\"OPT\":\"\",\n\t\"click_id\":\"\",\n\t\"notes\":\"\"\n}"},"url":"https://{{app_key}}.{{domain}}{{api_ext}}new_prospect"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Connection","value":"keep-alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Length","value":"60","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Mon, 23 Jul 2018 13:20:35 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Apache/2.4.33 (Amazon)","name":"Server","description":"A name for the server"},{"key":"Vary","value":"Authorization","name":"Vary","description":"Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."}],"cookie":[],"responseTime":null,"body":"{\"response_code\":\"100\",\"error_found\":\"0\",\"prospectId\":\"303\"}"}],"_postman_id":"0c888f79-8ff8-435f-b5e9-f6b0f6357123"},{"name":"prospect_find","id":"28ed9eff-848b-415e-9aa9-655fe1030b37","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_username}}"},{"key":"password","value":"{{api_password}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"campaign_id\":\"all\",\n\t\"start_date\":\"07/01/2018\",\n\t\"end_date\":\"07/04/2018\",\n\t\"criteria\":\n\t{\n\t\t\"first_name\":\"John\",\n\t\t\"last_name\":\"Doe\",\n\t\t\"address\":\"123 Test*\",\n\t\t\"city\":\"Tampa\",\n\t\t\"state\":\"FL\",\n\t\t\"zip\":\"33*\",\n\t\t\"country\":\"US\",\n\t\t\"phone\":\"813555*\",\n\t\t\"email\":\"johndoe*\",\n\t\t\"ip_address\":\"1*\"\n\t},\n\t\"start_time\":\"\",\n\t\"end_time\":\"\",\n\t\"search_type\":\"all\",\n\t\"return_type\":\"prospect_view\"\n}"},"url":"https://{{app_key}}.{{domain}}{{api_ext}}prospect_find","description":"This method is used to retrieve a list of prospect_id that match a set of criteria.
Wildcards may be used when full data is not available.
\nAn optional parameter, return_type, may be passed. If return_type is sent as prospect_view, in addition to the normal return parameters you will also receive a data parameter that contains a payload of the data returned by the prospect_view method for each prospect returned from the supplied search criteria
See the prospect_view definition for return values of the data parameter.
Max Requests Per Minute: 120
\nNOTE As of 10/24/2018 The total_prospects number will be a total number of prospects that meet the criteria passed. The max returned prospect_ids AND corresponding data if return_type of prospect_view is passed is 10000
This method is currently used to update a range of values on a prospect record
\nIf all updates are successful, the response will include only the response_code of 100.
If there are any failures or updates that did not occur, the response will include a breakdown of each prospect and each field that was attempted to be updated with their respective response_codes.
Max Requests Per Minute: 120
\n","urlObject":{"protocol":"https","host":["{{app_key}}","{{domain}}{{api_ext}}prospect_update"],"query":[],"variable":[]}},"response":[{"id":"cd2738ae-a091-4d76-a05f-324d810c0c65","name":"prospect_update","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","disabled":false}],"body":{"mode":"raw","raw":"{\n\t\"prospect_id\":\n\t{\n\t\t\"250\":\n\t\t{\n\t\t\t\"first_name\":\"John\",\n\t\t\t\"last_name\":\"Doe\",\n\t\t\t\"address\":\"1234 Ashton New Rd\",\n\t\t\t\"address2\":\"Apt B\",\n\t\t\t\"city\":\"Manchester\",\n\t\t\t\"state\":\"Manchester\",\n\t\t\t\"zip\":\"M11 3FF\",\n\t\t\t\"country\":\"GB\",\n\t\t\t\"phone\":\"8135551218\",\n\t\t\t\"email\":\"updated_email@server.com\",\n\t\t\t\"notes\":\"Add this via Postman\"\n\t\t}\n\t}\n}"},"url":"https://{{app_key}}.{{domain}}{{api_ext}}prospect_update"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Connection","value":"keep-alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Length","value":"23","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 06 Jul 2018 12:53:06 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains;","name":"Strict-Transport-Security","description":"A HSTS Policy informing the HTTP client how long to cache the HTTPS only policy and whether this applies to subdomains."},{"key":"Vary","value":"Authorization","name":"Vary","description":"Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."}],"cookie":[{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":false,"domain":"dev.limelightcrm.com","path":"/","secure":true,"value":"PHPSTORM","key":"XDEBUG_SESSION"}],"responseTime":null,"body":"{\"response_code\":\"100\"}"}],"_postman_id":"c1e65f32-eb37-48e5-904a-bc4ed02134cf"},{"name":"prospect_view","id":"1db4aee8-cf8a-4f79-ba11-cf9eacc61584","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_username}}"},{"key":"password","value":"{{api_password}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"prospect_id\":\"361614\"\n}"},"url":"https://{{app_key}}.{{domain}}{{api_ext}}prospect_view","description":"This method is to view information about a prospect.
\nMax Requests Per Minute: 120
\n","urlObject":{"protocol":"https","host":["{{app_key}}","{{domain}}{{api_ext}}prospect_view"],"query":[],"variable":[]}},"response":[{"id":"fcc7f033-b5aa-4566-ae2d-2362ffed645b","name":"prospect_view","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"prospect_id\":\"361315\"\n}"},"url":"https://{{app_key}}.{{domain}}{{api_ext}}prospect_view"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Wed, 10 Oct 2018 18:34:51 GMT"},{"key":"Server","value":"Apache/2.4.34 (Amazon)"},{"key":"Vary","value":"Authorization"},{"key":"Content-Length","value":"502"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"response_code\": \"100\",\n \"campaign_id\": \"25\",\n \"first_name\": \"Edith\",\n \"last_name\": \"Cain\",\n \"address\": \"3676 Center Avenue\",\n \"address2\": \"\",\n \"city\": \"Winter Park\",\n \"state\": \"FL\",\n \"state_id\": \"FL\",\n \"zip\": \"32792\",\n \"country\": \"US\",\n \"phone\": \"800-555-1212\",\n \"email\": \"ecain361315@gmail.test\",\n \"ip_address\": \"127.0.0.1\",\n \"date_created\": \"2017-03-21 06:34:00\",\n \"affiliate\": \"\",\n \"sub_affiliate\": \"\",\n \"risk_flag\": \"0\",\n \"notes\": [\n \"/v2/?AFFID=213312&C1=&C2=dNKK3M9O9VKHSA34HCBVRDDM&click_id=72676905\",\n \"Another note!\",\n \"Try a new one\",\n \"and another\"\n ]\n}"}],"_postman_id":"1db4aee8-cf8a-4f79-ba11-cf9eacc61584"}],"id":"63395250-4b34-4d60-a43f-912533773fd9","_postman_id":"63395250-4b34-4d60-a43f-912533773fd9","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_username}}"},{"key":"password","value":"{{api_password}}"}]},"isInherited":true,"source":{"_postman_id":"9750fd0a-0874-4138-b29f-3d620fdb9e7c","id":"9750fd0a-0874-4138-b29f-3d620fdb9e7c","name":"sticky.io JSON API & Integration v2025.7.31","type":"collection"}}},{"name":"Payments","item":[{"name":"authorize_payment","id":"72b56d13-d851-4c1a-a829-478ace0f21d6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_username}}"},{"key":"password","value":"{{api_password}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n\t\"billingFirstName\": \"PostingBilling\",\r\n\t\"billingLastName\": \"APILastname\",\r\n\t\"billingAddress1\": \"56 Escobar St\",\r\n\t\"billingAddress2\": \"FL 7\",\r\n\t\"billingCity\": \"Houston\",\r\n\t\"billingState\": \"TX\",\r\n\t\"billingZip\": \"33655\",\r\n\t\"billingCountry\": \"US\",\r\n\t\"phone\": \"8135551212\",\r\n\t\"email\": \"postman@apitest.com\",\r\n\t\"creditCardType\": \"VISA\",\r\n\t\"creditCardNumber\": \"1444444444444440\",\r\n\t\"expirationDate\": \"0628\",\r\n\t\"CVV\": \"123\",\r\n\t\"shippingId\": \"2\",\r\n\t\"tranType\": \"Sale\",\r\n\t\"ipAddress\": \"198.4.3.2\",\r\n\t\"campaignId\": \"4\",\r\n\t\"products\":\r\n\t{\r\n\t\t\"16\":\r\n\t\t{\r\n\t\t\t\"offer_id\":\"8\",\r\n\t\t\t\"billing_model_id\":\"4\",\r\n\t\t\t\"quantity\":\"2\"\r\n\t\t},\r\n\t\t\"4\":\r\n\t\t{\r\n\t\t\t\"offer_id\": \"8\",\r\n\t\t\t\"billing_model_id\": \"6\",\r\n\t\t\t\"quantity\": \"1\",\r\n\t\t\t\"children\":\r\n\t\t\t[\r\n\t\t\t\t{\r\n\t\t\t\t\t\"product_id\":\"1\",\r\n\t\t\t\t\t\"quantity\":\"2\"\r\n\t\t\t\t},\r\n\t\t\t\t{\r\n\t\t\t\t\t\"product_id\":\"2\",\r\n\t\t\t\t\t\"quantity\":\"1\"\r\n\t\t\t\t}\r\n\t\t\t]\r\n\t\t}\r\n\t},\r\n\t\"gift\":\r\n\t{\r\n\t\t\"email\":\"gift@email.com\",\r\n\t\t\"message\":\"This is a gift order and this is a gift message\"\r\n\t},\r\n\t\"notes\": \"This is a test order\",\r\n\t\"AFID\":\"AFID\",\r\n\t\"SID\":\"SID\",\r\n\t\"AFFID\":\"AFFID\",\r\n\t\"C1\":\"C1\",\r\n\t\"C2\":\"C2\",\r\n\t\"C3\":\"C3\",\r\n\t\"AID\":\"AID\",\r\n\t\"OPT\":\"OPT\",\r\n\t\"click_id\":\"abc123\",\r\n\t\"billingSameAsShipping\":\"YES\",\r\n\t\"shippingAddress1\": \"123 Medellin St\",\r\n\t\"shippingAddress2\": \"APT 7\",\r\n\t\"shippingCity\": \"Santo Alto\",\r\n\t\"shippingState\": \"TX\",\r\n\t\"shippingZip\": \"33544\",\r\n\t\"shippingCountry\": \"US\",\r\n\t\"forceGatewayId\":\"\",\r\n\t\"preserve_force_gateway\":\"\",\r\n\t\"createdBy\":\"\",\r\n\t\"thm_session_id\":\"\",\r\n\t\"total_installments\":\"\",\r\n\t\"alt_pay_token\":\"\",\r\n\t\"alt_pay_payer_id\":\"\",\r\n\t\"secretSSN\":\"\",\r\n\t\"force_subscription_cycle\":\"\",\r\n\t\"recurring_days\":\"\",\r\n\t\"subscription_week\":\"\",\r\n\t\"subscription_day\":\"\",\r\n\t\"master_order_id\":\"\",\r\n\t\"promoCode\":\"\",\r\n\t\"temp_customer_id\":\"\",\r\n\t\"three_d_redirect_url\":\"\",\r\n\t\"alt_pay_return_url\":\"\",\r\n\t\"sessionId\":\"\",\r\n\t\"cascade_override\":\"\",\r\n\t\"create_member\":\"\",\r\n\t\"event_id\":\"\",\r\n\t\"ssn_nmi\":\"\",\r\n\t\"utm_source\": \"source\",\r\n\t\"utm_medium\": \"medium\",\r\n\t\"utm_campaign\": \"campaign\",\r\n\t\"utm_content\": \"content\",\r\n\t\"utm_term\": \"term\",\r\n\t\"device_category\":\"mobile\",\r\n\t\"checkingAccountNumber\":\"\",\r\n\t\"checkingRoutingNumber\":\"\",\r\n\t\"sepa_iban\":\"\",\r\n\t\"sepa_bic\":\"\",\r\n\t\"eurodebit_acct_num\":\"\",\r\n\t\"eurodebit_route_num\":\"\",\r\n\t\"referrer_id\":\"\"\r\n}"},"url":"https://{{app_key}}.{{domain}}{{api_ext}}authorize_payment","description":"This method utilizes the billing and card data fields used by new_order, as well as some basic CRM identifiers for campaign and product, and sends an authorization request to the gateway. No order is created. Upon successful authorization, the transaction information will be returned, otherwise the decline reason is provided. If no auth_amount is provided, it will default to a 1.00 authorization.
Max Requests Per Minute: 120
\nAn optional parameter save_customer will temporarily save the encrypted card data. Upon successfully saving the information, you will receive a temp_customer_id in the response in which this Id will be available for use with the new_order, new_order_card_on_file, or new_order_with_prospect method for up to 24 hours after the call is made. To extend the duration of a temporary customer, pass the save_customer_days parameter and a value between 1 and 30.
View the details of a gateway. Can be one gateway id or an array of gateway ids in the request body.
\nThe gateway_view method is used view the details of a particular or list of gateways from within the CRM. The max returned gateways is 1000
Max Requests Per Minute: 120
\nUsed to retrieve redirection information for alternative payment providers, such as Paypal Express, Paypal, Amazon, or Ice Pay. The fields from alt_pay_type to amount are REQUIRED, all fields below that are OPTIONAL.
Max Requests Per Minute: 120
\n","urlObject":{"protocol":"https","host":["{{app_key}}","{{domain}}{{api_ext}}get_alternative_provider"],"query":[],"variable":[]}},"response":[],"_postman_id":"2f608124-6d27-46a7-b183-9a09ecb7b52a"},{"name":"payment_router_view","id":"af15ff03-dc51-4fec-a96a-9b3d0bf53c73","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_username}}"},{"key":"password","value":"{{api_password}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"payment_router_id\":\n\t[\n\t\t\"1\"\n\t]\n}"},"url":"https://{{app_key}}.{{domain}}{{api_ext}}payment_router_view","description":"This method is used to display desired payment router(s) and the related gateway details. payment_router_id needs to be specified as a single or csv of payment router ids.
Max Requests Per Minute: 120
\nEndFragment
\nThe payload of the data response parameter mentioned in the table above (payment_router_view) is returned as a JSON object. This contains payment router details matching the criteria of the request parameters. Here's a bit on the structure of each returned object:
The payload for each of the payment routers gateways from the previous table above is returned as a list of JSON objects. This return details for each gateway is formatted like in the table below.
This method is use for orders that return response code 101 from the NewOrder method. This method redirects the customer to their personal bank URL for 3D Secure payments.
\nMax Requests Per Minute: 120
\nThis method utilizes the billing and card data fields used by new_order, as well as some basic CRM identifiers for campaign and product, and sends an authorization request to the gateway. No order is created. Upon successful authorization, the transaction information will be returned, otherwise the decline reason is provided. If no auth_amount is provided, it will default to a 1.00 authorization.
Max Requests Per Minute: 120
\nAn optional parameter save_customer will temporarily save the encrypted card data. Upon successfully saving the information, you will receive a temp_customer_id in the response in which this Id will be available for use with the new_order, new_order_card_on_file, or new_order_with_prospect method for up to 24 hours after the call is made. To extend the duration of a temporary customer, pass the save_customer_days parameter and a value between 1 and 30.
The coupon_validate method is used to check if a promo code that was entered is still valid to apply the discount.
\nMax Requests Per Minute: 120
\n","urlObject":{"protocol":"https","host":["{{app_key}}","{{domain}}{{api_ext}}coupon_validate"],"query":[],"variable":[]}},"response":[{"id":"46c167e1-a8aa-4bb1-9826-dfeeae847337","name":"coupon_validate","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"campaign_id\": 1,\n \"shipping_id\": 4,\n \"email\": \"postman@sticky.io\",\n \"products\": [\n {\n \"product_id\": 1,\n \"quantity\": 2\n },\n {\n \"product_id\": 2,\n \"quantity\": 1\n },\n {\n \"product_id\": 3\n },\n {\n \"product_id\": 4\n },\n {\n \"product_id\": 5\n }\n ],\n \"promo_code\": \"10percent\"\n}","options":{"raw":{"language":"json"}}},"url":"https://{{app_key}}.{{domain}}{{api_ext}}coupon_validate"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"response_code\": \"100\",\n \"coupon_amount\": \"18.6\"\n}"}],"_postman_id":"53cffad4-27ed-45d1-a355-c742daf29dc0"},{"name":"new_order","id":"0dddabee-997a-4b00-8f47-d560493cb1b7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"firstName\": \"Currencytest\",\r\n \"lastName\": \"Test\",\r\n \"currency\": \"JPYY\",\r\n \"billingFirstName\": \"LimeLight\",\r\n \"billingLastName\": \"Test\",\r\n \"billingAddress1\": \"123 Test St\",\r\n \"billingCity\": \"Palm Harbor\",\r\n \"billingState\": \"FL\",\r\n \"billingZip\": \"34684\",\r\n \"billingCountry\": \"US\",\r\n \"phone\": \"9876543210\",\r\n \"email\": \"currencytest@apitest.com\",\r\n \"creditCardType\": \"VISA\",\r\n \"creditCardNumber\": \"4263982640269299\",\r\n \"expirationDate\": \"0223\",\r\n \"CVV\": \"837\",\r\n \"shippingId\": \"52\",\r\n \"tranType\": \"Sale\",\r\n \"ipAddress\": \"2600:1003:b110:ce17:fc26:ae54:ad0d:f67\",\r\n \"campaignId\": \"557\",\r\n \"offers\": [\r\n {\r\n \"offer_id\": 704,\r\n \"product_id\": 855,\r\n \"billing_model_id\": 2,\r\n \"quantity\": 1\r\n },\r\n {\r\n \"offer_id\": 704,\r\n \"product_id\": 884,\r\n \"billing_model_id\": 547,\r\n \"quantity\": 1\r\n }\r\n ],\r\n \"billingSameAsShipping\": \"YES\",\r\n \"shippingAddress1\": \"123 Test St\",\r\n \"shippingCity\": \"Palm Harbor\",\r\n \"shippingState\": \"FL\",\r\n \"shippingZip\": \"34684\",\r\n \"shippingCountry\": \"US\",\r\n \"forceGatewayId\": \"704\",\r\n \"preserve_force_gateway\": \"1\"\r\n}"},"url":"https://{{app_key}}.{{domain}}{{api_ext}}new_order","description":"Place a new order. Parameters in the example request from firstName to product are REQUIRED with the exception of billingAddress2. For orders with only digital products, parameters from firstName to product are NOT REQUIRED with the exception of billingCountry. Fields beyond that are OPTIONAL See Orders section for a table of required and optional parameters.
Place order with member token and omit payment information. An order can be placed by passing the member object and including the member token and wallet id. Billing address id and shipping address id are optional but if is passed they will replace the addresses that correspond to that wallet id.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_username}}"},{"key":"password","value":"{{api_password}}"}]},"isInherited":true,"source":{"_postman_id":"9750fd0a-0874-4138-b29f-3d620fdb9e7c","id":"9750fd0a-0874-4138-b29f-3d620fdb9e7c","name":"sticky.io JSON API & Integration v2025.7.31","type":"collection"}},"urlObject":{"protocol":"https","host":["{{app_key}}","{{domain}}{{api_ext}}new_order"],"query":[],"variable":[]}},"response":[{"id":"53a58e5c-de7a-458c-af07-b61be60a2ab7","name":"new_order with trial, step_num and bundle children","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"firstName\":\"Postman\",\r\n \"lastName\":\"API\",\r\n \"billingFirstName\":\"PostingBilling\",\r\n \"billingLastName\":\"APILastname\",\r\n \"billingAddress1\":\"56 Escobar St\",\r\n \"billingAddress2\":\"FL 7\",\r\n \"billingCity\":\"Houston\",\r\n \"billingState\":\"TX\",\r\n \"billingZip\":\"33655\",\r\n \"billingCountry\":\"US\",\r\n \"phone\":\"8135551212\",\r\n \"email\":\"postman@apitest.com\",\r\n \"creditCardType\":\"VISA\",\r\n \"creditCardNumber\":\"1444444444444440\",\r\n \"expirationDate\":\"0628\",\r\n \"CVV\":\"123\",\r\n \"shippingId\":\"2\",\r\n \"tranType\":\"Sale\",\r\n \"ipAddress\":\"198.4.3.2\",\r\n \"campaignId\":\"4\",\r\n \"offers\":\r\n [\r\n {\r\n \"offer_id\":\"8\",\r\n \"product_id\":\"4\",\r\n \"billing_model_id\":\"6\",\r\n \"quantity\":\"1\",\r\n \"children\":\r\n [\r\n {\r\n \"product_id\":\"1\",\r\n \"quantity\":\"2\"\r\n },\r\n {\r\n \"product_id\":\"2\",\r\n \"quantity\":\"1\"\r\n }\r\n ]\r\n },\r\n {\r\n \"offer_id\":\"8\",\r\n \"product_id\":16,\r\n \"billing_model_id\":\"4\",\r\n \"quantity\":\"2\",\r\n \"step_num\":\"2\",\r\n \"trial\":\r\n {\r\n \t\"product_id\":16\r\n }\r\n }\r\n ],\r\n \"gift\":\r\n {\r\n \"email\":\"gift@email.com\",\r\n \"message\":\"This is a gift order and this is a gift message\"\r\n },\r\n \"notes\":\"This is a test order using new_order\",\r\n \"AFID\":\"AFID\",\r\n \"SID\":\"SID\",\r\n \"AFFID\":\"AFFID\",\r\n \"C1\":\"C1\",\r\n \"C2\":\"C2\",\r\n \"C3\":\"C3\",\r\n \"AID\":\"AID\",\r\n \"OPT\":\"OPT\",\r\n \"click_id\":\"abc123\",\r\n \"billingSameAsShipping\":\"YES\",\r\n \"shippingAddress1\":\"123 Medellin St\",\r\n \"shippingAddress2\":\"APT 7\",\r\n \"shippingCity\":\"Santo Alto\",\r\n \"shippingState\":\"TX\",\r\n \"shippingZip\":\"33544\",\r\n \"shippingCountry\":\"US\",\r\n \"forceGatewayId\":\"\",\r\n \"preserve_force_gateway\":\"\",\r\n \"thm_session_id\":\"\",\r\n \"total_installments\":\"\",\r\n \"alt_pay_token\":\"\",\r\n \"alt_pay_payer_id\":\"\",\r\n \"secretSSN\":\"\",\r\n \"promoCode\":\"\",\r\n \"temp_customer_id\":\"\",\r\n \"three_d_redirect_url\":\"\",\r\n \"alt_pay_return_url\":\"\",\r\n \"sessionId\":\"\",\r\n \"cascade_override\":\"\",\r\n \"create_member\":\"\",\r\n \"event_id\":\"\",\r\n \"ssn_nmi\":\"\",\r\n \"utm_source\":\"source\",\r\n \"utm_medium\":\"medium\",\r\n \"utm_campaign\":\"campaign\",\r\n \"utm_content\":\"content\",\r\n \"utm_term\":\"term\",\r\n \"device_category\":\"mobile\",\r\n \"checkingAccountNumber\":\"\",\r\n \"checkingRoutingNumber\":\"\",\r\n \"sepa_iban\":\"\",\r\n \"sepa_bic\":\"\",\r\n \"eurodebit_acct_num\":\"\",\r\n \"eurodebit_route_num\":\"\",\r\n \"referrer_id\" : \"ABCD1234\",\r\n \"conversion_id\" : \"addc703c-6ffd-11e8-a1ea-12f0b4779fbe\",\r\n \"cavv\" : \"BwABAwJoEAAAAABhdWgQAAAAAAA=\",\r\n \"eci\" : \"06\",\r\n \"xid\" : \"YmUyMnFoMmJpbHM1aGJzNjd2MGc=\"\r\n}"},"url":"https://{{app_key}}.{{domain}}{{api_ext}}new_order"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Tue, 13 Nov 2018 12:10:00 GMT"},{"key":"Server","value":"Apache/2.4.34 (Amazon)"},{"key":"Vary","value":"Authorization"},{"key":"Content-Length","value":"460"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"gateway_id\": \"1\",\n \"response_code\": \"100\",\n \"error_found\": \"0\",\n \"order_id\": \"12927\",\n \"transactionID\": \"Not Available\",\n \"customerId\": \"430\",\n \"authId\": \"Not Available\",\n \"orderTotal\": \"61.95\",\n \"orderSalesTaxPercent\": \"0.00\",\n \"orderSalesTaxAmount\": \"0.00\",\n \"test\": \"1\",\n \"prepaid_match\": \"0\",\n \"gatewayCustomerService\": \"8885551212\",\n \"gatewayDescriptor\": \"TestDescriptor\",\n \"subscription_id\": {\n \"4\": \"6f6db5f617d682a7b592e93c298d29d7\",\n \"16\": \"87f6c17583b39bc5cec9ee7d71fc56d5\"\n },\n \"resp_msg\": \"Approved\"\n}"},{"id":"3374aaed-1d1f-46f7-aef5-b62c2a676c6c","name":"new_order with product variants","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"firstName\": \"Postman\",\n \"lastName\": \"API\",\n \"billingFirstName\": \"PostingBilling\",\n \"billingLastName\": \"APILastname\",\n \"billingAddress1\": \"56 Escobar St\",\n \"billingAddress2\": \"FL 7\",\n \"billingCity\": \"Houston\",\n \"billingState\": \"TX\",\n \"billingZip\": \"33655\",\n \"billingCountry\": \"US\",\n \"phone\": \"8135551212\",\n \"email\": \"postman@apitest.com\",\n \"creditCardType\": \"VISA\",\n \"creditCardNumber\": \"1444444444444440\",\n \"expirationDate\": \"0628\",\n \"CVV\": \"123\",\n \"shippingId\": \"2\",\n \"tranType\": \"Sale\",\n \"ipAddress\": \"198.4.3.2\",\n \"campaignId\": \"4\",\n \"offers\": [\n {\n \"offer_id\": 8,\n \"product_id\": 608,\n \"billing_model_id\": 2,\n \"quantity\": 2,\n \"variant\": [\n {\n \"attribute_name\": \"size\",\n \"attribute_value\": \"XL\"\n },\n {\n \"attribute_name\": \"color\",\n \"attribute_value\": \"Blue\"\n }\n ]\n }\n ],\n \"gift\": {\n \"email\": \"gift@email.com\",\n \"message\": \"This is a gift order and this is a gift message\"\n },\n \"notes\": \"This is a test order using new_order\",\n \"AFID\": \"AFID\",\n \"SID\": \"SID\",\n \"AFFID\": \"AFFID\",\n \"C1\": \"C1\",\n \"C2\": \"C2\",\n \"C3\": \"C3\",\n \"AID\": \"AID\",\n \"OPT\": \"OPT\",\n \"click_id\": \"abc123\",\n \"billingSameAsShipping\": \"YES\",\n \"shippingAddress1\": \"123 Medellin St\",\n \"shippingAddress2\": \"APT 7\",\n \"shippingCity\": \"Santo Alto\",\n \"shippingState\": \"TX\",\n \"shippingZip\": \"33544\",\n \"shippingCountry\": \"US\",\n \"forceGatewayId\": \"\",\n \"preserve_force_gateway\": \"\",\n \"thm_session_id\": \"\",\n \"total_installments\": \"\",\n \"alt_pay_token\": \"\",\n \"alt_pay_payer_id\": \"\",\n \"secretSSN\": \"\",\n \"promoCode\": \"\",\n \"temp_customer_id\": \"\",\n \"three_d_redirect_url\": \"\",\n \"alt_pay_return_url\": \"\",\n \"sessionId\": \"\",\n \"cascade_override\": \"\",\n \"create_member\": \"\",\n \"event_id\": \"\",\n \"ssn_nmi\": \"\",\n \"utm_source\": \"source\",\n \"utm_medium\": \"medium\",\n \"utm_campaign\": \"campaign\",\n \"utm_content\": \"content\",\n \"utm_term\": \"term\",\n \"device_category\": \"mobile\",\n \"checkingAccountNumber\": \"\",\n \"checkingRoutingNumber\": \"\",\n \"sepa_iban\": \"\",\n \"sepa_bic\": \"\",\n \"eurodebit_acct_num\": \"\",\n \"eurodebit_route_num\": \"\",\n \"referrer_id\": \"ABCD1234\",\n \"conversion_id\": \"addc703c-6ffd-11e8-a1ea-12f0b4779fbe\",\n \"cavv\": \"BwABAwJoEAAAAABhdWgQAAAAAAA=\",\n \"eci\": \"06\",\n \"xid\": \"YmUyMnFoMmJpbHM1aGJzNjd2MGc=\"\n}"},"url":"https://{{app_key}}.{{domain}}{{api_ext}}new_order"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Tue, 13 Nov 2018 12:21:17 GMT"},{"key":"Server","value":"Apache/2.4.34 (Amazon)"},{"key":"Vary","value":"Authorization"},{"key":"Content-Length","value":"422"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"gateway_id\": \"1\",\n \"response_code\": \"100\",\n \"error_found\": \"0\",\n \"order_id\": \"12930\",\n \"transactionID\": \"Not Available\",\n \"customerId\": \"430\",\n \"authId\": \"Not Available\",\n \"orderTotal\": \"29.90\",\n \"orderSalesTaxPercent\": \"0.00\",\n \"orderSalesTaxAmount\": \"0.00\",\n \"test\": \"1\",\n \"prepaid_match\": \"0\",\n \"gatewayCustomerService\": \"8885551212\",\n \"gatewayDescriptor\": \"TestDescriptor\",\n \"subscription_id\": {\n \"608\": \"ee36bc17ae9ab326a95498094ea3036d\"\n },\n \"resp_msg\": \"Approved\"\n}"},{"id":"b51b6860-4c85-4334-bc37-b48f6d9e3673","name":"new_order","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"firstName\":\"Postman\",\r\n \"lastName\":\"API\",\r\n \"billingFirstName\":\"PostingBilling\",\r\n \"billingLastName\":\"APILastname\",\r\n \"billingAddress1\":\"56 Escobar St\",\r\n \"billingAddress2\":\"FL 7\",\r\n \"billingCity\":\"Houston\",\r\n \"billingState\":\"TX\",\r\n \"billingZip\":\"33655\",\r\n \"billingCountry\":\"US\",\r\n \"phone\":\"8135551212\",\r\n \"email\":\"postman@apitest.com\",\r\n \"creditCardType\":\"VISA\",\r\n \"creditCardNumber\":\"1444444444444440\",\r\n \"expirationDate\":\"0628\",\r\n \"CVV\":\"123\",\r\n \"shippingId\":\"2\",\r\n \"tranType\":\"Sale\",\r\n \"ipAddress\":\"198.4.3.2\",\r\n \"campaignId\":\"4\",\r\n \"offers\":\r\n [\r\n {\r\n \"offer_id\":6,\r\n \"product_id\":608,\r\n \"billing_model_id\":2,\r\n \"quantity\":2,\r\n \"step_num\":2,\r\n \"variant\":\r\n [\r\n \t{\r\n \t\t\"attribute_name\":\"size\",\r\n \t\t\"attribute_value\":\"XL\"\r\n \t},\r\n \t{\r\n \t\t\"attribute_name\":\"color\",\r\n \t\t\"attribute_value\":\"Blue\"\r\n \t}\r\n ]\r\n },\r\n {\r\n \"offer_id\":10,\r\n \"product_id\":4,\r\n \"billing_model_id\":6,\r\n \"quantity\":1,\r\n \"price\":\"9.99\",\r\n \"children\":\r\n [\r\n {\r\n \"product_id\":1,\r\n \"quantity\":2\r\n },\r\n {\r\n \"product_id\":2,\r\n \"quantity\":1\r\n }\r\n ]\r\n },\r\n {\r\n \"offer_id\":8,\r\n \"product_id\":16,\r\n \"billing_model_id\":4,\r\n \"quantity\":2,\r\n \"step_num\":3,\r\n \"trial\":\r\n {\r\n \t\"product_id\":16,\r\n \t\"price\":\"9.99\"\r\n }\r\n }\r\n ],\r\n \"gift\":\r\n {\r\n \"email\":\"gift@email.com\",\r\n \"message\":\"This is a gift order and this is a gift message\"\r\n },\r\n \"notes\":\"This is a test order using new_order\",\r\n \"AFID\":\"AFID\",\r\n \"SID\":\"SID\",\r\n \"AFFID\":\"AFFID\",\r\n \"C1\":\"C1\",\r\n \"C2\":\"C2\",\r\n \"C3\":\"C3\",\r\n \"AID\":\"AID\",\r\n \"OPT\":\"OPT\",\r\n \"click_id\":\"abc123\",\r\n \"billingSameAsShipping\":\"YES\",\r\n \"shippingAddress1\":\"123 Medellin St\",\r\n \"shippingAddress2\":\"APT 7\",\r\n \"shippingCity\":\"Santo Alto\",\r\n \"shippingState\":\"TX\",\r\n \"shippingZip\":\"33544\",\r\n \"shippingCountry\":\"US\",\r\n \"forceGatewayId\":\"\",\r\n \"preserve_force_gateway\":\"\",\r\n \"thm_session_id\":\"\",\r\n \"total_installments\":\"\",\r\n \"alt_pay_token\":\"\",\r\n \"alt_pay_payer_id\":\"\",\r\n \"secretSSN\":\"\",\r\n \"promoCode\":\"\",\r\n \"temp_customer_id\":\"\",\r\n \"three_d_redirect_url\":\"\",\r\n \"alt_pay_return_url\":\"\",\r\n \"sessionId\":\"\",\r\n \"cascade_override\":\"\",\r\n \"create_member\":\"\",\r\n \"event_id\":\"\",\r\n \"ssn_nmi\":\"\",\r\n \"utm_source\":\"source\",\r\n \"utm_medium\":\"medium\",\r\n \"utm_campaign\":\"campaign\",\r\n \"utm_content\":\"content\",\r\n \"utm_term\":\"term\",\r\n \"device_category\":\"mobile\",\r\n \"checkingAccountNumber\":\"\",\r\n \"checkingRoutingNumber\":\"\",\r\n \"sepa_iban\":\"\",\r\n \"sepa_bic\":\"\",\r\n \"eurodebit_acct_num\":\"\",\r\n \"eurodebit_route_num\":\"\",\r\n \"referrer_id\" : \"ABCD1234\",\r\n \"conversion_id\" : \"addc703c-6ffd-11e8-a1ea-12f0b4779fbe\",\r\n \"cavv\" : \"BwABAwJoEAAAAABhdWgQAAAAAAA=\",\r\n \"eci\" : \"06\",\r\n \"xid\" : \"YmUyMnFoMmJpbHM1aGJzNjd2MGc=\"\r\n}"},"url":"https://{{app_key}}.{{domain}}{{api_ext}}new_order"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Tue, 13 Nov 2018 12:24:31 GMT"},{"key":"Server","value":"Apache/2.4.34 (Amazon)"},{"key":"Vary","value":"Authorization"},{"key":"Content-Length","value":"501"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"gateway_id\": \"1\",\n \"response_code\": \"100\",\n \"error_found\": \"0\",\n \"order_id\": \"12931\",\n \"transactionID\": \"Not Available\",\n \"customerId\": \"430\",\n \"authId\": \"Not Available\",\n \"orderTotal\": \"91.85\",\n \"orderSalesTaxPercent\": \"0.00\",\n \"orderSalesTaxAmount\": \"0.00\",\n \"test\": \"1\",\n \"prepaid_match\": \"0\",\n \"gatewayCustomerService\": \"8885551212\",\n \"gatewayDescriptor\": \"TestDescriptor\",\n \"subscription_id\": {\n \"4\": \"68071101c8102efc0cc8287d4ff1a00c\",\n \"16\": \"4daa794674453992c6245e0e4f29c74d\",\n \"608\": \"80780b41e986948a1c899336665dc640\"\n },\n \"resp_msg\": \"Approved\"\n}"},{"id":"8b61b951-ed7c-40c4-994e-d0aee13fb318","name":"new_order with current_prepaid_cycle","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"firstName\":\"Postman\",\r\n \"lastName\":\"API\",\r\n \"billingFirstName\":\"PostingBilling\",\r\n \"billingLastName\":\"APILastname\",\r\n \"billingAddress1\":\"56 Escobar St\",\r\n \"billingAddress2\":\"FL 7\",\r\n \"billingCity\":\"Houston\",\r\n \"billingState\":\"TX\",\r\n \"billingZip\":\"33655\",\r\n \"billingCountry\":\"US\",\r\n \"phone\":\"8135551212\",\r\n \"email\":\"postman@apitest.com\",\r\n \"creditCardType\":\"VISA\",\r\n \"creditCardNumber\":\"1444444444444440\",\r\n \"expirationDate\":\"0628\",\r\n \"CVV\":\"123\",\r\n \"shippingId\":\"2\",\r\n \"tranType\":\"Sale\",\r\n \"ipAddress\":\"198.4.3.2\",\r\n \"campaignId\":\"4\",\r\n \"offers\":\r\n [\r\n {\r\n \"offer_id\":2,\r\n \"product_id\":608,\r\n \"billing_model_id\":13,\r\n \"prepaid_cycles\": 5,\r\n \"current_prepaid_cycle\": 2, \r\n \"quantity\":2,\r\n \"variant\":\r\n [\r\n \t{\r\n \t\t\"attribute_name\":\"size\",\r\n \t\t\"attribute_value\":\"XL\"\r\n \t},\r\n \t{\r\n \t\t\"attribute_name\":\"color\",\r\n \t\t\"attribute_value\":\"Blue\"\r\n \t}\r\n ]\r\n }\r\n ],\r\n \"gift\":\r\n {\r\n \"email\":\"gift@email.com\",\r\n \"message\":\"This is a gift order and this is a gift message\"\r\n },\r\n \"notes\":\"This is a test order using new_order\",\r\n \"AFID\":\"AFID\",\r\n \"SID\":\"SID\",\r\n \"AFFID\":\"AFFID\",\r\n \"C1\":\"C1\",\r\n \"C2\":\"C2\",\r\n \"C3\":\"C3\",\r\n \"AID\":\"AID\",\r\n \"OPT\":\"OPT\",\r\n \"click_id\":\"abc123\",\r\n \"billingSameAsShipping\":\"YES\",\r\n \"shippingAddress1\":\"123 Medellin St\",\r\n \"shippingAddress2\":\"APT 7\",\r\n \"shippingCity\":\"Santo Alto\",\r\n \"shippingState\":\"TX\",\r\n \"shippingZip\":\"33544\",\r\n \"shippingCountry\":\"US\",\r\n \"forceGatewayId\":\"\",\r\n \"preserve_force_gateway\":\"\",\r\n \"thm_session_id\":\"\",\r\n \"total_installments\":\"\",\r\n \"alt_pay_token\":\"\",\r\n \"alt_pay_payer_id\":\"\",\r\n \"secretSSN\":\"\",\r\n \"promoCode\":\"\",\r\n \"temp_customer_id\":\"\",\r\n \"three_d_redirect_url\":\"\",\r\n \"alt_pay_return_url\":\"\",\r\n \"sessionId\":\"\",\r\n \"cascade_override\":\"\",\r\n \"create_member\":\"\",\r\n \"event_id\":\"\",\r\n \"ssn_nmi\":\"\",\r\n \"utm_source\":\"source\",\r\n \"utm_medium\":\"medium\",\r\n \"utm_campaign\":\"campaign\",\r\n \"utm_content\":\"content\",\r\n \"utm_term\":\"term\",\r\n \"device_category\":\"mobile\",\r\n \"checkingAccountNumber\":\"\",\r\n \"checkingRoutingNumber\":\"\",\r\n \"sepa_iban\":\"\",\r\n \"sepa_bic\":\"\",\r\n \"eurodebit_acct_num\":\"\",\r\n \"eurodebit_route_num\":\"\",\r\n \"referrer_id\" : \"ABCD1234\",\r\n \"conversion_id\" : \"addc703c-6ffd-11e8-a1ea-12f0b4779fbe\",\r\n \"cavv\" : \"BwABAwJoEAAAAABhdWgQAAAAAAA=\",\r\n \"eci\" : \"06\",\r\n \"xid\" : \"YmUyMnFoMmJpbHM1aGJzNjd2MGc=\"\r\n}"},"url":"https://{{app_key}}.{{domain}}{{api_ext}}new_order"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Tue, 13 Nov 2018 12:24:31 GMT"},{"key":"Server","value":"Apache/2.4.34 (Amazon)"},{"key":"Vary","value":"Authorization"},{"key":"Content-Length","value":"501"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"gateway_id\": \"1\",\n \"response_code\": \"100\",\n \"error_found\": \"0\",\n \"order_id\": \"12931\",\n \"transactionID\": \"Not Available\",\n \"customerId\": \"430\",\n \"authId\": \"Not Available\",\n \"orderTotal\": \"91.85\",\n \"orderSalesTaxPercent\": \"0.00\",\n \"orderSalesTaxAmount\": \"0.00\",\n \"test\": \"1\",\n \"prepaid_match\": \"0\",\n \"gatewayCustomerService\": \"8885551212\",\n \"gatewayDescriptor\": \"TestDescriptor\",\n \"subscription_id\": {\n \"608\": \"80780b41e986948a1c899336665dc640\"\n },\n \"resp_msg\": \"Approved\"\n}"},{"id":"77141204-05b6-4ad2-9f3f-4c8dd7d94ff0","name":"new_order with member token","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"firstName\":\"Postman\",\r\n \"lastName\":\"API\",\r\n \"shippingId\":\"2\",\r\n \"tranType\":\"Sale\",\r\n \"ipAddress\":\"198.4.3.2\",\r\n \"campaignId\":\"4\",\r\n \"offers\":\r\n [\r\n {\r\n \"offer_id\":6,\r\n \"product_id\":608,\r\n \"billing_model_id\":2,\r\n \"quantity\":2,\r\n \"step_num\":2,\r\n \"variant\":\r\n [\r\n \t{\r\n \t\t\"attribute_name\":\"size\",\r\n \t\t\"attribute_value\":\"XL\"\r\n \t},\r\n \t{\r\n \t\t\"attribute_name\":\"color\",\r\n \t\t\"attribute_value\":\"Blue\"\r\n \t}\r\n ]\r\n }\r\n ],\r\n \"member\":{\r\n \"token\":\"\",\r\n \"shipping\":{\r\n \"address_id\":\"1\"\r\n },\r\n \"billing\":{\r\n \"wallet_id\":\"45588\",\r\n \"address_id\":1\r\n }\r\n },\r\n \"notes\":\"This is a test order using new_order\"\r\n}"},"url":"https://{{app_key}}.{{domain}}{{api_ext}}new_order"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Tue, 13 Nov 2018 12:24:31 GMT"},{"key":"Server","value":"Apache/2.4.34 (Amazon)"},{"key":"Vary","value":"Authorization"},{"key":"Content-Length","value":"501"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"gateway_id\": \"1\",\n \"response_code\": \"100\",\n \"error_found\": \"0\",\n \"order_id\": \"12931\",\n \"transactionID\": \"Not Available\",\n \"customerId\": \"430\",\n \"authId\": \"Not Available\",\n \"orderTotal\": \"91.85\",\n \"orderSalesTaxPercent\": \"0.00\",\n \"orderSalesTaxAmount\": \"0.00\",\n \"test\": \"1\",\n \"prepaid_match\": \"0\",\n \"gatewayCustomerService\": \"8885551212\",\n \"gatewayDescriptor\": \"TestDescriptor\",\n \"subscription_id\": {\n \"4\": \"68071101c8102efc0cc8287d4ff1a00c\",\n \"16\": \"4daa794674453992c6245e0e4f29c74d\",\n \"608\": \"80780b41e986948a1c899336665dc640\"\n },\n \"resp_msg\": \"Approved\"\n}"},{"id":"a0925610-67e4-4b57-9213-09a38f8f9521","name":"new_order payment_token","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"firstName\":\"Postman\",\r\n \"lastName\":\"API\",\r\n \"billingFirstName\":\"PostingBilling\",\r\n \"billingLastName\":\"APILastname\",\r\n \"billingAddress1\":\"56 Escobar St\",\r\n \"billingAddress2\":\"FL 7\",\r\n \"billingCity\":\"Houston\",\r\n \"billingState\":\"TX\",\r\n \"billingZip\":\"33655\",\r\n \"billingCountry\":\"US\",\r\n \"phone\":\"8135551212\",\r\n \"email\":\"postman@apitest.com\",\r\n \"payment_token\":\"85807e1c-f4bf-11e8-a7e3-12f0b4779fbe\",\r\n \"shippingId\":\"2\",\r\n \"tranType\":\"Sale\",\r\n \"ipAddress\":\"198.4.3.2\",\r\n \"campaignId\":\"4\",\r\n \"offers\":\r\n [\r\n {\r\n \"offer_id\":6,\r\n \"product_id\":608,\r\n \"billing_model_id\":2,\r\n \"quantity\":2,\r\n \"step_num\":2,\r\n \"variant\":\r\n [\r\n {\r\n \"attribute_name\":\"size\",\r\n \"attribute_value\":\"XL\"\r\n },\r\n {\r\n \"attribute_name\":\"color\",\r\n \"attribute_value\":\"Blue\"\r\n }\r\n ]\r\n },\r\n {\r\n \"offer_id\":10,\r\n \"product_id\":4,\r\n \"billing_model_id\":6,\r\n \"quantity\":1,\r\n \"children\":\r\n [\r\n {\r\n \"product_id\":1,\r\n \"quantity\":2\r\n },\r\n {\r\n \"product_id\":2,\r\n \"quantity\":1\r\n }\r\n ]\r\n },\r\n {\r\n \"offer_id\":8,\r\n \"product_id\":16,\r\n \"billing_model_id\":4,\r\n \"quantity\":2,\r\n \"step_num\":3,\r\n \"trial\":\r\n {\r\n \"product_id\":16\r\n }\r\n }\r\n ],\r\n \"gift\":\r\n {\r\n \"email\":\"gift@email.com\",\r\n \"message\":\"This is a gift order and this is a gift message\"\r\n },\r\n \"notes\":\"This is a test order using new_order\",\r\n \"AFID\":\"AFID\",\r\n \"SID\":\"SID\",\r\n \"AFFID\":\"AFFID\",\r\n \"C1\":\"C1\",\r\n \"C2\":\"C2\",\r\n \"C3\":\"C3\",\r\n \"AID\":\"AID\",\r\n \"OPT\":\"OPT\",\r\n \"click_id\":\"abc123\",\r\n \"billingSameAsShipping\":\"YES\",\r\n \"shippingAddress1\":\"123 Medellin St\",\r\n \"shippingAddress2\":\"APT 7\",\r\n \"shippingCity\":\"Santo Alto\",\r\n \"shippingState\":\"TX\",\r\n \"shippingZip\":\"33544\",\r\n \"shippingCountry\":\"US\",\r\n \"forceGatewayId\":\"\",\r\n \"preserve_force_gateway\":\"\",\r\n \"thm_session_id\":\"\",\r\n \"total_installments\":\"\",\r\n \"alt_pay_token\":\"\",\r\n \"alt_pay_payer_id\":\"\",\r\n \"secretSSN\":\"\",\r\n \"promoCode\":\"\",\r\n \"temp_customer_id\":\"\",\r\n \"three_d_redirect_url\":\"\",\r\n \"alt_pay_return_url\":\"\",\r\n \"sessionId\":\"\",\r\n \"cascade_override\":\"\",\r\n \"create_member\":\"\",\r\n \"event_id\":\"\",\r\n \"ssn_nmi\":\"\",\r\n \"utm_source\":\"source\",\r\n \"utm_medium\":\"medium\",\r\n \"utm_campaign\":\"campaign\",\r\n \"utm_content\":\"content\",\r\n \"utm_term\":\"term\",\r\n \"device_category\":\"mobile\",\r\n \"checkingAccountNumber\":\"\",\r\n \"checkingRoutingNumber\":\"\",\r\n \"sepa_iban\":\"\",\r\n \"sepa_bic\":\"\",\r\n \"eurodebit_acct_num\":\"\",\r\n \"eurodebit_route_num\":\"\",\r\n \"referrer_id\" : \"ABCD1234\",\r\n \"conversion_id\" : \"addc703c-6ffd-11e8-a1ea-12f0b4779fbe\",\r\n \"cavv\" : \"BwABAwJoEAAAAABhdWgQAAAAAAA=\",\r\n \"eci\" : \"06\",\r\n \"xid\" : \"YmUyMnFoMmJpbHM1aGJzNjd2MGc=\"\r\n}"},"url":"https://{{app_key}}.{{domain}}{{api_ext}}new_order"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"be89245c-5e5e-4d30-b079-ebc215cf5a92","name":"new_order with Offer Configuration","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"firstName\":\"Postman\",\r\n \"lastName\":\"API\",\r\n \"billingFirstName\":\"PostingBilling\",\r\n \"billingLastName\":\"APILastname\",\r\n \"billingAddress1\":\"56 Escobar St\",\r\n \"billingAddress2\":\"FL 7\",\r\n \"billingCity\":\"Houston\",\r\n \"billingState\":\"TX\",\r\n \"billingZip\":\"33655\",\r\n \"billingCountry\":\"US\",\r\n \"phone\":\"8135551212\",\r\n \"email\":\"postman@apitest.com\",\r\n \"creditCardType\":\"VISA\",\r\n \"creditCardNumber\":\"1444444444444440\",\r\n \"expirationDate\":\"0628\",\r\n \"CVV\":\"123\",\r\n \"shippingId\":\"2\",\r\n \"tranType\":\"Sale\",\r\n \"ipAddress\":\"198.4.3.2\",\r\n \"campaignId\":\"4\",\r\n \"offers\":\r\n [\r\n {\r\n \"offer_configuration_id\": 4\r\n }\r\n ],\r\n \"notes\":\"This is a test order using new_order and an offer configuration\",\r\n \"AFID\":\"AFID\",\r\n \"SID\":\"SID\",\r\n \"AFFID\":\"AFFID\",\r\n \"C1\":\"C1\",\r\n \"C2\":\"C2\",\r\n \"C3\":\"C3\",\r\n \"AID\":\"AID\",\r\n \"OPT\":\"OPT\",\r\n \"click_id\":\"abc123\",\r\n \"billingSameAsShipping\":\"YES\",\r\n \"shippingAddress1\":\"123 Medellin St\",\r\n \"shippingAddress2\":\"APT 7\",\r\n \"shippingCity\":\"Santo Alto\",\r\n \"shippingState\":\"TX\",\r\n \"shippingZip\":\"33544\",\r\n \"shippingCountry\":\"US\",\r\n \"forceGatewayId\":\"\",\r\n \"preserve_force_gateway\":\"\",\r\n \"thm_session_id\":\"\",\r\n \"total_installments\":\"\",\r\n \"alt_pay_token\":\"\",\r\n \"alt_pay_payer_id\":\"\",\r\n \"secretSSN\":\"\",\r\n \"promoCode\":\"\",\r\n \"temp_customer_id\":\"\",\r\n \"three_d_redirect_url\":\"\",\r\n \"alt_pay_return_url\":\"\",\r\n \"sessionId\":\"\",\r\n \"cascade_override\":\"\",\r\n \"create_member\":\"\",\r\n \"event_id\":\"\",\r\n \"ssn_nmi\":\"\",\r\n \"utm_source\":\"source\",\r\n \"utm_medium\":\"medium\",\r\n \"utm_campaign\":\"campaign\",\r\n \"utm_content\":\"content\",\r\n \"utm_term\":\"term\",\r\n \"device_category\":\"mobile\",\r\n \"checkingAccountNumber\":\"\",\r\n \"checkingRoutingNumber\":\"\",\r\n \"sepa_iban\":\"\",\r\n \"sepa_bic\":\"\",\r\n \"eurodebit_acct_num\":\"\",\r\n \"eurodebit_route_num\":\"\",\r\n \"referrer_id\" : \"ABCD1234\",\r\n \"conversion_id\" : \"addc703c-6ffd-11e8-a1ea-12f0b4779fbe\",\r\n \"cavv\" : \"BwABAwJoEAAAAABhdWgQAAAAAAA=\",\r\n \"eci\" : \"06\",\r\n \"xid\" : \"YmUyMnFoMmJpbHM1aGJzNjd2MGc=\"\r\n}"},"url":"https://{{app_key}}.{{domain}}{{api_ext}}new_order"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"0dddabee-997a-4b00-8f47-d560493cb1b7"},{"name":"new_order_card_on_file","id":"48030f22-7870-43ea-8003-dfdf5797d434","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_username}}"},{"key":"password","value":"{{api_password}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"previousOrderId\":\"843130\",\r\n \"shippingId\":\"5\",\r\n \"ipAddress\":\"198.4.3.2\",\r\n \"campaignId\":\"4\",\r\n \"offers\":\r\n [\r\n {\r\n \"offer_id\":6,\r\n \"product_id\":608,\r\n \"billing_model_id\":2,\r\n \"quantity\":2,\r\n \"step_num\":2,\r\n \"variant\":\r\n [\r\n \t{\r\n \t\t\"attribute_name\":\"pink\",\r\n \t\t\"attribute_value\":\"yes\"\r\n \t}\r\n ]\r\n },\r\n {\r\n \"offer_id\":10,\r\n \"product_id\":4,\r\n \"billing_model_id\":6,\r\n \"quantity\":1,\r\n \"children\":\r\n [\r\n {\r\n \"product_id\":1,\r\n \"quantity\":2\r\n },\r\n {\r\n \"product_id\":2,\r\n \"quantity\":1\r\n }\r\n ]\r\n },\r\n {\r\n \"offer_id\":8,\r\n \"product_id\":16,\r\n \"billing_model_id\":4,\r\n \"quantity\":2,\r\n \"step_num\":3,\r\n \"trial\":\r\n {\r\n \t\"product_id\":16\r\n }\r\n }\r\n ],\r\n \"gift\":\r\n {\r\n \"email\":\"gift@email.com\",\r\n \"message\":\"This is a gift order and this is a gift message\"\r\n },\r\n \"notes\":\"This is a test order using new_order_card_on_file\",\r\n \"AFID\":\"AFID\",\r\n \"SID\":\"SID\",\r\n \"AFFID\":\"AFFID\",\r\n \"C1\":\"C1\",\r\n \"C2\":\"C2\",\r\n \"C3\":\"C3\",\r\n \"AID\":\"AID\",\r\n \"OPT\":\"OPT\",\r\n \"click_id\":\"abc123\",\r\n \"forceGatewayId\":\"\",\r\n \"preserve_force_gateway\":\"\",\r\n \"promoCode\":\"\",\r\n \"temp_customer_id\":\"\",\r\n \"sessionId\":\"\",\r\n \"cascade_override\":\"\",\r\n \"utm_source\":\"source\",\r\n \"utm_medium\":\"medium\",\r\n \"utm_campaign\":\"campaign\",\r\n \"utm_content\":\"content\",\r\n \"utm_term\":\"term\",\r\n \"device_category\":\"mobile\",\r\n \"referrer_id\" : \"\",\r\n \"conversion_id\" : \"addc703c-6ffd-11e8-a1ea-12f0b4779fbe\",\r\n \"cavv\" : \"BwABAwJoEAAAAABhdWgQAAAAAAA=\",\r\n \"eci\" : \"06\",\r\n \"xid\" : \"YmUyMnFoMmJpbHM1aGJzNjd2MGc=\"\r\n}"},"url":"https://{{app_key}}.{{domain}}{{api_ext}}new_order_card_on_file","description":"Create a new Order using a previousOrderId. See Orders section for required and optional parameters.
Create a new transaction as an upsell to a previously created order using a previousOrderId. See Orders section for required and optional parameters.
Create a new Order using a prospectId. See Orders section for required and optional parameters.
Max Requests Per Minute: 120
\nThe amount is calculated as follows:
\n","urlObject":{"protocol":"https","host":["{{app_key}}","{{domain}}{{api_ext}}new_order_with_prospect"],"query":[],"variable":[]}},"response":[{"id":"4f6be6d7-84d2-4d40-9488-cbdee8d9855d","name":"new_order_with_prospect","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"prospectId\":\"361992\",\r\n \"creditCardNumber\":\"4000002760003184\",\r\n \"expirationDate\":\"0628\",\r\n \"CVV\":\"123\",\r\n \"creditCardType\":\"VISA\",\r\n \"shippingId\":\"5\",\r\n \"tranType\":\"Sale\",\r\n \"ipAddress\":\"198.4.3.2\",\r\n \"campaignId\":\"4\",\r\n \"offers\":\r\n [\r\n {\r\n \"offer_id\":6,\r\n \"product_id\":608,\r\n \"billing_model_id\":2,\r\n \"quantity\":2,\r\n \"step_num\":2,\r\n \"variant\":\r\n [\r\n \t{\r\n \t\t\"attribute_name\":\"pink\",\r\n \t\t\"attribute_value\":\"yes\"\r\n \t}\r\n ]\r\n },\r\n {\r\n \"offer_id\":10,\r\n \"product_id\":4,\r\n \"billing_model_id\":6,\r\n \"quantity\":1,\r\n \"children\":\r\n [\r\n {\r\n \"product_id\":1,\r\n \"quantity\":2\r\n },\r\n {\r\n \"product_id\":2,\r\n \"quantity\":1\r\n }\r\n ]\r\n },\r\n {\r\n \"offer_id\":8,\r\n \"product_id\":16,\r\n \"billing_model_id\":4,\r\n \"quantity\":2,\r\n \"step_num\":3,\r\n \"trial\":\r\n {\r\n \t\"product_id\":16\r\n }\r\n }\r\n ],\r\n \"gift\":\r\n {\r\n \"email\":\"gift@email.com\",\r\n \"message\":\"This is a gift order and this is a gift message\"\r\n },\r\n \"conversion_id\":\"addc703c-6ffd-11e8-a1ea-12f0b4779fbe\",\r\n \"notes\":\"This is a test order using new_order_with_prospect\",\r\n \"AFID\":\"AFID\",\r\n \"SID\":\"SID\",\r\n \"AFFID\":\"AFFID\",\r\n \"C1\":\"C1\",\r\n \"C2\":\"C2\",\r\n \"C3\":\"C3\",\r\n \"AID\":\"AID\",\r\n \"OPT\":\"OPT\",\r\n \"click_id\":\"abc123\",\r\n \"forceGatewayId\":\"\",\r\n \"preserve_force_gateway\":\"\",\r\n \"thm_session_id\":\"\",\r\n \"total_installments\":\"\",\r\n \"alt_pay_token\":\"\",\r\n \"alt_pay_payer_id\":\"\",\r\n \"secretSSN\":\"\",\r\n \"promoCode\":\"\",\r\n \"temp_customer_id\":\"\",\r\n \"three_d_redirect_url\":\"\",\r\n \"alt_pay_return_url\":\"\",\r\n \"sessionId\":\"\",\r\n \"cascade_override\":\"\",\r\n \"ssn_nmi\":\"\",\r\n \"utm_source\":\"source\",\r\n \"utm_medium\":\"medium\",\r\n \"utm_campaign\":\"campaign\",\r\n \"utm_content\":\"content\",\r\n \"utm_term\":\"term\",\r\n \"device_category\":\"mobile\",\r\n \"checkingAccountNumber\":\"\",\r\n \"checkingRoutingNumber\":\"\",\r\n \"sepa_iban\":\"\",\r\n \"sepa_bic\":\"\",\r\n \"eurodebit_acct_num\":\"\",\r\n \"eurodebit_route_num\":\"\",\r\n \"referrer_id\" : \"\",\r\n \"cavv\" : \"BwABAwJoEAAAAABhdWgQAAAAAAA=\",\r\n \"eci\" : \"06\",\r\n \"xid\" : \"YmUyMnFoMmJpbHM1aGJzNjd2MGc=\"\r\n}"},"url":"https://{{app_key}}.{{domain}}{{api_ext}}new_order_with_prospect"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 22 Jul 2024 06:52:19 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Apache"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains;"},{"key":"Vary","value":"Authorization"},{"key":"Set-Cookie","value":"token=dd869c45348c1446985827897b702fc8; expires=Mon, 22-Jul-2024 08:07:17 GMT; Max-Age=4500; path=/; secure; HttpOnly; SameSite=None"},{"key":"Set-Cookie","value":"token=dd869c45348c1446985827897b702fc8; expires=Mon, 22-Jul-2024 08:07:17 GMT; Max-Age=4500; path=/; secure; HttpOnly; SameSite=None"},{"key":"Set-Cookie","value":"token=deleted; expires=Thu, 01-Jan-1970 00:00:01 GMT; Max-Age=0; path=/; secure; HttpOnly; SameSite=None"},{"key":"Set-Cookie","value":"limelight=deleted; expires=Thu, 01-Jan-1970 00:00:01 GMT; Max-Age=0; path=/; secure; HttpOnly; SameSite=None"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, PUT, DELETE, PATCH"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Authorization, X-Requested-With, Platform-Key, X-CSRF-TOKEN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"gateway_id\": \"3\",\n \"response_code\": \"100\",\n \"error_found\": \"0\",\n \"order_id\": \"843130\",\n \"transactionID\": \"9744974495\",\n \"customerId\": \"124392\",\n \"authId\": \"123456\",\n \"orderTotal\": \"132.57\",\n \"orderSalesTaxPercent\": \"0.00\",\n \"orderSalesTaxAmount\": \"0.00\",\n \"test\": \"0\",\n \"prepaid_match\": \"0\",\n \"line_items\": [\n {\n \"product_id\": \"608\",\n \"variant_id\": \"241\",\n \"quantity\": \"2\",\n \"subscription_id\": \"d4bb8dd80a3bbb403855faed52677726\"\n },\n {\n \"product_id\": \"4\",\n \"variant_id\": \"0\",\n \"quantity\": \"1\",\n \"subscription_id\": \"0697ecfd44dccb7d0035e3c4d3dc810e\"\n },\n {\n \"product_id\": \"16\",\n \"variant_id\": \"0\",\n \"quantity\": \"1\",\n \"subscription_id\": \"9a755e2609ebe48fe0872806efdb64d3\"\n }\n ],\n \"gatewayCustomerService\": \"800-555-1212\",\n \"gatewayDescriptor\": \"Gateway 3\",\n \"subscription_id\": {\n \"4\": \"0697ecfd44dccb7d0035e3c4d3dc810e\",\n \"16\": \"9a755e2609ebe48fe0872806efdb64d3\",\n \"608-241\": \"d4bb8dd80a3bbb403855faed52677726\"\n },\n \"decline_level\": \"0\",\n \"gateway_code\": \"100\",\n \"avs_response\": \"N\",\n \"cvv_response\": \"N\",\n \"processor_id\": \"ccprocessora\",\n \"provider_response_code\": \"100\"\n}"}],"_postman_id":"29726c55-2abf-4f9a-91ee-7820447c9c80"},{"name":"order_calculate_refund","id":"bd1c5a74-a2cd-4874-b610-df344742093d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_username}}"},{"key":"password","value":"{{api_password}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"order_id\": 11275\n}"},"url":"https://{{app_key}}.{{domain}}{{api_ext}}order_calculate_refund","description":"The order_calculate_refund method is used to help figure out the pro-rate amount for recurring orders to be refunded.
The recurring date is based on the main product recurring date.
Max Requests Per Minute: 120
\nThe amount is calculated as follows:
\n","urlObject":{"protocol":"https","host":["{{app_key}}","{{domain}}{{api_ext}}order_calculate_refund"],"query":[],"variable":[]}},"response":[{"id":"47b65f6c-9422-4fdf-89de-36d3f786e4bd","name":"order_calculate_refund","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"order_id\": 11275\n}"},"url":"https://{{app_key}}.{{domain}}{{api_ext}}order_calculate_refund"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"response_code\": \"100\",\n \"amount\": \"28.98\"\n}"}],"_postman_id":"bd1c5a74-a2cd-4874-b610-df344742093d"},{"name":"order_force_bill","id":"efdf6132-ff70-4f17-8ce4-40d6ab81af43","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_username}}"},{"key":"password","value":"{{api_password}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"order_id\":\"11279\",\n\t\"forceGatewayId\":\"\",\n\t\"preserve_force_gateway\":\"0\",\n\t\"product_id\":0\n}"},"url":"https://{{app_key}}.{{domain}}{{api_ext}}order_force_bill","description":"This method is used to perform a force bill on the given order. Note: It is possible to use the forceGatewayId similar to Transaction API to force a particular MID of your choosing.
You may also pass product_id if there are more than one products on the order and you want to force bill only one
Max Requests Per Minute: 120
\n","urlObject":{"protocol":"https","host":["{{app_key}}","{{domain}}{{api_ext}}order_force_bill"],"query":[],"variable":[]}},"response":[{"id":"ce8ebfd8-f142-4248-9811-7b8115ef34de","name":"order_force_bill","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"order_id\":\"11279\"\n\t\"forceGatewayId\":\"\",\n\t\"preserve_force_gateway\":\"0\"\n}"},"url":"https://{{app_key}}.{{domain}}{{api_ext}}order_force_bill"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n\t\"response_code\":\"100\",\n\t\"error_found\":\"0\",\n\t\"error_message\":\"This will only be returned if there is an error\",\n\t\"transactionID\":\"123456\",\n\t\"authId\":\"abc123\",\n\t\"declineReason\":\"This will only be returned if the transaction is declined (Response code 800)\",\n\t\"response_message\":\"This order was billed successfully\",\n\t\"order_id\":\"415782\"\n}"}],"_postman_id":"efdf6132-ff70-4f17-8ce4-40d6ab81af43"},{"name":"order_find","id":"37068ba3-4edb-441b-bc3e-208df5fe0aa9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_username}}"},{"key":"password","value":"{{api_password}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n\t\"campaign_id\":\"all\",\r\n\t\"start_date\":\"01/01/2024\",\r\n\t\"start_time\":\"01:05:10\",\r\n\t\"end_date\":\"03/03/2024\",\r\n\t\"end_time\":\"15:18:40\",\r\n\t\"date_type\":\"create\",\r\n\t\"product_id\":[\r\n\t\t1,\r\n\t\t2,\r\n\t\t3,\r\n\t\t4\r\n\t],\r\n\t\"criteria\":\r\n\t{\r\n\t\t\"order_total\":\r\n\t\t{\r\n\t\t\t\"=\":\"97.98\"\r\n\t\t},\r\n\t\t\"email\":\"*sticky.io\",\r\n \"auth_id\":\"2VAGJ7\"\r\n\t},\r\n\t\"member_token\":\"\",\r\n\t\"return_type\":\"order_view\"\r\n}"},"url":"https://{{app_key}}.{{domain}}{{api_ext}}order_find","description":"DEV-613
\nThe order_find method is an extremely powerful reporting engine to find orders and get a result of order Ids that meet your criteria.
\nSometimes you may be looking for a particular order that matches a few criteria, but not necessarily requiring that ALL the criteria are met and other times you want to narrow down your search where you want each criteria in your search to only give you orders that have the exact match.
\nThat is why we created two different modes of searching using the search_type parameter of \"any\" (match) or \"all\".
\nFor \"start_time\" and \"end_time\" if you don't want to provide it, leave it empty like \"\", otherwise you can pass them like \"01:12:12\" i.e hour : minute : second
\nMax Requests Per Minute: 120
\nFor example, if you wanted to find all the new orders that had an RMA as well as had upsells, you would pass:
\n{\n start_date\":\"10/05/2009\",\n \"end_date\":\"10/05/2010\",\n \"start_time\":\"01:05:10\",\n \"end_time\":\"15:18:40\",\n \"campaign_id\":\"1\",\n \"criteria\":{\n \"new\":\"1\",\n \"rma\":\"1\",\n \"has_upsells\":\"1\"\n },\n \"search_type\":\"all\"\n}\n\nThe response would be something like the following:
\n \"response_code\":\"100\",\n \"total_orders\":\"2\",\n \"order_id\":[\n \"15351\",\n \"15368\"\n ]\n\nBut if you change the search type to any, then your criteria will have widened because this will give you orders that have RMA, but are also NEW and also have upsells :
\n{\n \"response_code\":\"100\",\n \"total_orders\":\"9\",\n \"order_id\":[\n \"15339\",\n \"15342\",\n \"15345\",\n \"15346\",\n \"15347\",\n \"15348\",\n \"15349\",\n \"15350\",\n \"15351\"\n ]\n}\n\nWe also allow a wildcard search in criteria fields tracking_num, affiliate_id, sub_affiliate_id, first_name, last_name, address, city, state, zip, phone, email and ip_address. This would allow you to do something like this:
For instance, you are interested in orders on your first recurring cycle from a person named \"Dave\" who you know has a gmail email address, who also resides in Michigan, and whose order has been refunded. You could pass:
\n{\n \"start_date\":\"10/05/2009\",\n \"end_date\":\"10/05/2010\",\n \"campaign_id\":1\",\n \"criteria\":\n {\n \"first_name\":\"dav*\",\n \"state\":\"mi\",\n \"email\":\"*gmail*\",\n \"billing_cycle\":\n {\n \"=\":\"1\"\n },\n \"all_refunds\":\"1\"\n },\n \"search_type\":\"all\"\n}\n\nBy default if you are just looking to get all the orders off a campaign you must at least pass \"criteria\":\"all\"
Other required parameters to this call are campaign_id and start_date and end_date.
In total, the required fields are criteria, start_date, end_date, and campaign_id
An optional parameter, return_type, may be passed. If return_type is sent as order_view, in addition to the normal return parameters you will also receive a data parameter that contains an object of the data returned by the order_view method for each order that fits your criteria.
{\n \"start_date\":\"10/05/2009\"\n \"end_date\":\"10/05/2010\",\n \"campaign_id\":\"1\",\n \"criteria\":\n {\n \"first_name\":\"dav*\"\n },\n \"search_type\":\"all\",\n \"return_type\":\"order_view\"\n}\n\nWould return something like:
\n{\n \"response_code\":\"100\",\n \"total_orders\":\"1\",\n \"order_id\":\n [\n 10001,\n 10002\n ],\n \"data\":\n {\n \"10001\":\n {\n <order_view return values>\n },\n \"10002\":\n {\n <order_view return values>\n }\n }\n}\n\nIf you would like to only find orders where the main product or any add-ons are recurring, you may pass the is_any_product_recurring field. Unlike the recurring parameter, this field will return orders for items with recurring add-ons (as well as main products).
< Example:{\n \"campaign_id\":\"all\",\n \"start_date\":\"01/01/2020\",\n \"start_time\":\"\",\n \"end_date\":\"03/01/2021\",\n \"end_time\":\"\",\n \"date_type\":\"\",\n \"criteria\": {\n \"success\": 1,\n \"recurring\": 1,\n \"is_any_product_recurring\": 1\n },\n \"return_type\":\"order_view\"\n}\n\nThere are criterion for order_total and billing_cycle that can be passed. These criterion can either be <, > = or a range.
Examples of each (order_total is being used for the examples. The same schema is used for billing_cycles:
< Example:\"criteria\":\n{\n \"order_total\":\n {\n \"<\":\"100.00\"\n }\n}\n\n> Example:\"criteria\":\n{\n \"order_total\":\n {\n \">\":\"1.00\"\n }\n}\n\n= Example:\"criteria\":\n{\n \"order_total\":\n {\n \"=\":\"97.98\"\n }\n}\n\nrange: Example:\"criteria\":\n{\n \"order_total\":\n {\n \"range\":\n [\n \"1.00\",\n \"100.00\"\n ]\n }\n}\n\nTest Orders: If you want to fetch only test orders, then you can pass \"is_test\" parameter under \"criteria\" with value 1. If you have more than one parameter under \"criteria\", you can use the \"search_type\" parameter with value \"AND\" so that returned result must match all conditions with \"AND\" logical operator, defined under \"criteria\".
\nTest Orders Example:
\n{\n \"campaign_id\":\"1\",\n \"start_date\":\"04/01/2024\",\n \"end_date\":\"04/29/2024\",\n \"criteria\":\n {\n \"email\":\"*sticky.io\",\n \"is_test\": 1\n },\n \"search_type\" : \"and\",\n \"return_type\":\"order_view\"\n}\n\nSee the order_view definition for return values.
\nNOTE
\nIf you are using our Member service, you can also pass member_token in the request and the filtering will be based on the logged in member and their associated customer_id(s)
The order_find_overdue method is used to display orders that have been declined. The days field for the request section, is the number of days in the history of orders to search within.
Max Requests Per Minute: 120
\n","urlObject":{"protocol":"https","host":["{{app_key}}","{{domain}}{{api_ext}}order_find_overdue"],"query":[],"variable":[]}},"response":[{"id":"b918bd9d-a324-4565-81f3-6f3cf1c371a7","name":"order_find_overdue","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n\t\"days\":10\r\n}"},"url":"https://{{app_key}}.{{domain}}{{api_ext}}order_find_overdue"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"response_code\": 100,\n \"ancestor_id\": [\n \"236841\",\n \"257867\",\n \"325349\",\n \"347526\",\n \"360964\",\n \"378174\",\n \"382136\",\n \"382798\",\n \"384902\",\n \"388375\",\n \"390576\",\n \"396963\",\n \"399416\",\n \"399420\"\n ]\n}"}],"_postman_id":"2b0a3e36-d337-4a07-9186-a416ccf6012b"},{"name":"order_find_updated","id":"bbd95d94-607b-40d0-9b25-f1d11bbc3818","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_username}}"},{"key":"password","value":"{{api_password}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n\t\"campaign_id\":\"all\",\r\n\t\"start_date\":\"01/01/2018\",\r\n\t\"end_date\":\"01/01/2019\",\r\n\t\"start_time\":\"\",\r\n\t\"end_time\":\"\",\r\n\t\"group_keys\":\r\n\t[\r\n\t\t\"billing_info\",\r\n\t\t\"blacklist\",\r\n\t\t\"chargeback\",\r\n\t\t\"confirmation\",\r\n\t\t\"credit_card_info\",\r\n\t\t\"email\",\r\n\t\t\"failures\",\r\n\t\t\"force_rebill\",\r\n\t\t\"fraud\",\r\n\t\t\"fulfillment_post\",\r\n\t\t\"name\",\r\n\t\t\"next_rebill_product\",\r\n\t\t\"notes\",\r\n\t\t\"offline_payment\",\r\n\t\t\"phone\",\r\n\t\t\"rebill_discount\",\r\n\t\t\"recurring_date\",\r\n\t\t\"recurring_scheduling\",\r\n\t\t\"recurring_status\",\r\n\t\t\"refund\",\r\n\t\t\"reprocess\",\r\n\t\t\"restored\",\r\n\t\t\"return\",\r\n\t\t\"rma\",\r\n\t\t\"shipping_info\",\r\n\t\t\"shpping_method\",\r\n\t\t\"shipping_status\",\r\n\t\t\"tracking_number\",\r\n\t\t\"void\"\r\n\t]\r\n}"},"url":"https://{{app_key}}.{{domain}}{{api_ext}}order_find_updated","description":"This method will return orders that have been modified since creation (excluding orders that have only been created and not updated). This date range that is requested returns orders based on the date orders were modified.
\nAS OF 12/05/2018 The Max Amount of returned items in the data array will be 50000
Max Requests Per Minute: 120
\n","urlObject":{"protocol":"https","host":["{{app_key}}","{{domain}}{{api_ext}}order_find_updated"],"query":[],"variable":[]}},"response":[{"id":"e9d5b2cb-e29c-4f5e-9e14-fc5c6449abe4","name":"order_find_updated","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n\t\"campaign_id\":\"all\",\r\n\t\"start_date\":\"01/01/2018\",\r\n\t\"end_date\":\"01/01/2019\",\r\n\t\"start_time\":\"\",\r\n\t\"end_time\":\"\",\r\n\t\"group_keys\":\r\n\t[\r\n\t\t\"billing_info\",\r\n\t\t\"blacklist\",\r\n\t\t\"chargeback\",\r\n\t\t\"confirmation\",\r\n\t\t\"credit_card_info\",\r\n\t\t\"email\",\r\n\t\t\"failures\",\r\n\t\t\"force_rebill\",\r\n\t\t\"fraud\",\r\n\t\t\"fulfillment_post\",\r\n\t\t\"name\",\r\n\t\t\"next_rebill_product\",\r\n\t\t\"notes\",\r\n\t\t\"offline_payment\",\r\n\t\t\"phone\",\r\n\t\t\"rebill_discount\",\r\n\t\t\"recurring_date\",\r\n\t\t\"recurring_scheduling\",\r\n\t\t\"recurring_status\",\r\n\t\t\"refund\",\r\n\t\t\"reprocess\",\r\n\t\t\"restored\",\r\n\t\t\"return\",\r\n\t\t\"rma\",\r\n\t\t\"shipping_info\",\r\n\t\t\"shpping_method\",\r\n\t\t\"shipping_status\",\r\n\t\t\"tracking_number\",\r\n\t\t\"void\"\r\n\t]\r\n}"},"url":"https://{{app_key}}.{{domain}}{{api_ext}}order_find_updated"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"response_code\": \"100\",\n \"total_orders\": \"5\",\n \"order_id\": [\n \"10006\",\n \"10171\",\n \"10172\",\n \"10173\",\n \"10176\"\n ],\n \"data\": {\n \"10006\": {\n \"last_modified\": \"2018-04-24 13:22:34\"\n },\n \"10171\": {\n \"last_modified\": \"2018-05-30 08:50:17\"\n },\n \"10172\": {\n \"last_modified\": \"2018-05-30 08:37:49\"\n },\n \"10173\": {\n \"last_modified\": \"2018-05-30 08:35:57\"\n },\n \"10176\": {\n \"last_modified\": \"2018-05-30 08:01:17\"\n }\n }\n}"}],"_postman_id":"bbd95d94-607b-40d0-9b25-f1d11bbc3818"},{"name":"order_view","id":"fa3f4efb-0b1f-4467-9454-3bb1aff96aae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_username}}"},{"key":"password","value":"{{api_password}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"order_id\":[\n\t\t13002\n\t],\n \"return_variants\":1\n}"},"url":"https://{{app_key}}.{{domain}}{{api_ext}}order_view","description":"View details about an order. Can be one order id or an array of order ids.
\nMax Requests Per Minute: 120
\nDefinition for order_status values:
The is_terminal flag on the products array represents if the line item will be placed on hold on after the next successful rebill
\n","urlObject":{"protocol":"https","host":["{{app_key}}","{{domain}}{{api_ext}}order_view"],"query":[],"variable":[]}},"response":[{"id":"b814a0d4-a327-457a-85a9-88867d91df44","name":"order_view","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"order_id\":[\n\t\t12504\n\t]\n}"},"url":"https://{{app_key}}.{{domain}}{{api_ext}}order_view"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 20 Jun 2024 14:11:57 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Apache"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains;"},{"key":"Vary","value":"Authorization"},{"key":"Set-Cookie","value":"token=ecf873b067b463a1ae743076be5d3633; expires=Thu, 20-Jun-2024 15:26:57 GMT; Max-Age=4500; path=/; secure; HttpOnly; SameSite=None"},{"key":"Set-Cookie","value":"token=ecf873b067b463a1ae743076be5d3633; expires=Thu, 20-Jun-2024 15:26:57 GMT; Max-Age=4500; path=/; secure; HttpOnly; SameSite=None"},{"key":"Set-Cookie","value":"token=deleted; expires=Thu, 01-Jan-1970 00:00:01 GMT; Max-Age=0; path=/; secure; HttpOnly; SameSite=None"},{"key":"Set-Cookie","value":"limelight=deleted; expires=Thu, 01-Jan-1970 00:00:01 GMT; Max-Age=0; path=/; secure; HttpOnly; SameSite=None"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, PUT, DELETE, PATCH"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Authorization, X-Requested-With, Platform-Key, X-CSRF-TOKEN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"response_code\": \"100\",\n \"order_id\": \"12504\",\n \"contact_id\": \"989\",\n \"acquisition_date\": \"2023-04-10 07:58:16\",\n \"ancestor_id\": \"12504\",\n \"affiliate\": \"170442\",\n \"afid\": \"170442\",\n \"sid\": \"\",\n \"affid\": \"\",\n \"c1\": \"\",\n \"c2\": \"\",\n \"c3\": \"gmnce329_53_12082293\",\n \"aid\": \"\",\n \"opt\": \"\",\n \"amount_refunded_to_date\": \"0.00\",\n \"auth_id\": \"\",\n \"billing_city\": \"Columbia\",\n \"billing_country\": \"US\",\n \"billing_cycle\": \"0\",\n \"billing_first_name\": \"Lois\",\n \"billing_last_name\": \"Young\",\n \"billing_postcode\": \"65201\",\n \"billing_state\": \"MO\",\n \"billing_state_id\": \"MO\",\n \"billing_street_address\": \"1452 4th Street\",\n \"billing_street_address2\": \"\",\n \"billing_company_name\": \"\",\n \"campaign_id\": \"3\",\n \"cc_expires\": \"0320\",\n \"cc_first_6\": \"414709\",\n \"cc_last_4\": \"8539\",\n \"cc_number\": \"8539\",\n \"credit_card_number\": \"414709******8539\",\n \"cc_orig_first_6\": \"\",\n \"cc_orig_last_4\": \"\",\n \"cc_type\": \"visa\",\n \"chargeback_date\": \"\",\n \"check_account_last_4\": \"\",\n \"check_routing_last_4\": \"\",\n \"check_ssn_last_4\": \"\",\n \"check_transitnum\": \"\",\n \"child_id\": \"17983\",\n \"click_id\": \"\",\n \"created_by_user_name\": \"\",\n \"created_by_employee_name\": \"\",\n \"coupon_discount_amount\": \"0.00\",\n \"coupon_id\": \"\",\n \"credit_applied\": \"0.00\",\n \"promo_code\": \"\",\n \"customer_id\": \"914\",\n \"customers_telephone\": \"800-555-1212\",\n \"decline_salvage_discount_percent\": \"0\",\n \"retry_attempt\": \"0\",\n \"decline_reason\": \"\",\n \"decline_reason_details\": \"\",\n \"email_address\": \"lyoung914@gmail.test\",\n \"first_name\": \"Lois\",\n \"gateway_id\": \"39\",\n \"gateway_descriptor\": \"Gateway 39\",\n \"hold_date\": \"\",\n \"is_3d_protected\": \"no\",\n \"ip_address\": \"127.0.0.1\",\n \"ip_Address_lookup\": \"\",\n \"is_blacklisted\": \"0\",\n \"is_chargeback\": \"0\",\n \"is_fraud\": \"0\",\n \"is_recurring\": \"0\",\n \"is_any_product_recurring\": \"0\",\n \"is_refund\": \"no\",\n \"is_rma\": \"0\",\n \"is_test_cc\": \"0\",\n \"is_void\": \"no\",\n \"last_name\": \"Young\",\n \"main_product_id\": \"15\",\n \"main_product_quantity\": \"1\",\n \"next_subscription_product\": \"\",\n \"next_subscription_product_id\": \"\",\n \"on_hold\": \"0\",\n \"on_hold_by\": \"\",\n \"order_confirmed\": \"NO_STATUS\",\n \"order_confirmed_date\": \"\",\n \"order_sales_tax\": \"0.00\",\n \"order_sales_tax_amount\": \"0.00\",\n \"shipping_amount\": \"4.95\",\n \"order_status\": \"8\",\n \"order_total\": \"4.95\",\n \"parent_id\": \"12504\",\n \"prepaid_match\": \"No\",\n \"preserve_gateway\": \"1\",\n \"processor_id\": \"\",\n \"rebill_discount_percent\": \"0\",\n \"current_rebill_discount_percent\": \"0\",\n \"recurring_date\": \"2023-04-17\",\n \"refund_amount\": \"0.00\",\n \"refund_date\": \"\",\n \"retry_date\": \"\",\n \"rma_number\": \"\",\n \"rma_reason\": \"\",\n \"return_reason\": \"\",\n \"shipping_city\": \"Columbia\",\n \"shipping_country\": \"US\",\n \"shipping_date\": \"04/04/2023\",\n \"shipping_first_name\": \"Lois\",\n \"shipping_id\": \"\",\n \"shipping_last_name\": \"Young\",\n \"shipping_method_name\": \"USPS_BeautyS1\",\n \"shipping_postcode\": \"65201\",\n \"shipping_state\": \"MO\",\n \"shipping_state_id\": \"MO\",\n \"shipping_street_address\": \"1452 4th Street\",\n \"shipping_street_address2\": \"\",\n \"shipping_company_name\": \"\",\n \"sub_affiliate\": \"\",\n \"time_stamp\": \"2023-04-10 07:58:16\",\n \"tracking_number\": \"9400111899563913402876\",\n \"transaction_id\": \"12345\",\n \"upsell_product_id\": \"\",\n \"upsell_product_quantity\": \"\",\n \"void_amount\": \"0.00\",\n \"void_date\": \"\",\n \"shippable\": \"1\",\n \"website_received\": \"\",\n \"website_sent\": \"\",\n \"is_cascaded\": \"0\",\n \"stop_after_next_rebill\": \"0\",\n \"order_customer_types\": [],\n \"consent_required\": \"0\",\n \"consent_received\": \"0\",\n \"utm_info\": {\n \"medium\": \"\",\n \"campaign\": \"\",\n \"content\": \"\",\n \"device_category\": \"\",\n \"term\": \"\",\n \"source\": \"\"\n },\n \"products\": [\n {\n \"product_id\": \"15\",\n \"sku\": \"SKU 15\",\n \"price\": \"0.00\",\n \"product_qty\": \"1\",\n \"name\": \"Product 15\",\n \"is_recurring\": \"0\",\n \"is_terminal\": \"0\",\n \"recurring_date\": \"2023-04-17\",\n \"subscription_id\": \"b27d99ec36737d8f34cc0e91aa2e1071\",\n \"next_subscription_product\": \"\",\n \"next_subscription_product_id\": \"\",\n \"next_subscription_product_price\": \"0.0000\",\n \"forecasted_revenue\": \"39.90\",\n \"next_subscription_qty\": \"\",\n \"billing_model_discount\": \"\",\n \"is_add_on\": \"0\",\n \"is_in_trial\": \"\",\n \"step_number\": \"\",\n \"is_shippable\": \"1\",\n \"is_full_refund\": \"0\",\n \"refund_amount\": \"0.00\",\n \"on_hold\": \"0\",\n \"hold_date\": \"\"\n }\n ],\n \"systemNotes\": [\n \"April 08, 2023 12:37 PM - sticky.io API - Shipped\",\n \"April 21, 2023 04:18 AM - sticky.io - New recurring with new order ID: 17983\",\n \"June 14, 2024 01:51 PM - sticky.io - Product 15 was forced to Gateway 39 from the Campaign Edit. This happened due to a change made to the campaign (3) changing to Gateway - Gateway 2 (2).\"\n ],\n \"totals_breakdown\": {\n \"total\": \"4.95\",\n \"subtotal\": \"0\",\n \"shipping\": \"4.95\",\n \"tax\": \"0\",\n \"tax_pct\": \"0\",\n \"vat_tax\": \"0\",\n \"vat_tax_pct\": \"0\",\n \"volume_discount\": \"0\",\n \"restocking_fee\": \"0\",\n \"amount_refunded\": \"0\",\n \"refunded\": \"0\"\n }\n}"},{"id":"d77208f7-698a-41f9-bf34-7352a557d01e","name":"order_view with prepaid","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"order_id\":[\n\t\t12505\n\t]\n}"},"url":"https://{{app_key}}.{{domain}}{{api_ext}}order_view"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 20 Jun 2024 15:36:07 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Apache"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains;"},{"key":"Vary","value":"Authorization"},{"key":"Set-Cookie","value":"token=89bacf03902f14023810adb2858b20f5; expires=Thu, 20-Jun-2024 16:51:07 GMT; Max-Age=4500; path=/; secure; HttpOnly; SameSite=None"},{"key":"Set-Cookie","value":"token=89bacf03902f14023810adb2858b20f5; expires=Thu, 20-Jun-2024 16:51:07 GMT; Max-Age=4500; path=/; secure; HttpOnly; SameSite=None"},{"key":"Set-Cookie","value":"token=deleted; expires=Thu, 01-Jan-1970 00:00:01 GMT; Max-Age=0; path=/; secure; HttpOnly; SameSite=None"},{"key":"Set-Cookie","value":"limelight=deleted; expires=Thu, 01-Jan-1970 00:00:01 GMT; Max-Age=0; path=/; secure; HttpOnly; SameSite=None"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, PUT, DELETE, PATCH"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Authorization, X-Requested-With, Platform-Key, X-CSRF-TOKEN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"response_code\": \"100\",\n \"order_id\": \"12505\",\n \"contact_id\": \"990\",\n \"acquisition_date\": \"2023-04-11 07:58:23\",\n \"ancestor_id\": \"12505\",\n \"affiliate\": \"170442\",\n \"afid\": \"170442\",\n \"sid\": \"\",\n \"affid\": \"\",\n \"c1\": \"\",\n \"c2\": \"\",\n \"c3\": \"8u8i7bep_53_12081403\",\n \"aid\": \"\",\n \"opt\": \"\",\n \"amount_refunded_to_date\": \"0.00\",\n \"auth_id\": \"\",\n \"billing_city\": \"Melbourne\",\n \"billing_country\": \"US\",\n \"billing_cycle\": \"0\",\n \"billing_first_name\": \"Marie\",\n \"billing_last_name\": \"Newman\",\n \"billing_postcode\": \"32940\",\n \"billing_state\": \"FL\",\n \"billing_state_id\": \"FL\",\n \"billing_street_address\": \"2830 Center Street\",\n \"billing_street_address2\": \"\",\n \"billing_company_name\": \"\",\n \"campaign_id\": \"3\",\n \"cc_expires\": \"0417\",\n \"cc_first_6\": \"551512\",\n \"cc_last_4\": \"9941\",\n \"cc_number\": \"9941\",\n \"credit_card_number\": \"551512******9941\",\n \"cc_orig_first_6\": \"\",\n \"cc_orig_last_4\": \"\",\n \"cc_type\": \"master\",\n \"chargeback_date\": \"\",\n \"check_account_last_4\": \"\",\n \"check_routing_last_4\": \"\",\n \"check_ssn_last_4\": \"\",\n \"check_transitnum\": \"\",\n \"child_id\": \"17984,45936,74827,112059\",\n \"click_id\": \"\",\n \"created_by_user_name\": \"\",\n \"created_by_employee_name\": \"\",\n \"coupon_discount_amount\": \"0.00\",\n \"coupon_id\": \"\",\n \"credit_applied\": \"0.00\",\n \"promo_code\": \"\",\n \"customer_id\": \"915\",\n \"customers_telephone\": \"800-555-1212\",\n \"decline_salvage_discount_percent\": \"0\",\n \"retry_attempt\": \"0\",\n \"decline_reason\": \"\",\n \"decline_reason_details\": \"\",\n \"email_address\": \"mnewman915@gmail.test\",\n \"first_name\": \"Marie\",\n \"gateway_id\": \"39\",\n \"gateway_descriptor\": \"Gateway 39\",\n \"hold_date\": \"\",\n \"is_3d_protected\": \"no\",\n \"ip_address\": \"127.0.0.1\",\n \"ip_Address_lookup\": \"\",\n \"is_blacklisted\": \"0\",\n \"is_chargeback\": \"0\",\n \"is_fraud\": \"0\",\n \"is_recurring\": \"0\",\n \"is_any_product_recurring\": \"0\",\n \"is_refund\": \"no\",\n \"is_rma\": \"0\",\n \"is_test_cc\": \"0\",\n \"is_void\": \"no\",\n \"last_name\": \"Newman\",\n \"main_product_id\": \"15\",\n \"main_product_quantity\": \"1\",\n \"next_subscription_product\": \"\",\n \"next_subscription_product_id\": \"\",\n \"on_hold\": \"0\",\n \"on_hold_by\": \"\",\n \"order_confirmed\": \"NO_STATUS\",\n \"order_confirmed_date\": \"\",\n \"order_sales_tax\": \"0.00\",\n \"order_sales_tax_amount\": \"0.00\",\n \"shipping_amount\": \"4.95\",\n \"order_status\": \"8\",\n \"order_total\": \"4.95\",\n \"parent_id\": \"12505\",\n \"prepaid_match\": \"No\",\n \"preserve_gateway\": \"1\",\n \"processor_id\": \"\",\n \"rebill_discount_percent\": \"0\",\n \"current_rebill_discount_percent\": \"0\",\n \"recurring_date\": \"2023-04-18\",\n \"refund_amount\": \"0.00\",\n \"refund_date\": \"\",\n \"retry_date\": \"\",\n \"rma_number\": \"\",\n \"rma_reason\": \"\",\n \"return_reason\": \"\",\n \"shipping_city\": \"Melbourne\",\n \"shipping_country\": \"US\",\n \"shipping_date\": \"04/05/2023\",\n \"shipping_first_name\": \"Marie\",\n \"shipping_id\": \"\",\n \"shipping_last_name\": \"Newman\",\n \"shipping_method_name\": \"USPS_BeautyS1\",\n \"shipping_postcode\": \"32940\",\n \"shipping_state\": \"FL\",\n \"shipping_state_id\": \"FL\",\n \"shipping_street_address\": \"2830 Center Street\",\n \"shipping_street_address2\": \"\",\n \"shipping_company_name\": \"\",\n \"sub_affiliate\": \"\",\n \"time_stamp\": \"2023-04-11 07:58:23\",\n \"tracking_number\": \"9400111899563913402944\",\n \"transaction_id\": \"12345\",\n \"upsell_product_id\": \"\",\n \"upsell_product_quantity\": \"\",\n \"void_amount\": \"0.00\",\n \"void_date\": \"\",\n \"shippable\": \"1\",\n \"website_received\": \"\",\n \"website_sent\": \"\",\n \"is_cascaded\": \"0\",\n \"stop_after_next_rebill\": \"0\",\n \"order_customer_types\": [],\n \"consent_required\": \"0\",\n \"consent_received\": \"0\",\n \"utm_info\": {\n \"medium\": \"\",\n \"campaign\": \"\",\n \"content\": \"\",\n \"device_category\": \"\",\n \"term\": \"\",\n \"source\": \"\"\n },\n \"products\": [\n {\n \"product_id\": \"15\",\n \"sku\": \"SKU 15\",\n \"price\": \"0.00\",\n \"product_qty\": \"1\",\n \"name\": \"Product 15\",\n \"is_recurring\": \"0\",\n \"is_terminal\": \"0\",\n \"recurring_date\": \"2023-04-18\",\n \"subscription_id\": \"ea25f6919c425053962b49bacf6891e1\",\n \"next_subscription_product\": \"\",\n \"next_subscription_product_id\": \"\",\n \"next_subscription_product_price\": \"0.0000\",\n \"forecasted_revenue\": \"39.90\",\n \"next_subscription_qty\": \"\",\n \"billing_model_discount\": \"\",\n \"is_add_on\": \"0\",\n \"is_in_trial\": \"\",\n \"step_number\": \"\",\n \"is_shippable\": \"1\",\n \"is_full_refund\": \"0\",\n \"refund_amount\": \"0.00\",\n \"on_hold\": \"0\",\n \"hold_date\": \"\"\n }\n ],\n \"systemNotes\": [\n \"April 08, 2023 12:37 PM - sticky.io API - Shipped\",\n \"April 21, 2023 04:18 AM - sticky.io - New recurring with new order ID: 17984\",\n \"June 14, 2024 01:51 PM - sticky.io - Product 15 was forced to Gateway 39 from the Campaign Edit. This happened due to a change made to the campaign (3) changing to Gateway - Gateway 2 (2).\"\n ],\n \"totals_breakdown\": {\n \"total\": \"4.95\",\n \"subtotal\": \"0\",\n \"shipping\": \"4.95\",\n \"tax\": \"0\",\n \"tax_pct\": \"0\",\n \"vat_tax\": \"0\",\n \"vat_tax_pct\": \"0\",\n \"volume_discount\": \"0\",\n \"restocking_fee\": \"0\",\n \"amount_refunded\": \"0\",\n \"refunded\": \"0\"\n }\n}"},{"id":"54c8c2b1-f213-40fd-84f0-fa41615f0be1","name":"order_view with has been posted","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"order_id\":[\n\t\t12503\n\t],\n \"includes\" : [\n \"has_been_posted\"\n ]\n}"},"url":"https://{{app_key}}.{{domain}}{{api_ext}}order_view"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 20 Jun 2024 15:38:21 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Apache"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains;"},{"key":"Vary","value":"Authorization"},{"key":"Set-Cookie","value":"token=710ec375faf2b64f0f10a167014bf61f; expires=Thu, 20-Jun-2024 16:53:21 GMT; Max-Age=4500; path=/; secure; HttpOnly; SameSite=None"},{"key":"Set-Cookie","value":"token=710ec375faf2b64f0f10a167014bf61f; expires=Thu, 20-Jun-2024 16:53:21 GMT; Max-Age=4500; path=/; secure; HttpOnly; SameSite=None"},{"key":"Set-Cookie","value":"token=deleted; expires=Thu, 01-Jan-1970 00:00:01 GMT; Max-Age=0; path=/; secure; HttpOnly; SameSite=None"},{"key":"Set-Cookie","value":"limelight=deleted; expires=Thu, 01-Jan-1970 00:00:01 GMT; Max-Age=0; path=/; secure; HttpOnly; SameSite=None"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, PUT, DELETE, PATCH"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Authorization, X-Requested-With, Platform-Key, X-CSRF-TOKEN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"response_code\": \"100\",\n \"order_id\": \"12503\",\n \"contact_id\": \"\",\n \"acquisition_date\": \"2023-04-11 07:57:47\",\n \"ancestor_id\": \"12503\",\n \"affiliate\": \"170442\",\n \"afid\": \"170442\",\n \"sid\": \"\",\n \"affid\": \"\",\n \"c1\": \"\",\n \"c2\": \"\",\n \"c3\": \"\",\n \"aid\": \"\",\n \"opt\": \"\",\n \"amount_refunded_to_date\": \"0.00\",\n \"auth_id\": \"0\",\n \"billing_city\": \"St Marys\",\n \"billing_country\": \"US\",\n \"billing_cycle\": \"0\",\n \"billing_first_name\": \"Ervin\",\n \"billing_last_name\": \"Poole\",\n \"billing_postcode\": \"31558\",\n \"billing_state\": \"GA\",\n \"billing_state_id\": \"GA\",\n \"billing_street_address\": \"9012 Main Rd\",\n \"billing_street_address2\": \"\",\n \"billing_company_name\": \"\",\n \"campaign_id\": \"3\",\n \"cc_expires\": \"0218\",\n \"cc_first_6\": \"449733\",\n \"cc_last_4\": \"8936\",\n \"cc_number\": \"8936\",\n \"credit_card_number\": \"449733******8936\",\n \"cc_orig_first_6\": \"\",\n \"cc_orig_last_4\": \"\",\n \"cc_type\": \"visa\",\n \"chargeback_date\": \"\",\n \"check_account_last_4\": \"\",\n \"check_routing_last_4\": \"\",\n \"check_ssn_last_4\": \"\",\n \"check_transitnum\": \"\",\n \"child_id\": \"\",\n \"click_id\": \"\",\n \"created_by_user_name\": \"\",\n \"created_by_employee_name\": \"\",\n \"coupon_discount_amount\": \"0.00\",\n \"coupon_id\": \"\",\n \"credit_applied\": \"0.00\",\n \"promo_code\": \"\",\n \"customer_id\": \"0\",\n \"customers_telephone\": \"800-555-1212\",\n \"decline_salvage_discount_percent\": \"0\",\n \"retry_attempt\": \"0\",\n \"decline_reason\": \"Prepaid Credit Cards Are Not Accepted\",\n \"decline_reason_details\": \"\",\n \"email_address\": \"epoole31558@gmail.test\",\n \"first_name\": \"Ervin\",\n \"gateway_id\": \"39\",\n \"gateway_descriptor\": \"Gateway 39\",\n \"hold_date\": \"\",\n \"is_3d_protected\": \"no\",\n \"ip_address\": \"127.0.0.1\",\n \"ip_Address_lookup\": \"\",\n \"is_blacklisted\": \"0\",\n \"is_chargeback\": \"0\",\n \"is_fraud\": \"0\",\n \"is_recurring\": \"0\",\n \"is_any_product_recurring\": \"0\",\n \"is_refund\": \"no\",\n \"is_rma\": \"0\",\n \"is_test_cc\": \"0\",\n \"is_void\": \"no\",\n \"last_name\": \"Poole\",\n \"main_product_id\": \"15\",\n \"main_product_quantity\": \"1\",\n \"next_subscription_product\": \"\",\n \"next_subscription_product_id\": \"\",\n \"on_hold\": \"0\",\n \"on_hold_by\": \"\",\n \"order_confirmed\": \"NO_STATUS\",\n \"order_confirmed_date\": \"\",\n \"order_sales_tax\": \"0.00\",\n \"order_sales_tax_amount\": \"0.00\",\n \"shipping_amount\": \"4.95\",\n \"order_status\": \"7\",\n \"order_total\": \"4.95\",\n \"parent_id\": \"12503\",\n \"prepaid_match\": \"Yes\",\n \"preserve_gateway\": \"0\",\n \"processor_id\": \"\",\n \"rebill_discount_percent\": \"0\",\n \"current_rebill_discount_percent\": \"0\",\n \"recurring_date\": \"2023-04-18\",\n \"refund_amount\": \"0.00\",\n \"refund_date\": \"\",\n \"retry_date\": \"\",\n \"rma_number\": \"\",\n \"rma_reason\": \"\",\n \"return_reason\": \"\",\n \"shipping_city\": \"St Marys\",\n \"shipping_country\": \"US\",\n \"shipping_date\": \"Not Shipped\",\n \"shipping_first_name\": \"Ervin\",\n \"shipping_id\": \"\",\n \"shipping_last_name\": \"Poole\",\n \"shipping_method_name\": \"USPS_BeautyS1\",\n \"shipping_postcode\": \"31558\",\n \"shipping_state\": \"GA\",\n \"shipping_state_id\": \"GA\",\n \"shipping_street_address\": \"9012 Main Rd\",\n \"shipping_street_address2\": \"\",\n \"shipping_company_name\": \"\",\n \"sub_affiliate\": \"\",\n \"time_stamp\": \"2023-04-11 07:57:47\",\n \"tracking_number\": \"\",\n \"transaction_id\": \"12345\",\n \"upsell_product_id\": \"\",\n \"upsell_product_quantity\": \"\",\n \"void_amount\": \"0.00\",\n \"void_date\": \"\",\n \"shippable\": \"1\",\n \"website_received\": \"\",\n \"website_sent\": \"\",\n \"is_cascaded\": \"0\",\n \"stop_after_next_rebill\": \"0\",\n \"order_customer_types\": [],\n \"consent_required\": \"0\",\n \"consent_received\": \"0\",\n \"utm_info\": {\n \"medium\": \"\",\n \"campaign\": \"\",\n \"content\": \"\",\n \"device_category\": \"\",\n \"term\": \"\",\n \"source\": \"\"\n },\n \"has_been_posted\": \"0\",\n \"products\": [\n {\n \"product_id\": \"15\",\n \"sku\": \"SKU 15\",\n \"price\": \"0.00\",\n \"product_qty\": \"1\",\n \"name\": \"Product 15\",\n \"is_recurring\": \"0\",\n \"is_terminal\": \"0\",\n \"recurring_date\": \"2023-04-18\",\n \"subscription_id\": \"6e419be223c3eb61e471522ba34cdc60\",\n \"next_subscription_product\": \"\",\n \"next_subscription_product_id\": \"\",\n \"next_subscription_product_price\": \"0.0000\",\n \"forecasted_revenue\": \"0.00\",\n \"next_subscription_qty\": \"\",\n \"billing_model_discount\": \"\",\n \"is_add_on\": \"0\",\n \"is_in_trial\": \"\",\n \"step_number\": \"\",\n \"is_shippable\": \"1\",\n \"is_full_refund\": \"0\",\n \"refund_amount\": \"0.00\",\n \"on_hold\": \"0\",\n \"hold_date\": \"\"\n }\n ],\n \"systemNotes\": [\n \"April 07, 2023 07:57 AM - sticky.io - Declined by Payment Gateway (Prepaid Credit Cards Are Not Accepted)\"\n ],\n \"totals_breakdown\": {\n \"total\": \"4.95\",\n \"subtotal\": \"0\",\n \"shipping\": \"4.95\",\n \"tax\": \"0\",\n \"tax_pct\": \"0\",\n \"vat_tax\": \"0\",\n \"vat_tax_pct\": \"0\",\n \"volume_discount\": \"0\",\n \"restocking_fee\": \"0\",\n \"amount_refunded\": \"0\",\n \"refunded\": \"0\"\n }\n}"},{"id":"d8125bf5-b723-4d76-9447-25dded00c4cf","name":"order_view with refund info","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"order_id\":[\n\t\t14303\n\t],\n \"return_variants\":1\n}"},"url":"https://{{app_key}}.{{domain}}{{api_ext}}order_view"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 20 Jun 2024 15:39:19 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Apache"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains;"},{"key":"Vary","value":"Authorization"},{"key":"Set-Cookie","value":"token=f02a4ec14490a19a4e7a691fb187eac3; expires=Thu, 20-Jun-2024 16:54:18 GMT; Max-Age=4500; path=/; secure; HttpOnly; SameSite=None"},{"key":"Set-Cookie","value":"token=f02a4ec14490a19a4e7a691fb187eac3; expires=Thu, 20-Jun-2024 16:54:18 GMT; Max-Age=4500; path=/; secure; HttpOnly; SameSite=None"},{"key":"Set-Cookie","value":"token=deleted; expires=Thu, 01-Jan-1970 00:00:01 GMT; Max-Age=0; path=/; secure; HttpOnly; SameSite=None"},{"key":"Set-Cookie","value":"limelight=deleted; expires=Thu, 01-Jan-1970 00:00:01 GMT; Max-Age=0; path=/; secure; HttpOnly; SameSite=None"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, PUT, DELETE, PATCH"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Authorization, X-Requested-With, Platform-Key, X-CSRF-TOKEN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"response_code\": \"100\",\n \"order_id\": \"14303\",\n \"contact_id\": \"1643\",\n \"acquisition_date\": \"2023-04-18 09:35:16\",\n \"ancestor_id\": \"14303\",\n \"affiliate\": \"170373\",\n \"afid\": \"170373\",\n \"sid\": \"chiefkeef\",\n \"affid\": \"\",\n \"c1\": \"chiefkeef\",\n \"c2\": \"\",\n \"c3\": \"\",\n \"aid\": \"\",\n \"opt\": \"\",\n \"amount_refunded_to_date\": \"0.00\",\n \"auth_id\": \"006365\",\n \"billing_city\": \"Zachary\",\n \"billing_country\": \"US\",\n \"billing_cycle\": \"0\",\n \"billing_first_name\": \"Eldora\",\n \"billing_last_name\": \"Parker\",\n \"billing_postcode\": \"70791\",\n \"billing_state\": \"LA\",\n \"billing_state_id\": \"LA\",\n \"billing_street_address\": \"6152 First Rd\",\n \"billing_street_address2\": \"\",\n \"billing_company_name\": \"\",\n \"campaign_id\": \"3\",\n \"cc_expires\": \"0818\",\n \"cc_first_6\": \"444796\",\n \"cc_last_4\": \"5040\",\n \"cc_number\": \"5040\",\n \"credit_card_number\": \"444796******5040\",\n \"cc_orig_first_6\": \"\",\n \"cc_orig_last_4\": \"\",\n \"cc_type\": \"visa\",\n \"chargeback_date\": \"\",\n \"check_account_last_4\": \"\",\n \"check_routing_last_4\": \"\",\n \"check_ssn_last_4\": \"\",\n \"check_transitnum\": \"\",\n \"child_id\": \"23089,27604,57214,60767,66803,101347,141977,151050,161252\",\n \"click_id\": \"\",\n \"created_by_user_name\": \"\",\n \"created_by_employee_name\": \"\",\n \"coupon_discount_amount\": \"0.00\",\n \"coupon_id\": \"\",\n \"credit_applied\": \"0.00\",\n \"promo_code\": \"\",\n \"customer_id\": \"1568\",\n \"customers_telephone\": \"800-555-1212\",\n \"decline_salvage_discount_percent\": \"0\",\n \"retry_attempt\": \"0\",\n \"decline_reason\": \"\",\n \"decline_reason_details\": \"\",\n \"email_address\": \"eparker1568@gmail.test\",\n \"first_name\": \"Eldora\",\n \"gateway_id\": \"43\",\n \"gateway_descriptor\": \"Gateway 43\",\n \"hold_date\": \"\",\n \"is_3d_protected\": \"no\",\n \"ip_address\": \"127.0.0.1\",\n \"ip_Address_lookup\": \"\",\n \"is_blacklisted\": \"0\",\n \"is_chargeback\": \"0\",\n \"is_fraud\": \"0\",\n \"is_recurring\": \"0\",\n \"is_any_product_recurring\": \"0\",\n \"is_refund\": \"no\",\n \"is_rma\": \"0\",\n \"is_test_cc\": \"0\",\n \"is_void\": \"no\",\n \"last_name\": \"Parker\",\n \"main_product_id\": \"15\",\n \"main_product_quantity\": \"1\",\n \"next_subscription_product\": \"\",\n \"next_subscription_product_id\": \"\",\n \"on_hold\": \"0\",\n \"on_hold_by\": \"\",\n \"order_confirmed\": \"NO_STATUS\",\n \"order_confirmed_date\": \"\",\n \"order_sales_tax\": \"0.00\",\n \"order_sales_tax_amount\": \"0.00\",\n \"shipping_amount\": \"4.95\",\n \"order_status\": \"8\",\n \"order_total\": \"4.95\",\n \"parent_id\": \"14303\",\n \"prepaid_match\": \"No\",\n \"preserve_gateway\": \"1\",\n \"processor_id\": \"\",\n \"rebill_discount_percent\": \"0\",\n \"current_rebill_discount_percent\": \"0\",\n \"recurring_date\": \"2023-04-25\",\n \"refund_amount\": \"0.00\",\n \"refund_date\": \"\",\n \"retry_date\": \"2023-04-30\",\n \"rma_number\": \"\",\n \"rma_reason\": \"\",\n \"return_reason\": \"\",\n \"shipping_city\": \"Zachary\",\n \"shipping_country\": \"US\",\n \"shipping_date\": \"04/12/2023\",\n \"shipping_first_name\": \"Eldora\",\n \"shipping_id\": \"\",\n \"shipping_last_name\": \"Parker\",\n \"shipping_method_name\": \"USPS_BeautyS1\",\n \"shipping_postcode\": \"70791\",\n \"shipping_state\": \"LA\",\n \"shipping_state_id\": \"LA\",\n \"shipping_street_address\": \"6152 First Rd\",\n \"shipping_street_address2\": \"\",\n \"shipping_company_name\": \"\",\n \"sub_affiliate\": \"chiefkeef\",\n \"time_stamp\": \"2023-04-18 09:35:16\",\n \"tracking_number\": \"9400111899563326468896\",\n \"transaction_id\": \"12345\",\n \"upsell_product_id\": \"\",\n \"upsell_product_quantity\": \"\",\n \"void_amount\": \"0.00\",\n \"void_date\": \"\",\n \"shippable\": \"1\",\n \"website_received\": \"\",\n \"website_sent\": \"\",\n \"is_cascaded\": \"0\",\n \"stop_after_next_rebill\": \"0\",\n \"order_customer_types\": [],\n \"consent_required\": \"0\",\n \"consent_received\": \"0\",\n \"utm_info\": {\n \"medium\": \"\",\n \"campaign\": \"\",\n \"content\": \"\",\n \"device_category\": \"\",\n \"term\": \"\",\n \"source\": \"\"\n },\n \"products\": [\n {\n \"product_id\": \"15\",\n \"sku\": \"SKU 15\",\n \"price\": \"0.00\",\n \"product_qty\": \"1\",\n \"name\": \"Product 15\",\n \"is_recurring\": \"0\",\n \"is_terminal\": \"0\",\n \"recurring_date\": \"2023-04-25\",\n \"subscription_id\": \"c6d0ce9a9ad3008d4789b2d0c63ada6f\",\n \"next_subscription_product\": \"\",\n \"next_subscription_product_id\": \"\",\n \"next_subscription_product_price\": \"0.0000\",\n \"forecasted_revenue\": \"39.90\",\n \"next_subscription_qty\": \"\",\n \"billing_model_discount\": \"\",\n \"is_add_on\": \"0\",\n \"is_in_trial\": \"\",\n \"step_number\": \"\",\n \"is_shippable\": \"1\",\n \"is_full_refund\": \"0\",\n \"refund_amount\": \"0.00\",\n \"on_hold\": \"0\",\n \"hold_date\": \"\"\n }\n ],\n \"systemNotes\": [\n \"April 14, 2023 09:35 AM - sticky.io - Street Address and 5 Digit Zip Exact Match\",\n \"April 14, 2023 09:35 AM - sticky.io - CVV2/CVC2 match\",\n \"April 15, 2023 11:17 AM - sticky.io API - Shipped\",\n \"April 28, 2023 04:41 AM - sticky.io - Product(s) attemped to recur and were declined. The next attempt of this subscription billing will be on 01/25/2016.\",\n \"April 28, 2023 04:41 AM - sticky.io - Recurring failed\",\n \"May 03, 2023 04:18 AM - sticky.io - New recurring with new order ID: 27604\",\n \"June 14, 2024 01:51 PM - sticky.io - Product 15 was forced to Gateway 43 from the Campaign Edit. This happened due to a change made to the campaign (3) changing to Gateway - Gateway 2 (2).\"\n ],\n \"totals_breakdown\": {\n \"total\": \"4.95\",\n \"subtotal\": \"0\",\n \"shipping\": \"4.95\",\n \"tax\": \"0\",\n \"tax_pct\": \"0\",\n \"vat_tax\": \"0\",\n \"vat_tax_pct\": \"0\",\n \"volume_discount\": \"0\",\n \"restocking_fee\": \"0\",\n \"amount_refunded\": \"0\",\n \"refunded\": \"0\"\n }\n}"},{"id":"bb8ebb0e-a523-4476-9a79-703e6987610a","name":"order_view with return_variants","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"order_id\":[\n\t\t13002\n\t],\n \"return_variants\":1\n}"},"url":"https://{{app_key}}.{{domain}}{{api_ext}}order_view"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 20 Jun 2024 15:40:34 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Apache"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains;"},{"key":"Vary","value":"Authorization"},{"key":"Set-Cookie","value":"token=edfdc4b1823019213a04660dd25c3c43; expires=Thu, 20-Jun-2024 16:55:33 GMT; Max-Age=4500; path=/; secure; HttpOnly; SameSite=None"},{"key":"Set-Cookie","value":"token=edfdc4b1823019213a04660dd25c3c43; expires=Thu, 20-Jun-2024 16:55:33 GMT; Max-Age=4500; path=/; secure; HttpOnly; SameSite=None"},{"key":"Set-Cookie","value":"token=deleted; expires=Thu, 01-Jan-1970 00:00:01 GMT; Max-Age=0; path=/; secure; HttpOnly; SameSite=None"},{"key":"Set-Cookie","value":"limelight=deleted; expires=Thu, 01-Jan-1970 00:00:01 GMT; Max-Age=0; path=/; secure; HttpOnly; SameSite=None"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, PUT, DELETE, PATCH"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Authorization, X-Requested-With, Platform-Key, X-CSRF-TOKEN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"response_code\": \"100\",\n \"order_id\": \"13002\",\n \"contact_id\": \"\",\n \"acquisition_date\": \"2023-04-12 07:36:11\",\n \"ancestor_id\": \"13002\",\n \"affiliate\": \"170442\",\n \"afid\": \"170442\",\n \"sid\": \"\",\n \"affid\": \"\",\n \"c1\": \"\",\n \"c2\": \"\",\n \"c3\": \"72npqyos_53_12320168\",\n \"aid\": \"\",\n \"opt\": \"\",\n \"amount_refunded_to_date\": \"0.00\",\n \"auth_id\": \"0\",\n \"billing_city\": \"Jacksonville\",\n \"billing_country\": \"US\",\n \"billing_cycle\": \"0\",\n \"billing_first_name\": \"Jeffrey\",\n \"billing_last_name\": \"Lummus\",\n \"billing_postcode\": \"32218\",\n \"billing_state\": \"FL\",\n \"billing_state_id\": \"FL\",\n \"billing_street_address\": \"8107 9th Rd\",\n \"billing_street_address2\": \"\",\n \"billing_company_name\": \"\",\n \"campaign_id\": \"3\",\n \"cc_expires\": \"0424\",\n \"cc_first_6\": \"516488\",\n \"cc_last_4\": \"8009\",\n \"cc_number\": \"8009\",\n \"credit_card_number\": \"516488******8009\",\n \"cc_orig_first_6\": \"\",\n \"cc_orig_last_4\": \"\",\n \"cc_type\": \"master\",\n \"chargeback_date\": \"\",\n \"check_account_last_4\": \"\",\n \"check_routing_last_4\": \"\",\n \"check_ssn_last_4\": \"\",\n \"check_transitnum\": \"\",\n \"child_id\": \"\",\n \"click_id\": \"\",\n \"created_by_user_name\": \"\",\n \"created_by_employee_name\": \"\",\n \"coupon_discount_amount\": \"0.00\",\n \"coupon_id\": \"\",\n \"credit_applied\": \"0.00\",\n \"promo_code\": \"\",\n \"customer_id\": \"0\",\n \"customers_telephone\": \"800-555-1212\",\n \"decline_salvage_discount_percent\": \"0\",\n \"retry_attempt\": \"0\",\n \"decline_reason\": \"Prepaid Credit Cards Are Not Accepted\",\n \"decline_reason_details\": \"\",\n \"email_address\": \"jlummus32218@gmail.test\",\n \"first_name\": \"Jeffrey\",\n \"gateway_id\": \"43\",\n \"gateway_descriptor\": \"Gateway 43\",\n \"hold_date\": \"\",\n \"is_3d_protected\": \"no\",\n \"ip_address\": \"127.0.0.1\",\n \"ip_Address_lookup\": \"\",\n \"is_blacklisted\": \"0\",\n \"is_chargeback\": \"0\",\n \"is_fraud\": \"0\",\n \"is_recurring\": \"0\",\n \"is_any_product_recurring\": \"0\",\n \"is_refund\": \"no\",\n \"is_rma\": \"0\",\n \"is_test_cc\": \"0\",\n \"is_void\": \"no\",\n \"last_name\": \"Lummus\",\n \"main_product_id\": \"15\",\n \"main_product_quantity\": \"1\",\n \"next_subscription_product\": \"\",\n \"next_subscription_product_id\": \"\",\n \"on_hold\": \"0\",\n \"on_hold_by\": \"\",\n \"order_confirmed\": \"NO_STATUS\",\n \"order_confirmed_date\": \"\",\n \"order_sales_tax\": \"0.00\",\n \"order_sales_tax_amount\": \"0.00\",\n \"shipping_amount\": \"4.95\",\n \"order_status\": \"7\",\n \"order_total\": \"4.95\",\n \"parent_id\": \"13002\",\n \"prepaid_match\": \"Yes\",\n \"preserve_gateway\": \"1\",\n \"processor_id\": \"\",\n \"rebill_discount_percent\": \"0\",\n \"current_rebill_discount_percent\": \"0\",\n \"recurring_date\": \"2023-04-19\",\n \"refund_amount\": \"0.00\",\n \"refund_date\": \"\",\n \"retry_date\": \"\",\n \"rma_number\": \"\",\n \"rma_reason\": \"\",\n \"return_reason\": \"\",\n \"shipping_city\": \"Jacksonville\",\n \"shipping_country\": \"US\",\n \"shipping_date\": \"Not Shipped\",\n \"shipping_first_name\": \"Jeffrey\",\n \"shipping_id\": \"\",\n \"shipping_last_name\": \"Lummus\",\n \"shipping_method_name\": \"First Class Mail 3\",\n \"shipping_postcode\": \"32218\",\n \"shipping_state\": \"FL\",\n \"shipping_state_id\": \"FL\",\n \"shipping_street_address\": \"8107 9th Rd\",\n \"shipping_street_address2\": \"\",\n \"shipping_company_name\": \"\",\n \"sub_affiliate\": \"\",\n \"time_stamp\": \"2023-04-12 07:36:11\",\n \"tracking_number\": \"\",\n \"transaction_id\": \"12345\",\n \"upsell_product_id\": \"\",\n \"upsell_product_quantity\": \"\",\n \"void_amount\": \"0.00\",\n \"void_date\": \"\",\n \"shippable\": \"1\",\n \"website_received\": \"\",\n \"website_sent\": \"\",\n \"is_cascaded\": \"0\",\n \"stop_after_next_rebill\": \"0\",\n \"order_customer_types\": [],\n \"consent_required\": \"0\",\n \"consent_received\": \"0\",\n \"utm_info\": {\n \"medium\": \"\",\n \"campaign\": \"\",\n \"content\": \"\",\n \"device_category\": \"\",\n \"term\": \"\",\n \"source\": \"\"\n },\n \"products\": [\n {\n \"product_id\": \"15\",\n \"sku\": \"SKU 15\",\n \"price\": \"0.00\",\n \"product_qty\": \"1\",\n \"name\": \"Product 15\",\n \"is_recurring\": \"0\",\n \"is_terminal\": \"0\",\n \"recurring_date\": \"2023-04-19\",\n \"subscription_id\": \"c972c60158afede9f5add5298b8f10f8\",\n \"next_subscription_product\": \"\",\n \"next_subscription_product_id\": \"\",\n \"next_subscription_product_price\": \"0.0000\",\n \"forecasted_revenue\": \"0.00\",\n \"next_subscription_qty\": \"\",\n \"billing_model_discount\": \"\",\n \"is_add_on\": \"0\",\n \"is_in_trial\": \"\",\n \"step_number\": \"\",\n \"is_shippable\": \"1\",\n \"is_full_refund\": \"0\",\n \"refund_amount\": \"0.00\",\n \"on_hold\": \"0\",\n \"hold_date\": \"\"\n }\n ],\n \"employeeNotes\": [\n \"June 07, 2024 08:54 PM - Stacie Manrique - Employee note: Example Note for username\",\n \"June 07, 2024 09:02 PM - n/a - Employee note: SSO user example note\",\n \"June 07, 2024 09:04 PM - n/a - Employee note: Customer requested refund\",\n \"June 14, 2024 08:21 AM - Demo API - Employee note: testing note\"\n ],\n \"systemNotes\": [\n \"April 09, 2023 07:36 AM - sticky.io - Declined by Payment Gateway (Prepaid Credit Cards Are Not Accepted)\",\n \"June 07, 2024 08:54 PM - Stacie Manrique - Changed Shipping Method from USPS_BeautyS1 to First Class Mail 3\"\n ],\n \"totals_breakdown\": {\n \"total\": \"4.95\",\n \"subtotal\": \"0\",\n \"shipping\": \"4.95\",\n \"tax\": \"0\",\n \"tax_pct\": \"0\",\n \"vat_tax\": \"0\",\n \"vat_tax_pct\": \"0\",\n \"volume_discount\": \"0\",\n \"restocking_fee\": \"0\",\n \"amount_refunded\": \"0\",\n \"refunded\": \"0\"\n }\n}"},{"id":"d41d543b-ffad-4b29-8b98-c79b49b65bad","name":"order_view with bundle children","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"order_id\":[\n\t\t12504\n\t]\n}"},"url":"https://{{app_key}}.{{domain}}{{api_ext}}order_view"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 20 Jun 2024 15:41:34 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Apache"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains;"},{"key":"Vary","value":"Authorization"},{"key":"Set-Cookie","value":"token=8a88c1e733d20fa79facd69e7633b496; expires=Thu, 20-Jun-2024 16:56:34 GMT; Max-Age=4500; path=/; secure; HttpOnly; SameSite=None"},{"key":"Set-Cookie","value":"token=8a88c1e733d20fa79facd69e7633b496; expires=Thu, 20-Jun-2024 16:56:34 GMT; Max-Age=4500; path=/; secure; HttpOnly; SameSite=None"},{"key":"Set-Cookie","value":"token=deleted; expires=Thu, 01-Jan-1970 00:00:01 GMT; Max-Age=0; path=/; secure; HttpOnly; SameSite=None"},{"key":"Set-Cookie","value":"limelight=deleted; expires=Thu, 01-Jan-1970 00:00:01 GMT; Max-Age=0; path=/; secure; HttpOnly; SameSite=None"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, PUT, DELETE, PATCH"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Authorization, X-Requested-With, Platform-Key, X-CSRF-TOKEN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"response_code\": \"100\",\n \"order_id\": \"12504\",\n \"contact_id\": \"989\",\n \"acquisition_date\": \"2023-04-10 07:58:16\",\n \"ancestor_id\": \"12504\",\n \"affiliate\": \"170442\",\n \"afid\": \"170442\",\n \"sid\": \"\",\n \"affid\": \"\",\n \"c1\": \"\",\n \"c2\": \"\",\n \"c3\": \"gmnce329_53_12082293\",\n \"aid\": \"\",\n \"opt\": \"\",\n \"amount_refunded_to_date\": \"0.00\",\n \"auth_id\": \"\",\n \"billing_city\": \"Columbia\",\n \"billing_country\": \"US\",\n \"billing_cycle\": \"0\",\n \"billing_first_name\": \"Lois\",\n \"billing_last_name\": \"Young\",\n \"billing_postcode\": \"65201\",\n \"billing_state\": \"MO\",\n \"billing_state_id\": \"MO\",\n \"billing_street_address\": \"1452 4th Street\",\n \"billing_street_address2\": \"\",\n \"billing_company_name\": \"\",\n \"campaign_id\": \"3\",\n \"cc_expires\": \"0320\",\n \"cc_first_6\": \"414709\",\n \"cc_last_4\": \"8539\",\n \"cc_number\": \"8539\",\n \"credit_card_number\": \"414709******8539\",\n \"cc_orig_first_6\": \"\",\n \"cc_orig_last_4\": \"\",\n \"cc_type\": \"visa\",\n \"chargeback_date\": \"\",\n \"check_account_last_4\": \"\",\n \"check_routing_last_4\": \"\",\n \"check_ssn_last_4\": \"\",\n \"check_transitnum\": \"\",\n \"child_id\": \"17983\",\n \"click_id\": \"\",\n \"created_by_user_name\": \"\",\n \"created_by_employee_name\": \"\",\n \"coupon_discount_amount\": \"0.00\",\n \"coupon_id\": \"\",\n \"credit_applied\": \"0.00\",\n \"promo_code\": \"\",\n \"customer_id\": \"914\",\n \"customers_telephone\": \"800-555-1212\",\n \"decline_salvage_discount_percent\": \"0\",\n \"retry_attempt\": \"0\",\n \"decline_reason\": \"\",\n \"decline_reason_details\": \"\",\n \"email_address\": \"lyoung914@gmail.test\",\n \"first_name\": \"Lois\",\n \"gateway_id\": \"39\",\n \"gateway_descriptor\": \"Gateway 39\",\n \"hold_date\": \"\",\n \"is_3d_protected\": \"no\",\n \"ip_address\": \"127.0.0.1\",\n \"ip_Address_lookup\": \"\",\n \"is_blacklisted\": \"0\",\n \"is_chargeback\": \"0\",\n \"is_fraud\": \"0\",\n \"is_recurring\": \"0\",\n \"is_any_product_recurring\": \"0\",\n \"is_refund\": \"no\",\n \"is_rma\": \"0\",\n \"is_test_cc\": \"0\",\n \"is_void\": \"no\",\n \"last_name\": \"Young\",\n \"main_product_id\": \"15\",\n \"main_product_quantity\": \"1\",\n \"next_subscription_product\": \"\",\n \"next_subscription_product_id\": \"\",\n \"on_hold\": \"0\",\n \"on_hold_by\": \"\",\n \"order_confirmed\": \"NO_STATUS\",\n \"order_confirmed_date\": \"\",\n \"order_sales_tax\": \"0.00\",\n \"order_sales_tax_amount\": \"0.00\",\n \"shipping_amount\": \"4.95\",\n \"order_status\": \"8\",\n \"order_total\": \"4.95\",\n \"parent_id\": \"12504\",\n \"prepaid_match\": \"No\",\n \"preserve_gateway\": \"1\",\n \"processor_id\": \"\",\n \"rebill_discount_percent\": \"0\",\n \"current_rebill_discount_percent\": \"0\",\n \"recurring_date\": \"2023-04-17\",\n \"refund_amount\": \"0.00\",\n \"refund_date\": \"\",\n \"retry_date\": \"\",\n \"rma_number\": \"\",\n \"rma_reason\": \"\",\n \"return_reason\": \"\",\n \"shipping_city\": \"Columbia\",\n \"shipping_country\": \"US\",\n \"shipping_date\": \"04/04/2023\",\n \"shipping_first_name\": \"Lois\",\n \"shipping_id\": \"\",\n \"shipping_last_name\": \"Young\",\n \"shipping_method_name\": \"USPS_BeautyS1\",\n \"shipping_postcode\": \"65201\",\n \"shipping_state\": \"MO\",\n \"shipping_state_id\": \"MO\",\n \"shipping_street_address\": \"1452 4th Street\",\n \"shipping_street_address2\": \"\",\n \"shipping_company_name\": \"\",\n \"sub_affiliate\": \"\",\n \"time_stamp\": \"2023-04-10 07:58:16\",\n \"tracking_number\": \"9400111899563913402876\",\n \"transaction_id\": \"12345\",\n \"upsell_product_id\": \"\",\n \"upsell_product_quantity\": \"\",\n \"void_amount\": \"0.00\",\n \"void_date\": \"\",\n \"shippable\": \"1\",\n \"website_received\": \"\",\n \"website_sent\": \"\",\n \"is_cascaded\": \"0\",\n \"stop_after_next_rebill\": \"0\",\n \"order_customer_types\": [],\n \"consent_required\": \"0\",\n \"consent_received\": \"0\",\n \"utm_info\": {\n \"medium\": \"\",\n \"campaign\": \"\",\n \"content\": \"\",\n \"device_category\": \"\",\n \"term\": \"\",\n \"source\": \"\"\n },\n \"products\": [\n {\n \"product_id\": \"15\",\n \"sku\": \"SKU 15\",\n \"price\": \"0.00\",\n \"product_qty\": \"1\",\n \"name\": \"Product 15\",\n \"is_recurring\": \"0\",\n \"is_terminal\": \"0\",\n \"recurring_date\": \"2023-04-17\",\n \"subscription_id\": \"b27d99ec36737d8f34cc0e91aa2e1071\",\n \"next_subscription_product\": \"\",\n \"next_subscription_product_id\": \"\",\n \"next_subscription_product_price\": \"0.0000\",\n \"forecasted_revenue\": \"39.90\",\n \"next_subscription_qty\": \"\",\n \"billing_model_discount\": \"\",\n \"is_add_on\": \"0\",\n \"is_in_trial\": \"\",\n \"step_number\": \"\",\n \"is_shippable\": \"1\",\n \"is_full_refund\": \"0\",\n \"refund_amount\": \"0.00\",\n \"on_hold\": \"0\",\n \"hold_date\": \"\"\n }\n ],\n \"systemNotes\": [\n \"April 08, 2023 12:37 PM - sticky.io API - Shipped\",\n \"April 21, 2023 04:18 AM - sticky.io - New recurring with new order ID: 17983\",\n \"June 14, 2024 01:51 PM - sticky.io - Product 15 was forced to Gateway 39 from the Campaign Edit. This happened due to a change made to the campaign (3) changing to Gateway - Gateway 2 (2).\"\n ],\n \"totals_breakdown\": {\n \"total\": \"4.95\",\n \"subtotal\": \"0\",\n \"shipping\": \"4.95\",\n \"tax\": \"0\",\n \"tax_pct\": \"0\",\n \"vat_tax\": \"0\",\n \"vat_tax_pct\": \"0\",\n \"volume_discount\": \"0\",\n \"restocking_fee\": \"0\",\n \"amount_refunded\": \"0\",\n \"refunded\": \"0\"\n }\n}"}],"_postman_id":"fa3f4efb-0b1f-4467-9454-3bb1aff96aae"},{"name":"order_update","id":"50bf0f66-38b2-4513-908d-04f4af02593f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_username}}"},{"key":"password","value":"{{api_password}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"order_id\":\n {\n \"101971\":\n {\n \"cc_number\":\"7354586839391233\",\n \"cc_payment_type\":\"visa\",\n \"notes\":\"Adding a new note to this order via order_update method\",\n \"cc_expiration_date\": 1225\n }\n }\n}"},"url":"https://{{app_key}}.{{domain}}{{api_ext}}order_update","description":"The order_update method is currently used to update a range of values on an order. You will find the parameters that can be passed for each order_id below.
Max Requests Per Minute: 120
\nThe format of the request should be as follows:
\n{\n \"order_id\":\n {\n \"\":\n {\n \"\":\"\",\n \"\":\"\",\n \"\":\"\",\n \"\":\"\"\n },\n \"\":\n {\n \"\":\"\",\n \"\":\"\",\n \"\":\"\",\n \"\":\"\"\n }\n }\n}\n\nNOTE If all updates are successful, a response_code of 100 will be returned. If not all updates are successful a response_code of 911 will be sent with a breakdown of success and failure per order, per field attempted to update
This method is used for issuing product refunds.
\nMax Requests Per Minute: 120
\nREQUIRED FIELDS\norder_id and product_id are required fields. quantity OR amount are also required field(s).
OPTIONAL FIELD\nstop_recurring is an optional field. If \"stop_recurring\":\"1\" is passed in the request - that line item will no longer recur.
This method is used for product returns.
\nMax Requests Per Minute: 120
\nreason_idThis method is used for issuing refunds to an entire order.
\nMax Requests Per Minute: 120
\nKEEP RECURRING\nIf \"keep_recurring\":\"0\" is passed in the request - all products attached to the order_id sent will no longer recur.\n\"keep_recurring\":\"1\" is passed in the request - all products attached to the order_id sent will continue to recur.
** Order Note **
\nYou may also pass note_id as a parameter that is the ID of an order note template refund note type and that note will be added to the order
This method is used to perform a reprocess on the given order.
\nMax Requests Per Minute: 120
\n","urlObject":{"protocol":"https","host":["{{app_key}}","{{domain}}{{api_ext}}order_reprocess"],"query":[],"variable":[]}},"response":[{"id":"6a9d9f32-3023-471c-b6ea-e797552e0103","name":"order_reprocess","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"order_id\":\"11279\"\n}"},"url":"https://{{app_key}}.{{domain}}{{api_ext}}order_reprocess"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"error_found\":\"1\",\n \"response_code\":\"800\",\n \"response_message\":\"There was an error trying to reprocess your order\",\n \"decline_reason\":\"This transaction has been declined\"\n}"}],"_postman_id":"2a83229f-9273-4319-89a6-7af1e30cf7e5"},{"name":"order_void","id":"a5b27f88-c2e1-4bf6-8d6d-8fbd1f26598f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_username}}"},{"key":"password","value":"{{api_password}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"order_id\":\"11279\"\n}"},"url":"https://{{app_key}}.{{domain}}{{api_ext}}order_void","description":"This method is used to perform a void on the given order. Typically a void must be placed against an order within 24 hours of a transaction. Subscriptions will be canceled when a successful void is put in place.
\nMax Requests Per Minute: 120
\n","urlObject":{"protocol":"https","host":["{{app_key}}","{{domain}}{{api_ext}}order_void"],"query":[],"variable":[]}},"response":[{"id":"a6f7b726-c2c7-4ac5-bacb-92faaa18cab4","name":"order_void","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"order_id\":\"11279\"\n}"},"url":"https://{{app_key}}.{{domain}}{{api_ext}}order_void"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"response_code\":\"100\"\r\n}"}],"_postman_id":"a5b27f88-c2e1-4bf6-8d6d-8fbd1f26598f"},{"name":"repost_to_fulfillment","id":"8022509c-ab4c-49c9-9216-eeb274ec274c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_username}}"},{"key":"password","value":"{{api_password}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"order_id\":\"11431\"\n}"},"url":"https://{{app_key}}.{{domain}}{{api_ext}}repost_to_fulfillment","description":"This method is used to send orders to the fulfillment provider that have already been shipped out once before.
\nMax Requests Per Minute: 120
\n","urlObject":{"protocol":"https","host":["{{app_key}}","{{domain}}{{api_ext}}repost_to_fulfillment"],"query":[],"variable":[]}},"response":[{"id":"c119f8a6-87fa-4597-9167-a8e51952cbaf","name":"repost_to_fulfillment","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","disabled":false}],"body":{"mode":"raw","raw":"{\n\t\"order_id\":\"11431\"\n}"},"url":"https://{{app_key}}.{{domain}}{{api_ext}}repost_to_fulfillment"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Connection","value":"keep-alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Length","value":"23","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 06 Jul 2018 13:16:41 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains;","name":"Strict-Transport-Security","description":"A HSTS Policy informing the HTTP client how long to cache the HTTPS only policy and whether this applies to subdomains."},{"key":"Vary","value":"Authorization","name":"Vary","description":"Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."}],"cookie":[{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":false,"domain":"dev.limelightcrm.com","path":"/","secure":true,"value":"PHPSTORM","key":"XDEBUG_SESSION"}],"responseTime":null,"body":"{\"response_code\":\"425\"}"},{"id":"fb46f494-bdc1-49e0-a852-fbfdec27701d","name":"repost_to_fulfillment","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","disabled":false}],"body":{"mode":"raw","raw":"{\n\t\"order_id\":\"11431\"\n}"},"url":"https://{{app_key}}.{{domain}}{{api_ext}}repost_to_fulfillment"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Connection","value":"keep-alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Length","value":"23","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 06 Jul 2018 13:16:29 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains;","name":"Strict-Transport-Security","description":"A HSTS Policy informing the HTTP client how long to cache the HTTPS only policy and whether this applies to subdomains."},{"key":"Vary","value":"Authorization","name":"Vary","description":"Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."}],"cookie":[{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":false,"domain":"dev.limelightcrm.com","path":"/","secure":true,"value":"PHPSTORM","key":"XDEBUG_SESSION"}],"responseTime":null,"body":"{\"response_code\":\"100\"}"}],"_postman_id":"8022509c-ab4c-49c9-9216-eeb274ec274c"},{"name":"skip_next_billing","id":"27350315-72b1-41c1-93c0-fcdae3eb45fa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_username}}"},{"key":"password","value":"{{api_password}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"subscription_id\":\"14ddfd8f97f3ca86ed72dd3c8111b800\",\n\t\"skip_next_product\":1\n}"},"url":"https://{{app_key}}.{{domain}}{{api_ext}}skip_next_billing","description":"This method is used to skip the next billing cycle on an existing subscription. The subscription_id that is passed can be found via order_view in the products array. An additonal parameter of skip_next_product with a flag of 1 can also be passed to skip the next product in the subscription chain. This will only work with products passed using billing models / offers.
Max Requests Per Minute: 120
\n","urlObject":{"protocol":"https","host":["{{app_key}}","{{domain}}{{api_ext}}skip_next_billing"],"query":[],"variable":[]}},"response":[{"id":"277735e0-0065-41e1-9c4b-dd0f17623891","name":"skip_next_billing","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","disabled":false}],"body":{"mode":"raw","raw":"{\n\t\"subscription_id\":\"14ddfd8f97f3ca86ed72dd3c8111b800\"\n}"},"url":"https://{{app_key}}.{{domain}}{{api_ext}}skip_next_billing"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Connection","value":"keep-alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Length","value":"23","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 06 Jul 2018 13:48:43 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains;","name":"Strict-Transport-Security","description":"A HSTS Policy informing the HTTP client how long to cache the HTTPS only policy and whether this applies to subdomains."},{"key":"Vary","value":"Authorization","name":"Vary","description":"Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."}],"cookie":[{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":false,"domain":"dev.limelightcrm.com","path":"/","secure":true,"value":"PHPSTORM","key":"XDEBUG_SESSION"}],"responseTime":null,"body":"{\"response_code\":\"100\"}"}],"_postman_id":"27350315-72b1-41c1-93c0-fcdae3eb45fa"},{"name":"subscription_order_update","id":"9c2253fb-d8e2-437b-a184-4f21d0ba994c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_username}}"},{"key":"password","value":"{{api_password}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"order_id\":\"13198\",\n\t\"product_id\":\"53\",\n \"new_recurring_date\" : \"05/03/2021\"\n}"},"url":"https://{{app_key}}.{{domain}}{{api_ext}}subscription_order_update","description":"This method is to update an existing order's recurring details. If updating more than one section - the response will give an over all response_code of 100 if all updates were successful as well as a break down of what occurred in each update. If only one update is being made the response will be for only that update.
Max Requests Per Minute: 60
\nFor any of the children parameters that are passed. The following format is required.
Example(replace additional_product_children for children where required:
{\n \"additional_product_children\":\n [\n {\n \"product_id\":\"2\",\n \"quantity\":\"1\"\n },\n {\n \"product_id\":\"1\",\n \"quantity\":\"2\"\n }\n ],\n}\n\nThis method is use for orders that return response code 101 from the NewOrder method. This method redirects the customer to their personal bank URL for 3D Secure payments.
\nMax Requests Per Minute: 120
\nThere are currently three methods that can be used to post new orders into the system which include:
\nnew_order (requiring all fields re-entered each time and re-passed to the API each time)new_order_card_on_file (passing in an existing order's information, but new product, campaign and shipping parameters to make a sale of a card on file)new_order_with_prospect (first using the new_prospect method to create a prospect record which returns a prospectId that will be used for this method. The existing information you captured earlier from new_prospect will be used to complete the sale and clean up the prospect record if sale is completed without decline. The prospect will be converted to a customer upon a successful sale)children array:{\n \"children\":\n [\n {\n \"product_id\":\"1\",\n \"quantity\":\"2\"\n },\n {\n \"product_id\":\"2\",\n \"quantity\":\"1\"\n }\n ]\n}\nproducts array. ** PLEASE NOTE THIS WILL BE DEPRECATED 12/31/2018 IN LIEU OF OFFERS ARRAY **:{\n \"4\":\n {\n \"offer_id\":\"8\",\n \"billing_model_id\":\"6\",\n \"quantity\":\"1\",\n \"children\":\n [\n {\n \"product_id\":\"1\",\n \"quantity\":\"2\"\n },\n {\n \"product_id\":\"2\",\n \"quantity\":\"1\"\n }\n ],\n \"trial\":\n {\n \"product_id\":\"4\",\n \"children\":\n [\n {\n \"product_id\":\"1\",\n \"quantity\":\"2\"\n },\n {\n \"product_id\":\"2\",\n \"quantity\":\"1\"\n }\n ],\n \"price\":\"0.99\",\n \"quantity\":1\n }\n },\n \"16\":\n {\n \"offer_id\":\"8\",\n \"billing_model_id\":\"4\",\n \"quantity\":\"2\",\n \"step_num\":\"2\"\n }\n}\noffers Array: \"offers\":\n [\n {\n \"offer_id\":\"8\",\n \"product_id\":\"4\",\n \"billing_model_id\":\"6\",\n \"quantity\":\"1\",\n \"children\":\n [\n {\n \"product_id\":\"1\",\n \"quantity\":\"2\"\n },\n {\n \"product_id\":\"2\",\n \"quantity\":\"1\"\n }\n ],\n \"trial\":\n {\n \"product_id\":\"4\",\n \"price\":\"9.99\",\n \"children\":\n [\n {\n \"product_id\":\"1\",\n \"quantity\":\"2\"\n },\n {\n \"product_id\":\"2\",\n \"quantity\":\"1\"\n }\n ]\n }\n },\n {\n \"offer_id\":\"8\",\n \"product_id\":16,\n \"billing_model_id\":\"4\",\n \"quantity\":\"2\",\n \"step_num\":\"2\",\n \"variant\":\n [\n {\n \"attribute_name\":\"color\",\n \"attribute_value\":\"Blue\"\n }\n \n ]\n }\n ]\nThe customer_find method is used to retrieve a list of customer ids that match a set of criteria.
\nWildcards may be used when full data is not available.
\nAn optional parameter, return_type, may be passed. If return_type is sent as customer_view, in addition to the normal return parameters you will also receive a data parameter that contains an object of the data returned by the customer_view method for each customer returned.
See the customer_view definition for return values.
\nMax Requests Per Minute: 120
\n","urlObject":{"protocol":"https","host":["{{app_key}}","{{domain}}{{api_ext}}customer_find"],"query":[],"variable":[]}},"response":[{"id":"aec09dc3-3abd-458b-acfe-3d58d305bddd","name":"customer_find","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n\t\"campaign_id\":\"all\",\r\n\t\"start_date\":\"01/01/2018\",\r\n\t\"end_date\":\"01/01/2020\",\r\n\t\"criteria\":\r\n\t{\r\n\t\t\"first_name\":\"\",\r\n\t\t\"last_name\":\"\",\r\n\t\t\"address\":\"\",\r\n\t\t\"city\":\"\",\r\n\t\t\"state\":\"\",\r\n\t\t\"zip\":\"\",\r\n\t\t\"country\":\"US\",\r\n\t\t\"phone\":\"\",\r\n\t\t\"email\":\"\",\r\n\t\t\"is_member\":\"\"\r\n\t},\r\n\t\"start_time\":\"\",\r\n\t\"end_time\":\"\",\r\n\t\"search_type\":\"\",\r\n\t\"return_type\":\"customer_view\"\r\n}"},"url":"https://{{app_key}}.{{domain}}{{api_ext}}customer_find"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"response_code\": \"100\",\n \"total_customers\": \"2\",\n \"customer_ids\": [\n \"6\",\n \"272\"\n ],\n \"data\": {\n \"6\": {\n \"response_code\": \"100\",\n \"first_name\": \"Pablo\",\n \"last_name\": \"Escobar\",\n \"email\": \"pablo@example.com\",\n \"phone\": \"5554443434\",\n \"date_created\": \"2018-05-15 10:39:40\",\n \"order_count\": \"13\",\n \"order_list\": [\n \"10120\",\n \"10121\",\n \"10122\",\n \"10123\",\n \"10124\",\n \"10133\",\n \"10134\",\n \"10135\",\n \"10136\",\n \"10137\",\n \"10139\",\n \"11282\",\n \"11283\"\n ]\n },\n \"272\": {\n \"response_code\": \"100\",\n \"first_name\": \"Postman\",\n \"last_name\": \"API\",\n \"email\": \"postman@apitest.com\",\n \"phone\": \"5554443434\",\n \"date_created\": \"2018-07-02 10:18:56\",\n \"order_count\": \"3\",\n \"order_list\": [\n \"11284\",\n \"11285\",\n \"11286\"\n ]\n }\n }\n}"}],"_postman_id":"a95dc552-8b90-42e1-afc0-8e2a5870b3cc"},{"name":"customer_find_active_product","id":"7f908899-150e-41f8-83ed-da823281de01","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_username}}"},{"key":"password","value":"{{api_password}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n\t\"customer_id\":272,\r\n\t\"campaign_id\":\"\"\r\n}"},"url":"https://{{app_key}}.{{domain}}{{api_ext}}customer_find_active_product","description":"The customer_find_active_product request parameters are the customer_id and also accepts an optional parameter: campaign_id. campaign_id is used if you need to narrow the valid products returned down to the campaign level. If this is not specified, all valid products are returned for that customer_id, regardless of the campaign. The response will return a list of all valid product_id in sticky.io for the given parameters received in the request.
Max Requests Per Minute: 120
\n","urlObject":{"protocol":"https","host":["{{app_key}}","{{domain}}{{api_ext}}customer_find_active_product"],"query":[],"variable":[]}},"response":[{"id":"958011b2-d0f4-4a95-a769-b9d685540fc2","name":"customer_find_active_product","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n\t\"customer_id\":272,\r\n\t\"campaign_id\":\"\"\r\n}"},"url":"https://{{app_key}}.{{domain}}{{api_ext}}customer_find_active_product"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"product_id\": [\n \"16\",\n \"4\"\n ],\n \"response_code\": \"100\"\n}"}],"_postman_id":"7f908899-150e-41f8-83ed-da823281de01"},{"name":"customer_view","id":"461ce45f-ea63-473f-bedb-0744cd426057","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_username}}"},{"key":"password","value":"{{api_password}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"customer_id\":369\n}"},"url":"https://{{app_key}}.{{domain}}{{api_ext}}customer_view","description":"The customer_view method is used view data about a customer in the sticky.io platform.
Max Requests Per Minute: 120
\n","urlObject":{"protocol":"https","host":["{{app_key}}","{{domain}}{{api_ext}}customer_view"],"query":[],"variable":[]}},"response":[{"id":"fbc3b06a-1033-4f91-98ca-de86c84289a6","name":"customer_view","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","disabled":false}],"body":{"mode":"raw","raw":"{\n\t\"customer_id\":369\n}"},"url":"https://{{app_key}}.{{domain}}{{api_ext}}customer_view"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Connection","value":"keep-alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Length","value":"547","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Tue, 11 Sep 2018 12:51:35 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Apache/2.4.34 (Amazon)","name":"Server","description":"A name for the server"},{"key":"Vary","value":"Authorization","name":"Vary","description":"Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."}],"cookie":[],"responseTime":null,"body":"{\"response_code\":\"100\",\"first_name\":\"First\",\"last_name\":\"Test\",\"email\":\"noemail@email.com\",\"phone\":\"8135551212\",\"date_created\":\"2018-08-02 07:17:02\",\"order_count\":\"45\",\"order_list\":[\"11871\",\"11872\",\"11873\",\"11874\",\"11875\",\"11876\",\"11877\",\"11878\",\"11879\",\"11880\",\"11881\",\"11887\",\"11888\",\"11889\",\"11890\",\"11892\",\"11893\",\"11896\",\"11897\",\"11898\",\"11901\",\"11902\",\"11903\",\"11904\",\"11905\",\"11906\",\"11907\",\"11908\",\"11951\",\"11952\",\"11953\",\"11954\",\"11955\",\"11956\",\"11957\",\"11958\",\"11959\",\"11960\",\"11961\",\"11962\",\"11963\",\"11964\",\"11965\",\"11966\",\"11980\"]}"}],"_postman_id":"461ce45f-ea63-473f-bedb-0744cd426057"}],"id":"fc281078-0853-4fba-b19a-cc3a08010383","description":"In this section you will find information related to Customers. Some of that information can be used in Orders as well as Members
\n","event":[{"listen":"prerequest","script":{"id":"1cdf912b-02c6-401b-a609-5cbe0f8f1048","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a3760a60-0bc9-4e22-b985-35c1140ae50a","type":"text/javascript","exec":[""]}}],"_postman_id":"fc281078-0853-4fba-b19a-cc3a08010383","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_username}}"},{"key":"password","value":"{{api_password}}"}]},"isInherited":true,"source":{"_postman_id":"9750fd0a-0874-4138-b29f-3d620fdb9e7c","id":"9750fd0a-0874-4138-b29f-3d620fdb9e7c","name":"sticky.io JSON API & Integration v2025.7.31","type":"collection"}}},{"name":"Members","item":[{"name":"member_check_session","id":"98c77b15-85cd-4209-a784-f76b5f45ff45","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_username}}"},{"key":"password","value":"{{api_password}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"token\":\"0d899a77-4f84-4349-96a9-90d81fccbec7\"\n}"},"url":"https://{{app_key}}.{{domain}}{{api_ext}}member_check_session","description":"Check that a member session is still active.
\nMax Requests Per Minute: 120
\n","urlObject":{"protocol":"https","host":["{{app_key}}","{{domain}}{{api_ext}}member_check_session"],"query":[],"variable":[]}},"response":[{"id":"94158287-9a9f-4a10-bc6f-c350e04b0b25","name":"member_check_session","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"token\":\"0d899a77-4f84-4349-96a9-90d81fccbec7\"\n}"},"url":"https://{{app_key}}.{{domain}}{{api_ext}}member_check_session"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"response_code\": 100\n}"}],"_postman_id":"98c77b15-85cd-4209-a784-f76b5f45ff45"},{"name":"member_create","id":"784f0766-73f0-418a-8007-0a93600dd5b6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_username}}"},{"key":"password","value":"{{api_password}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"customer_id\":272,\n\t\"email\":\"example@member.com\",\n\t\"event_id\":1\n}"},"url":"https://{{app_key}}.{{domain}}{{api_ext}}member_create","description":"This method is used to create a new member.
\nMax Requests Per Minute: 120
\nThis method is used to delete a member.
\nMax Requests Per Minute: 120
\n","urlObject":{"protocol":"https","host":["{{app_key}}","{{domain}}{{api_ext}}member_delete"],"query":[],"variable":[]}},"response":[{"id":"58853613-79ce-4853-bd46-ec1ed2086e42","name":"member_delete","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"email\":\"example@member.com\"\n}"},"url":"https://{{app_key}}.{{domain}}{{api_ext}}member_delete"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"response_code\": 100,\n \"message\": \"Successfully deleted member\"\n}"}],"_postman_id":"8087bbcb-5e66-457c-8296-a0d4ab3c1729"},{"name":"member_event_index","id":"371909e0-0211-4031-b229-3784ac6675f2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_username}}"},{"key":"password","value":"{{api_password}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://{{app_key}}.{{domain}}{{api_ext}}member_event_index","description":"This method is used to retrieve the event_id for events that are attached to membership events. The response will be limited to the 500 most recent events.
Max Requests Per Minute: 60
\n","urlObject":{"protocol":"https","host":["{{app_key}}","{{domain}}{{api_ext}}member_event_index"],"query":[],"variable":[]}},"response":[{"id":"73f68ee4-15df-4d87-96b8-5de94ad44dd6","name":"member_event_index","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://{{app_key}}.{{domain}}{{api_ext}}member_event_index"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"response_code\": 100,\n \"data\": [\n {\n \"event_id\": \"247\",\n \"event_type\": \"Member Forgot Password\",\n \"event_type_id\": \"17\",\n \"name\": \"Forgot Password\",\n \"description\": \"This event is for forgot password\"\n },\n {\n \"event_id\": \"245\",\n \"event_type\": \"Member Creation\",\n \"event_type_id\": \"15\",\n \"name\": \"Member Creation Event\",\n \"description\": \"This is a member create event type\"\n }\n ]\n}"}],"_postman_id":"371909e0-0211-4031-b229-3784ac6675f2"},{"name":"member_forgot_password","id":"cee7f7ce-7132-4f3c-affe-7d0097a45056","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_username}}"},{"key":"password","value":"{{api_password}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"email\":\"example@member.com\",\n\t\"event_id\":2\n}"},"url":"https://{{app_key}}.{{domain}}{{api_ext}}member_forgot_password","description":"This method is used to generate a temporary password for a member that has forgotten their password. The response is an object of the member with their temporary password information. All timestamps are UTC.
\nMax Requests Per Minute: 120
\nThis method is used to log in a member. The response is a JSON encoded object. Timestamps are UTC.
\nMax Requests Per Minute: 120
\n","urlObject":{"protocol":"https","host":["{{app_key}}","{{domain}}{{api_ext}}member_login"],"query":[],"variable":[]}},"response":[{"id":"b5bb60f8-9c64-4a5f-aafa-255305b426aa","name":"member_login","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"email\":\"example@member.com\",\n\t\"member_password\":\"n3wPassVV0rD\"\n}"},"url":"https://{{app_key}}.{{domain}}{{api_ext}}member_login"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"response_code\": 100,\n \"data\": {\n \"customer_id\": 1102,\n \"email\": \"member@email.com\",\n \"created_at\": \"2018-02-27 14:56:08\",\n \"updated_at\": \"2018-02-27 15:50:22\",\n \"last_login_at\": \"2018-02-27 15:50:21\",\n \"login_count\": 1,\n \"member_token\": \"d94780ef-d08b-4f8b-a57c-777c30c4f821\",\n \"token_expires_at\": \"2018-02-27 16:20:22\",\n \"customer_ids\": [\n 1102\n ]\n }\n}"}],"_postman_id":"841d714f-1f53-401e-b2c6-fdf9cd434644"},{"name":"member_logout","id":"c3615c79-7621-44e6-864b-d1b4a24837cc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_username}}"},{"key":"password","value":"{{api_password}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"token\":\"b9f0a301-bc0f-46d8-b376-854c6fbdd3c9\"\n}"},"url":"https://{{app_key}}.{{domain}}{{api_ext}}member_logout","description":"This method is used to log out a member. The response code of 100 confirms the member is logged out.
\nMax Requests Per Minute: 120
\n","urlObject":{"protocol":"https","host":["{{app_key}}","{{domain}}{{api_ext}}member_logout"],"query":[],"variable":[]}},"response":[{"id":"f86ad973-445d-4b89-a8a9-7bb943dd0731","name":"member_logout","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"token\":\"b9f0a301-bc0f-46d8-b376-854c6fbdd3c9\"\n}"},"url":"https://{{app_key}}.{{domain}}{{api_ext}}member_logout"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"response_code\": 100\n}"}],"_postman_id":"c3615c79-7621-44e6-864b-d1b4a24837cc"},{"name":"member_reset_password","id":"b609eba8-d1db-4e79-8f45-b75cf78fe284","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_username}}"},{"key":"password","value":"{{api_password}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"email\":\"example@member.com\",\n\t\"member_temp_password\":\"KofYWt6mM8lhpOR7fiPj\",\n\t\"member_new_password\":\"n3wPassVV0rD\"\n}"},"url":"https://{{app_key}}.{{domain}}{{api_ext}}member_reset_password","description":"Reset a member password after a member_forgot_password has been sent. Timestamps are UTC.
Max Requests Per Minute: 120
\n","urlObject":{"protocol":"https","host":["{{app_key}}","{{domain}}{{api_ext}}member_reset_password"],"query":[],"variable":[]}},"response":[{"id":"9349449d-4a48-4051-8f82-3052756c3489","name":"member_reset_password","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"email\":\"example@member.com\",\n\t\"member_temp_password\":\"KofYWt6mM8lhpOR7fiPj\",\n\t\"member_new_password\":\"n3wPassVV0rD\"\n}"},"url":"https://{{app_key}}.{{domain}}{{api_ext}}member_reset_password"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"response_code\": 100,\n \"data\": {\n \"customer_id\": 123,\n \"email\": \"example@member.com\",\n \"created_at\": \"2018-02-08 21:12:04\",\n \"updated_at\": \"2018-02-27 16:38:32\",\n \"last_login_at\": \"2018-02-13 18:05:21\",\n \"login_count\": 6,\n \"member_token\": \"\",\n \"token_expires_at\": \"\",\n \"customer_ids\": [\n 123\n ]\n }\n}"}],"_postman_id":"b609eba8-d1db-4e79-8f45-b75cf78fe284"},{"name":"member_update","id":"158981a1-d35a-47ff-8114-435140438e5b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_username}}"},{"key":"password","value":"{{api_password}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"email\":\"example@member.com\",\n\t\"current_member_password\":\"Zse6B6Gtqi2imJLpVcd1\",\n\t\"new_member_password\":\"n3wPassVV0rD\"\n}"},"url":"https://{{app_key}}.{{domain}}{{api_ext}}member_update","description":"This method is used to update an existing known password OR the initial temporary password for a member.
\nIf a member has forgotten their password, please see member_forgot_password and member_reset_password.
Max Requests Per Minute: 120
\n","urlObject":{"protocol":"https","host":["{{app_key}}","{{domain}}{{api_ext}}member_update"],"query":[],"variable":[]}},"response":[{"id":"3ed8ed28-7047-4456-a193-08d95598ef2b","name":"member_update","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"email\":\"example@member.com\",\n\t\"current_member_password\":\"Zse6B6Gtqi2imJLpVcd1\",\n\t\"new_member_password\":\"n3wPassVV0rD\"\n}"},"url":"https://{{app_key}}.{{domain}}{{api_ext}}member_update"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"response_code\": 100,\n \"message\": \"Successfully updated password\"\n}"}],"_postman_id":"158981a1-d35a-47ff-8114-435140438e5b"},{"name":"member_view","id":"225c3227-4932-4ea2-aaa3-4b20b26d8f06","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_username}}"},{"key":"password","value":"{{api_password}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"email\":\"example@member.com\"\n}"},"url":"https://{{app_key}}.{{domain}}{{api_ext}}member_view","description":"This method is used to view information about a member. Timestamps are UTC.
\nMax Requests Per Minute: 120
\n","urlObject":{"protocol":"https","host":["{{app_key}}","{{domain}}{{api_ext}}member_view"],"query":[],"variable":[]}},"response":[{"id":"7fcfb2ed-234c-479e-a926-758f1d737c74","name":"member_view","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"email\":\"example@member.com\"\n}"},"url":"https://{{app_key}}.{{domain}}{{api_ext}}member_view"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"response_code\": 100,\n \"data\": {\n \"customer_id\": 123,\n \"email\": \"member@email.com\",\n \"created_at\": \"2018-02-08 21:12:04\",\n \"updated_at\": \"2018-02-13 18:10:09\",\n \"last_login_at\": \"2018-02-13 18:05:21\",\n \"login_count\": 6,\n \"member_token\": \"f07a64b7-a736-4cce-87d8-68a585e861c9\",\n \"token_expires_at\": \"2018-02-13 18:35:22\",\n \"customer_ids\": [\n 123\n ]\n }\n}"}],"_postman_id":"225c3227-4932-4ea2-aaa3-4b20b26d8f06"}],"id":"ab661543-193b-4c6f-8809-d475aa4cda8e","description":"The Member section allows access to our Member service.\nIt is a method for you to build out a member site with us being the engine behind it.\nThis includes the login controller as well as tying together all of the orders, customer info, etc.
\nPlease note - All Timestamps in response from the Member API are UTC
\n","event":[{"listen":"prerequest","script":{"id":"50c4b6e4-cce3-4c33-be67-10fe82a95925","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"c22c0458-71d5-4a16-a2ce-7670d66817e1","type":"text/javascript","exec":[""]}}],"_postman_id":"ab661543-193b-4c6f-8809-d475aa4cda8e","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_username}}"},{"key":"password","value":"{{api_password}}"}]},"isInherited":true,"source":{"_postman_id":"9750fd0a-0874-4138-b29f-3d620fdb9e7c","id":"9750fd0a-0874-4138-b29f-3d620fdb9e7c","name":"sticky.io JSON API & Integration v2025.7.31","type":"collection"}}},{"name":"Code Definitions","item":[],"id":"96aa8a8f-c267-42e2-9d71-739fcc9ec7b7","description":"100 - Success
\n200 - Invalid login credentials
\n300 - Update failed due to third party rejection
\n301 - Error updating affiliate data
\n320 - Invalid Product Id
\n321 - Existing Product Category Id Not Found
\n322 - Invalid Category Id
\n323 - Digital Delivery and Digital URL must be paired together and digital URL must be a valid URL
\n325 - Length Does Not Meet Minimum
\n326 - URL is invalid
\n327 - Payment Type Invalid
\n328 - Expiration Date Invalid (Must be in the format of MMYY with no special characters)
\n329 - Credit card must be either 15 or 16 digits numeric only
\n330 - No Status Passed
\n331 - Invalid Criteria
\n332 - Start and end date are required
\n333 - No Orders Found
\n334 - Invalid Start Date format
\n335 - Invalid End Date format
\n336 - Wild Card Unsupported for this search criteria
\n337 - Last 4 or First 4 must be 4 characters exactly
\n338 - Timestamp invalid
\n339 - Total Amount must be numeric and non-negative
\n340 - Invalid country code
\n341 - Invalid state code
\n342 - Invalid Email Address
\n343 - Data Element Has Same Value As Value Passed No Update done (Information ONLY, but still a success)
\n344 - Invalid Number Format
\n345 - Must be a 1 or 0. \"1\" being \"On\" or true. \"0\" being \"Off\" or false.
\n346 - Invalid date format. Use mm/dd/yyyy
\n347 - Invalid RMA reason
\n348 - Order is already flagged as RMA
\n349 - Order is not flagged as RMA
\n350 - Invalid order Id supplied
\n351 - Invalid status or action supplied
\n352 - Uneven Order/Status/Action Pairing
\n353 - Cannot stop recurring
\n354 - Cannot reset recurring
\n355 - Cannot start recurring
\n356 - Credit card has expired
\n357 - Exceeded number of batch orders to view
\n358 - Invalid Email Address. The Email Address is already being used by a customer
\n359 - Cannot update recurring details of a prepaid order
\n360 - Cannot stop upsell recurring
\n370 - Invalid amount supplied
\n371 - Invalid keep recurring flag supplied
\n372 - Refund amount exceeds current order total
\n373 - Cannot void a fully refunded order
\n374 - Cannot reprocess non-declined orders
\n375 - Cannot blacklist test payment method
\n376 - Invalid tracking number
\n377 - Cannot ship pending orders
\n378 - Order already shipped
\n379 - Order is fully refunded/voided
\n380 - Order is not valid for force bill
\n381 - Customer is blacklisted
\n382 - Invalid US state
\n383 - All military states must have a city of either \"APO\", \"FPO\". or \"DPO\"
\n384 - Invalid date mode
\n385 - Invalid billing cycle filter
\n386 - Order has already been returned
\n387 - Invalid return reason
\n388 - Rebill discount exceeds maximum for product
\n389 - Refund amount must be greater than 0
\n390 - Invalid number of days supplied
\n391 - wrong value for payment type or sequence of params is wrong.
\n400 - Invalid campaign Id supplied
\n401 - Invalid subscription type
\n402 - Subscription type 3 requires subscription week and subscription day values
\n403 - Invalid subscription week value
\n404 - Invalid subscription day value
\n405 - Subscription type 3 required for subscription week and subscription day values
\n406 - Rebill days must be a value between 1 and 31 for subscription type 2
\n407 - Rebill days must be greater than 0 if subscription type is 1 or 2
\n408 - Rebill days is invalid unless type is 1 or 2
\n409 - Subscription type 0, other subscription fields invalid
\n410 - API user: (api_username) has reached the limit of requests per minute: (limit) for method: (method_name)
411 - Invalid subscription field
\n412 - Missing subscription field
\n413 - Product is not subscription based
\n415 - Invalid subscription value
\n420 - Campaign does not have fulfillment provider attached
\n421 - This order was placed on hold
\n422 - This order has not been sent to fulfillment yet
\n423 - Invalid SKU
\n424 - Fulfillment Error, provider did not specify
\n425 - This order has been sent to fulfillment but has not been shipped
\n426 - This order not eligible for offline payment approval (incorrect status & payment type)
\n430 - Coupon Error: Invalid Promo Code
\n431 - Coupon Error: This promo code has expired
\n432 - Coupon Error: Product does not meet minimum purchase amount
\n433 - Coupon Error: Maximum use count has exceeded
\n434 - Coupon Error: Customer use count has exceeded its limit
\n435 - Invalid attribute found on product
\n436 - Invalid option found on attribute
\n437 - Invalid attribute combination; no variants matched for product
\n438 - Invalid attribute(s). Product does not have variants
\n439 - Product has variants; product attributes must be provided.
\n440 - Invalid offer Id supplied
\n441 - Duplicate tracking number
\n442 - Order already has a tracking number.
\n500 - Invalid customer Id supplied
\n550 - Required field [] invalid or missing
\n551 - Invalid subscription values supplied
\n552 - Current products max quantity cannot be greater than next recurring products quantity next recurring + products max quantiy
\n553 - Current Products Max Quantity cannot be lowered since other products are using this product as + recurring with Preserved Quantity on
\n554 - A product without variants may not recur to a product with variants
\n555 - Failed to create product record
\n556 - Failed to store product description
\n557 - Failed to update product recurring date
\n558 - Failed to create product event configuration
\n559 - Failed to store product category
\n560 - Product ID not found
\n561 - Error deleting product
\n562 - This product can not be deleted because one or more orders are related to it
\n563 - This product can not be deleted because it is subscribed to one or more products
\n564 - This product can not be deleted because it is currently related to one or more campaigns
\n565 - Events supplied without event types
\n566 - Event types supplied without events
\n567 - Number of events must match number of event types
\n568 - Invalid event type [] supplied
\n569 - Invalid event [] supplied
\n570 - Invalid flag supplied: []
\n571 - Next recurring product not supplied
\n572 - Subscription type not supplied
\n573 - Subscription type invalid
\n574 - Subscription type [] require field(s) []
\n575 - Shippable flag is required when passing shipping fields
\n576 - Field [] is required when passing []
\n577 - Category ID is invalid
\n588 - Credit card update failed through payment gateway
\n600 - Invalid product Id supplied
\n601 - Invalid prospect Id supplied
\n602 - No prospects found
\n603 - Invalid customer Id supplied
\n604 - No customers found
\n666 - User does not have permission to use this method
\n667 - This user account is currently disabled
\n668 - ip address is invalid
\n669 - Unauthorized to access campaign
\n670 - This value added service is not enabled. Please contact client success.
\n700 - Invalid method supplied
\n701 - Action not permitted by gateway
\n702 - Invalid gateway Id
\n703 - No gateways supplied
\n704 - Invalid gateways supplied
\n705 - Gateway does not exist
\n706 - Invalid payment router Id
\n707 - No payment routers supplied
\n708 - Invalid payment routers supplied
\n709 - Payment router does not exist
\n800 - Transaction was declined
\n801 - Order not eligible for resprocessing
\n901 - Invalid return URL
\n902 - Invalid cancel URL
\n903 - Error retrieving alternative provider data
\n904 - Campaign does not support an alternative payment provider
\n905 - Product quantity/dynamic price does not match
\n906 - Invalid quantity
\n907 - Invalid shipping Id
\n908 - Payment was already approved
\n909 - No match found
\n910 - Invalid length
\n911 - Update failed
\n912 - Product is not a bundle
\n913 - Product is not in parent bundle product
\n914 - Total child items exceeds max item for bundle
\n1000 - SSL is required
\n1001 - General Error
\n1003 - The number of elements in actions and values must be the same
\n1004 - Invalid date format, it should be MM/DD/YYYY
\n1005 - Invalid includes format, it should be an array
\n1020 - Error saving next recurring product
\n4001 - Email not found for member
\n4002 - A member already exists for this customer
\n4003 - Member not found
\n4005 - No member token supplied
\n4006 - Member token expired
\n4007 - Invalid member token
\n4008 - Invalid member credentials or temp password
\n4009 - Member update failed. Password supplied is invalid
\n4010 - Member login attempt with temp password. Password must be updated
\n4011 - Max member failed login attempts exceeded. Password reset is required
\n4012 - Member temp password expired
\n4013 - No member password reset pending for supplied member
\n10201 - three_d_redirect_url is required
10202 - alt_pay_return_url is required
10203 - Phone token and PIN are required for SEPA transactions in Alternative Payments provider
\n10400 - Invalid campaign Id
\n10301 - Error updating affiliate data
\n10303 - Invalid upsell product Id
\n10304 - Invalid first name
\n10305 - Invalid last name
\n10306 - Invalid shipping address1
\n10307 - Invalid shipping city
\n10308 - Invalid shipping state
\n10309 - Invalid shipping zip
\n10310 - Invalid shipping country
\n10311 - Invalid billing address1
\n10312 - Invalid billing city
\n10313 - Invalid billing state
\n10314 - Invalid billing zip
\n10315 - Invalid billing country
\n10316 - Invalid phone number
\n10317 - Invalid email address
\n10318 - Invalid payment type
\n10319 - Invalid credit card number
\n10320 - Invalid expiration date
\n10321 - Invalid IP address
\n10322 - Invalid shipping Id
\n10323 - CVV is required for tranType 'Sale'
\n10324 - Supplied CVV has an invalid length
\n10325 - Shipping state must be 2 characters and valid US state
\n10326 - Billing state must be 2 characters and valid US state
\n10327 - Invalid payment type
\n10328 - Expiration month must be between 01 and 12
\n10329 - Expiration date must be 4 digits long
\n10333 - Order has been black listed
\n10334 - The credit card number or email address has already purchased this product(s)
\n10335 - Invalid Dynamic Price Format
\n10336 - checkRoutingNumber must be passed when payment type is checking or eft_germany
10337 - checkAccountNumber must be passed when payment type is checking or eft_germany
10339 - tranType missing or invalid
\n10340 - Invalid employee username found
\n10341 - Campaign Id restricted to user
\n10342 - The credit card has expired
\n10343 - Invalid master_order_id
10411 - Invalid subscription field
\n10412 - Missing subscription field
\n10413 - Product is not subscription based
\n10414 - The product that is being purchased has a different subscription type than the next recurring product.
\n10415 - Invalid subscription value
\n10500 - An error occurred while saving the temporary customer
\n10501 - Invalid temp_customer_id found
10502 - temp_customer_id has expired
10550 - Capture transactions require a valid transactionId or temp_customer_id
10600 - Invalid product Id
\n10601 - Invalid attribute found on product
\n10602 - Invalid option found on product
\n10603 - Invalid attribute combination; no variants matched for product
\n10604 - Invalid attribute(s). Product does not have variants.
\n10605 - Product has variants; product attributes must be provided
\n10666 - User does not have permission to use this method
\n10705 - Order is not 3DS related
\n10800 - Transaction was declined
\n10901 - Paypal payer Id is required for this payment type.
\n10902 - Paypal token is required for this payment type.
\n10903 - Alt Pay token is required for this payment type.
\n10912 - Product is not a bundle
\n10913 - Product is not in parent bundle product
\n10914 - Total child items exceeds max item for bundle
\n11000 - Could not add record
\n11001 - General Error
\n11002 - The consent_required field is invalid. Must be 0 or 1 if passed.
\n11003 - The frontend_vendor field has exceeded max length. Please reduce size.
\n11004 - The is_cascaded field is invalid. Must be 0 or 1 if passed.
\n11006 - The campaign does not have the alternative provider assigned.
\n11018 - Error loading data from ID
\n11019 - Parameters are required to use
\n11020 - Error performing save operation
\n11021 - Error performing toggle operation
\n11022 - Error performing copy operation
\n11023 - Error performing destroy operation
\n11024 - Error performing archive operation
\n11025 - Error performing restore operation
\n11026 - Record is locked. Cannot perform operation
\n11028 - Cannot perform operation. Record is linked to a campaign configuration
\n11029 - Cannot perform operation. Record is linked to an order
\n11030 - Error performing update. The next recurring product must be an eDigital product
\n11031 - Invalid variant ID or Invalid variant attributes
\n16008 - The error returned is a generic failure code. Please use the message in the response for further definition.
\n1 - Refused / RTS
\n2 - Undeliverable
\n3 - Customer Returned
\n4 - Other
\n0 - Remove RMA reason
\n1 - Cannot Afford Product
\n2 - Selected Wrong Product
\n3 - Unauthorized Charge
\n4 - Not Statisfied
\n5 - Product Doesnt Work
\n6 - Received Product Twice
\n7 - Received Wrong Product
\n8 - Not Approved By Physican
\n9 - Product Damaged
\n10 - Non Deliverable Address
\n11 - Refused
\n12 - Forwarded Address
\n13 - Did Not Order
\n14 - Not interested in continuity
\n15 - Issue Check Refund
\n16 - Too Time Consuming
\n17 - No Confirmation Email
\n18 - Too Complicated
\n19 - No Tech Support
\n20 - No Return Emails
\n21 - Too Many Hidden Fees
\n22 - Other
\nsticky.io API allows for flexible use of our services. Please note that ALL routes are POST and require Basic Authentication.
\nYour API Username and Password can be created and managed in your CRM under Settings -> API Accounts. Ensure that the API User that you are using has the appropriate permissions for the API requests it will be using.
\nNew to Postman? Checkout out their docs Here
\n","event":[{"listen":"prerequest","script":{"id":"bba9fe3e-1da0-4f07-9268-17a11497ee23","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"7382cf0b-2ea9-48ab-af65-7d5b09db3829","type":"text/javascript","exec":[""]}}],"_postman_id":"9d179462-5066-4156-9137-8eb19a4aa77b","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_username}}"},{"key":"password","value":"{{api_password}}"}]},"isInherited":true,"source":{"_postman_id":"9750fd0a-0874-4138-b29f-3d620fdb9e7c","id":"9750fd0a-0874-4138-b29f-3d620fdb9e7c","name":"sticky.io JSON API & Integration v2025.7.31","type":"collection"}}},{"name":"Integrations","item":[{"name":"PayPal Guide","item":[],"id":"2773793f-d79b-4068-86aa-aa02f078c3a6","description":"PayPal is a payment type that we support with the following payment provider accounts:
\nPayPal Payments is the seamless option for using the paypal payment type. It requires less parameters to be sent in the NewOrder API requests.
To submit a valid new_order request with payment type paypal on a campaign that is configured with PayPal Payments, the only required parameters are as follows:
alt_pay_return_url parameter is required and should be an endpoint that points to a final page in the checkout process.To configure the Braintree with PayPal implementation within a campaign, select the \"paypal\" payment type on the Campaigns configuration page and then select a Braintree payment provider profile.
Using this implementation allows the system to support subscriptions with paypal as the payment type.
The current implementation of PayPal Express is being deprecated by PayPal. We advise updating PayPal camapigns to use PayPal Payments going forward. PayPal Express is still supported until
full deprecation of the PayPal Express API within PayPal's API itself. PayPal Express does NOT support subscriptions.
To implement PayPal express:
\nget_alternative_provider method.get_alternative_provider method where a NewOrder API request can beThis guide assumes that you have been onboarded to our Gratify service and it has been enabled in your sticky.io platform instance.
\nA Logo, Terms of Service page, Return Policy page, and Contact Us page URL should have been provided to sticky.io as part of your\nGratify onboarding process.
\nGratify mobile checkout requires a payment gateway that supports separated auth/capture functionality. Current gateway integrations\non the sticky.io platform that support this are:
\nCreate a dedicated landing page/storefront where you want Gratify to appear on. This is hosted by you, similar to any cart, landing page, or funnel you traditionally develop.\nThis could be in Wordpress, your custom code, or any front end solution you may already use. We have an example \"Gratify enabled\" demo site you can try out here (and look at the code source):
\n\nYou can use the test credit card number 4242424242424242 with any expiration date and CVV. Use your actual mobile phone number if you want to see the entire checkout flow.
Gratify allows you to sell a mandatory \"main product\", and optional \"upsell products\" (cross-sells after the main product is purchased).\nThere is also the ability to sell an additional upsell product during the presentation of the main product.
\nThe Gratify widget is activated on your site by including a short javscript script to activate the mobile checkout experience\nwith the product configuration you specify. Below are the required and optional parameters available:
\nUpsell products can have two different forms:
\nAdd one of the initialization code snippets below to your HTML page, and replace the your_xxxxxx values with the\ninformation from your sticky.io platform instance.
\nIf you want to sell only one product, use this:
\n![https://cdn.sticky.io/images/desk-email-logo.png](\"https://cdn.sticky.io/images/desk-email-logo.png\"){kind=link}
<script src=\"https://cdn.getgratify.com/merchant_files/lime_light_quick_checkout/v2/main.js\"></script>\n<script type=\"text/javascript\">\n _gr.init({\n merchantId: 'your_sticky_io_full_subdomain',\n mainProduct: {\n id: your_main_product_LL_id,\n campaignId: your_main_product_LL_campaign_id,\n imageUrl: 'your_main_product_image_url',\n crossedOutPrice: 'your_crossed_out_price'\n },\n brandColor: '#7592EF'\n });\n</script>\nIf you also want to sell one or two normal upsell products, use this (example with 2 upsell products):
\n<script src=\"https://cdn.getgratify.com/merchant_files/lime_light_quick_checkout/v2/main.js\"></script>\n<script type=\"text/javascript\">\n _gr.init({\n merchantId: 'your_sticky_io_full_subdomain',\n mainProduct: {\n id: your_main_product_LL_id,\n campaignId: your_main_product_LL_campaign_id,\n imageUrl: 'your_main_product_image_url',\n crossedOutPrice: 'your_crossed_out_price'\n },\n upsellProducts: [\n { id: your_upsell_LL_id_1, campaignId: your_upsell_LL_campaign_id_1, imageUrl: 'your_upsell_image_url_1' },\n { id: your_upsell_LL_id_2, campaignId: your_upsell_LL_campaign_id_2, imageUrl: 'your_upsell_image_url_2' }\n ],\n brandColor: '#7592EF'\n });\n</script>\nIf you want to sell an upsell product attached to the main product, use this:
\n<script src=\"https://cdn.getgratify.com/merchant_files/lime_light_quick_checkout/v2/main.js\"></script>\n<script type=\"text/javascript\">\n _gr.init({\n merchantId: 'your_sticky_io_full_subdomain',\n mainProduct: {\n id: your_main_product_LL_id,\n campaignId: your_main_product_LL_campaign_id,\n imageUrl: 'your_main_product_image_url',\n crossedOutPrice: 'your_crossed_out_price',\n upsellProduct: {\n id: your_upsell_LL_id,\n campaignId: your_upsell_LL_campaign_id,\n description: 'your_description_text'\n }\n },\n brandColor: '#7592EF'\n });\n</script>\nFor any button where you want the Gratify pop-up to open, you need to intercept its \"click\" event to open the\nGratify pop-up with _gr.openPurchase(). For example, if your button has a cta-button HTML class, and if you are using jQuery,\nyou could use something like the following javascript code:
$('.cta-button').on('click', function(e) {\n e.preventDefault();\n _gr.openPurchase();\n});\nHere is how your HTML code could look like when everything is put together.
\n<!DOCTYPE html>\n<html>\n<head>\n <script src=\"https://ajax.googleapis.com/ajax/libs/jquery/3.2.1/jquery.min.js\"></script>\n</head>\n\n<body>\n ... your usual code ...\n <button class='cta-button'>Test Buy Now</button>\n\n <!-- BEGIN Gratify code -->\n <script src=\"https://cdn.getgratify.com/merchant_files/lime_light_quick_checkout/v2/main.js\"></script>\n\n <script type=\"text/javascript\">\n _gr.init({\n merchantId: 'demo.sticky.io',\n mainProduct: {\n id: 714,\n campaignId: 446,\n imageUrl: 'https://cdn.sticky.io/images/desk-email-logo.png',\n crossedOutPrice: '89.99',\n upsellProduct: {\n id: 530,\n campaignId: 375,\n description: '<p>Buyers protection ensures that the customer will get their product even if it is lost in shipping, damaged, or other issues that may arise while the product is in transit.</p> <p>Buyers protection purchasers are charged a one-time fee of $1.95 USD to the debit or credit card provided by the consumer at the time of purchase.</p>'\n }\n },\n upsellProducts: [\n { id: 708, campaignId: 479, imageUrl: 'https://cdn.sticky.io/images/desk-email-logo.png' },\n { id: 722, campaignId: 480, imageUrl: 'https://cdn.sticky.io/images/desk-email-logo.png' }\n ],\n brandColor: '#7592EF'\n });\n\n $('.cta-button').on('click', function(e) {\n e.preventDefault();\n _gr.openPurchase();\n });\n </script>\n <!-- END Gratify code -->\n\n</body>\n\n</html>\nOur 3D Verify feature allows you to perform a 3D protected transaction, without having to redirect the customer to their bank to enter in personal information. This will shift chargeback risk away from you and onto the issuing bank without adding friction to the checkout process.
\nIf you would like to use the 3D Verify feature with your gateway, you will need to contact clientsuccess@sticky.io to sign up. From there, we will enable this feature for you in your CRM.
\nNOTE: There are now two(2) 3D Verify implementations, 1.x.x and 2.x.x. There are subversions of each as well, depending on the payment provider being used as the gateway. Please confer with your payment provider before deciding which implementation to use on new checkout pages. And also, most importantly, please check with your payment provider to confirm your processor supports 3D Verify.
\nAlso, 3DS 2.1 is a hybrid version that returns both 1.0 and 2.0 based on what the issuing banks are able to authenticate.
\nOn the checkout page, create HTML form fields with the following names and data attributes:
\n^^^ (x_transaction_id) ONLY FOR 3D Verify 1.x.x\n\nPlease note that the corresponding data-threeds=\"...\" attributes will need to be added to the existing checkout form inputs. Table of 3DS attributes:
For the hidden field x_transaction_id you will need to generate a random unique ID. There is an example provided on how to do this in the javascript snippet provided below. NOTE: Transaction ID is now a default random number and no longer necessary if using 3D Verify versions 2.x.x or higher.
Before the ending HTML tag, a javascript snippet referencing the 3D Verify script will need to be included along with an instantiation of the ThreeDS object. The snippet will include the unique id generator for the transaction ID and instantiation of the tds object.
Below are two (2) example scripts, one for 3ds version 2.x.x and one for 3ds 1.x.x. and the additional option needed if protecting both the initial and the rebill.
\n var tds = new ThreeDS(\n 'HTML_FORM_ID_HERE ',\n 'INSERT_API_KEY_HERE ',\n null,\n {\n endpoint : 'INSERT_ENDPOINT_HERE ',\n verbose : true,\n //addResultToForm : false,\n resolve : function(response)\n {\n console.log('TDS RESPONSE: ', response);\n // Add values to form...\n //\n if (response.authenticationValue)\n {\n $('')\n .attr('type', 'hidden')\n .attr('name', 'cavv')\n .attr('value', response.authenticationValue)\n .appendTo('#payment_form');\n }\n if (response.cavv)\n {\n $('')\n .attr('type', 'hidden')\n .attr('name', 'cavv')\n .attr('value', response.cavv)\n .appendTo('#payment_form');\n }\n $('')\n .attr('type', 'hidden')\n .attr('name', 'eci')\n .attr('value', response.eci)\n .appendTo('#payment_form');\n $('')\n .attr('type', 'hidden')\n .attr('name', 'ds_trans_id')\n .attr('value', response.dsTransId)\n .appendTo('#payment_form');\n $('')\n .attr('type', 'hidden')\n .attr('name', 'acs_trans_id')\n .attr('value', response.acsTransId)\n .appendTo('#payment_form');\n $('')\n .attr('type', 'hidden')\n .attr('name', 'status')\n .attr('value', response.status)\n .appendTo('#payment_form');\n $('')\n .attr('type', 'hidden')\n .attr('name', '3d_version')\n .attr('value', response.protocolVersion)\n .appendTo('#payment_form');\n }\n }\n );\n\n var tds = new ThreeDS(\n \"\",\n \"\",\n \" or null\",\n {\n endpoint:\"https://sandbox-api.3dsintegrator.com/v2\",\n rebill:99.99\n });\n\nvar id = document.querySelector('[data-threeds=id]');\nvar uniqueId = function()\n{\n return 'id-' + Math.random().toString(36).substr(2, 16);\n};\nid.value = uniqueId();\nvar tds = new ThreeDS(\n 'HTML_FORM_ID_HERE ',\n 'INSERT_API_KEY_HERE ',\n null,\n {\n endpoint : 'INSERT_ENDPOINT_HERE ',\n verbose : true, // For testing purposes (Set to false in production mode)\n addResultToForm : false\n }\n);\n\nTest Cards - Version 2.x.x
\nTest Cards - Version 1.x.x
\nWhat is it?
\nThe verify method is commonly used to call the library to authenticate upon the even of something. It could be based on the click of a button or page being loaded on an upsell page.
\nSTEPS:
\n<form>\n <input type=\"hidden\" type=\"text\" name=\"x_card_num\" value=\"0000000000000000\" />\n <input type=\"hidden\" type=\"text\" name=\"x_exp_month\" value=\"00\" />\n <input type=\"text\" name=\"x_exp_year\" value=\"00\" />\n</form>\nautoSubmit:false parameter in options (where you are defining tds; the JS will now know to wait until an event happens):<script>\n var tds = new ThreeDS(\n \"<insert-form-id-here>\",\n \"<insert-your-API-Key>\",\n null,\n {\n endpoint:\"https://api-sandbox.3dsintegrator.com/v2\",\n autoSubmit:false,\n verbose:true\n });\n</script>\nverify method, which takes 3 arguments: Response, Reject, and Amount:The below example will show how you can trigger it upon the event of an amount being selected.
\n<html>\n <body>\n <div class=\"your-page-content\">\n <form id=\"billing-form\" action=\"\" method=\"post\">\n </form>\n </div>\n \n <!-- End of page -->\n <script src=\"https://cdn.3dsintegrator.com/threeds.2.min.latest.js\"></script>\n <script>\n var tds = new ThreeDS(\n \"<insert-form-id-here>\",\n \"<insert-your-API-Key>\",\n null,\n {\n endpoint:\"https://api-sandbox.3dsintegrator.com/v2\", \n verbose:true,\n autoSubmit:false;\n });\n \n var amountSelect = document.getElementById(\"amount-select\");\n amountSelect.addEventListener(\"blur\",function(){\n tds.verify(function(response){\n console.log(response)\n console.log(\"success!\")\n },function(response){\n console.log(\"failure!\")\n },{\n amount:amountSelect.value\n })\n });\n </script>\n </body>\n</html>\nNOTE:\nFor the upsell page, ideally the event would be set up upon page load to provide enough time for the authentication to finish.
\n","event":[{"listen":"prerequest","script":{"id":"94a26efc-5e0f-496e-bb53-1149b8ed7664","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"651c7dab-ee11-4c9c-a6da-2c0f448d2cad","type":"text/javascript","exec":[""]}}],"_postman_id":"d9f4347f-df6f-4648-8668-95f3feb51a70","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_username}}"},{"key":"password","value":"{{api_password}}"}]},"isInherited":true,"source":{"_postman_id":"9750fd0a-0874-4138-b29f-3d620fdb9e7c","id":"9750fd0a-0874-4138-b29f-3d620fdb9e7c","name":"sticky.io JSON API & Integration v2025.7.31","type":"collection"}}},{"name":"Amazon Pay","item":[{"name":"new_order","id":"c65938a3-e5d5-41bc-818e-f0bd567854a1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_username}}"},{"key":"password","value":"{{api_password}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"creditCardType\" : \"amazonpay\",\r\n \"tranType\" : \"sale\",\r\n \"access_token\" : \"Atza|IwEBIM-Xi3zGTGBJdCGNWy10PyTRjz-Z_J3mQenuho1agMufyBPkqLLs0RBE3TXfNWv7QUX9SPLnY8a2klWq_p62BB8JOoQIasBVYA5WWvWY5oaSb8wQPH7gkxh_moXoaQ-KMnlg9sz6XjK96N1xQMVoJDsUQeQunbJtOkJJnrYaKWlv3n5L0yRufkJB4B56wfxPEEbUWWmKSox31UFkMUDPm02TKnP4rj_7cFWyqtrCziB2QnW48IWD6tsm4BrjzaLBe1RLd0ERDiUjElDAyIrorCjkbQpCCgnftoyzq5MI9GEv3M33edEp6hunCV4QBOTqUs22Mmtx9FFvc4hcHDFWR-tNOQFvFM2LavwEGfdjhQviEYbf2OYokrm3C0gma-xrQjSECwSNf6gohba7BQNi-kgyOMsAcmne9vR0eX2DOJR6npi4KDH1SBwGea1mApZDhSS56ft01fOYzj5cNXFPGPavT4EFsJNMNgn7ohNi9oY1jXxnJA9Ya_vR_R75lLJd2pJGStjUl2t8Xz0ChwrIGTsW21QK-3SYrpCOYTzXKW1F-XRv96qyboRn_YWt-IdAfjlRcJUsahpfLfAa8miP0VHilU9jIv1dEs46YyEYi_Xhyw\",\r\n \"order_reference_id\" : \"S01-1925960-3974520\",\r\n \"shippingId\":\"2\",\r\n \"ipAddress\":\"198.4.3.2\",\r\n \"campaignId\":\"4\",\r\n \"products\":\r\n {\r\n \"16\":\r\n {\r\n \"offer_id\":\"8\",\r\n \"billing_model_id\":\"4\",\r\n \"quantity\":\"2\"\r\n },\r\n \"4\":\r\n {\r\n \"offer_id\":\"8\",\r\n \"billing_model_id\":\"6\",\r\n \"quantity\":\"1\",\r\n \"children\":\r\n [\r\n {\r\n \"product_id\":\"1\",\r\n \"quantity\":\"2\"\r\n },\r\n {\r\n \"product_id\":\"2\",\r\n \"quantity\":\"1\"\r\n }\r\n ]\r\n }\r\n },\r\n \"gift\":\r\n {\r\n \"email\":\"gift@email.com\",\r\n \"message\":\"This is a gift order and this is a gift message\"\r\n },\r\n \"notes\":\"This is a test order using Amazon Pay new_order\",\r\n \"AFID\":\"AFID\",\r\n \"SID\":\"SID\",\r\n \"AFFID\":\"AFFID\",\r\n \"C1\":\"C1\",\r\n \"C2\":\"C2\",\r\n \"C3\":\"C3\",\r\n \"AID\":\"AID\",\r\n \"OPT\":\"OPT\",\r\n \"click_id\":\"abc123\"\r\n}"},"url":"https://{{app_key}}.{{domain}}{{api_ext}}new_order","description":"Instructions for sending a new_order request with Amazon Pay as the payment method and payment provider.
\n","urlObject":{"protocol":"https","host":["{{app_key}}","{{domain}}{{api_ext}}new_order"],"query":[],"variable":[]}},"response":[{"id":"e4843291-a97d-4af0-ad22-4ff8d79853d1","name":"new_order","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"creditCardType\" : \"amazonpay\",\r\n \"tranType\" : \"sale\",\r\n \"access_token\" : \"Atza|IwEBIM-Xi3zGTGBJdCGNWy10PyTRjz-Z_J3mQenuho1agMufyBPkqLLs0RBE3TXfNWv7QUX9SPLnY8a2klWq_p62BB8JOoQIasBVYA5WWvWY5oaSb8wQPH7gkxh_moXoaQ-KMnlg9sz6XjK96N1xQMVoJDsUQeQunbJtOkJJnrYaKWlv3n5L0yRufkJB4B56wfxPEEbUWWmKSox31UFkMUDPm02TKnP4rj_7cFWyqtrCziB2QnW48IWD6tsm4BrjzaLBe1RLd0ERDiUjElDAyIrorCjkbQpCCgnftoyzq5MI9GEv3M33edEp6hunCV4QBOTqUs22Mmtx9FFvc4hcHDFWR-tNOQFvFM2LavwEGfdjhQviEYbf2OYokrm3C0gma-xrQjSECwSNf6gohba7BQNi-kgyOMsAcmne9vR0eX2DOJR6npi4KDH1SBwGea1mApZDhSS56ft01fOYzj5cNXFPGPavT4EFsJNMNgn7ohNi9oY1jXxnJA9Ya_vR_R75lLJd2pJGStjUl2t8Xz0ChwrIGTsW21QK-3SYrpCOYTzXKW1F-XRv96qyboRn_YWt-IdAfjlRcJUsahpfLfAa8miP0VHilU9jIv1dEs46YyEYi_Xhyw\",\r\n \"order_reference_id\" : \"S01-1925960-3974520\",\r\n \"shippingId\":\"2\",\r\n \"ipAddress\":\"198.4.3.2\",\r\n \"campaignId\":\"4\",\r\n \"products\":\r\n {\r\n \"16\":\r\n {\r\n \"offer_id\":\"8\",\r\n \"billing_model_id\":\"4\",\r\n \"quantity\":\"2\"\r\n },\r\n \"4\":\r\n {\r\n \"offer_id\":\"8\",\r\n \"billing_model_id\":\"6\",\r\n \"quantity\":\"1\",\r\n \"children\":\r\n [\r\n {\r\n \"product_id\":\"1\",\r\n \"quantity\":\"2\"\r\n },\r\n {\r\n \"product_id\":\"2\",\r\n \"quantity\":\"1\"\r\n }\r\n ]\r\n }\r\n },\r\n \"gift\":\r\n {\r\n \"email\":\"gift@email.com\",\r\n \"message\":\"This is a gift order and this is a gift message\"\r\n },\r\n \"notes\":\"This is a test order using Amazon Pay new_order\",\r\n \"AFID\":\"AFID\",\r\n \"SID\":\"SID\",\r\n \"AFFID\":\"AFFID\",\r\n \"C1\":\"C1\",\r\n \"C2\":\"C2\",\r\n \"C3\":\"C3\",\r\n \"AID\":\"AID\",\r\n \"OPT\":\"OPT\",\r\n \"click_id\":\"abc123\"\r\n}"},"url":"https://{{app_key}}.{{domain}}{{api_ext}}new_order"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"c65938a3-e5d5-41bc-818e-f0bd567854a1"}],"id":"29ab72fd-e7fb-4b36-b5ca-f9cc4d2aac7d","description":"Amazon Pay with Merchant Web Services (MWS) is an alternative payment provider AND payment method within sticky.io
\nTo implement Amazon Pay, a valid Amazon MWS SellerCentral account will be required and use of Amazon button widgets. For information on adding Amazon Pay widgets on checkout page, visit Seller Central at https://sellercentral.amazon.com.
\nWith the automatic payments feature via the Billing Agreement implementation, customers can give consent to pre-authorize payments for future purchases. This enables you to charge a customer's Amazon account on a regular basis for subscriptions and usage-based billing without requiring the customer to authorize a payment each time. This requires use of the Billing Agreement implementation and requires consent from the user upon the initial order.
\nAmazon Pay requires the use of Instant Payment Notifications (IPNs), basically webhooks that notify sticky.io of updated transactional data. sticky.io accepts notifications for order reference objects, payment authorization and capture updates, refunds and chargebacks. The sticky.io webhook endpoint will have to be configured within Amazon MWS Seller Central in the Integration Center section. The endpoint MUST be formatted as follows:
\nAmazon Pay implementation allows for reduced number of required fields sent in the NewOrder request. The sticky.io API will set temporary data on the order until the customer information is received from Amazon MWS, this includes billing and shipping first and last name, billing and shipping addresses, phone and email address. Since Amazon Pay is the payment provider and stores all payment information, no payment information will be collected or stored by sticky.io API.
Required Parameters
\nNotes
\nFor maximum page performance, all the sticky.io traffic attribution script code should be added to the BOTTOM of your traffic pages, before the closing </body> tag.
The additional parameters that are described here apply to new_order/new_order_card_on_file/new_order_with_prospect API calls. There are 6 additional parameters that we have made available in those API calls (utm_source, utm_campaign, utm_medium, utm_term, utm_content, device_category), and the UtmCookie javascript object from sticky.io helps with extracting the data from the client browser upon hitting your traffic landing page.
The limelight-traffic-attribution.min.js file served from our CDN (content distribution network) is lightweight at 6kb and designed with fast performance in mind. In most cases, these client side parameters must be sent to your server-side pages that processes the actual sticky.io API (NewOrder) call.\nYou will likely need to push these parameters into your final checkout form so that your server-side code can access them.
sticky.io Tracking Script
\nCopy and Paste the script below on ALL your offer pages
\n<script> \n(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ \n(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), \nm=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) \n})(window,document,'script','https://www.google-analytics.com/analytics.js','ga'); \n\n \nga( 'create', 'UA-80325941-3', 'auto', 'limelightTracker' );// This is “UA-80325941-3” (not your own) - you are free to still have your own analytics tracking along with this. \nga( 'limelightTracker.set', 'dimension1', 'appkey' );// Your sticky.io subdomain here (appkey.sticky.io) \nga( 'limelightTracker.set', 'dimension2', 'Campaign_ID' );// your sticky.io campaign ID here, this will be unique per LL campaign \nga( 'limelightTracker.send', 'pageview' ); \n</script>\n\n<script src=\"//cdn.limelightcrm.com/traffic-attribution/limelight-traffic-attribution.min.js\"></script> \n<script> \nUtmCookie = new UtmCookie(); \ndocument.cookie = 'utm_medium=' + UtmCookie.utm_medium() + ';path=/';\ndocument.cookie = 'utm_source=' + UtmCookie.utm_source() + ';path=/';\ndocument.cookie = 'utm_campaign=' + UtmCookie.utm_campaign() + ';path=/';\ndocument.cookie = 'utm_term=' + UtmCookie.utm_term() + ';path=/';\ndocument.cookie = 'utm_content=' + UtmCookie.utm_content() + ';path=/';\ndocument.cookie = 'device_category=' + UtmCookie.device_category() + ';path=/';\n</script>\nSubmit UTM Parameters in Transaction API Request
\nBelow example is just an illustration of how to pull out the utm_ and device_category data out of the UtmCookie object in order to pass it into the sticky.io API call. You would likely have to embed these into your checkout form as hidden fields.
\nWhen building your request, add the values to your request.
\nPHP Example:
\n$utm_values = [\n ‘utm_medium’,\n ‘utm_source’,\n ‘utm_campaign’,\n ‘utm_term’,\n ‘utm_content’,\n ‘device_category’,\n];\n\nforeach ($utm_values as $utm)\n{\n if ($_COOKIE[$utm])\n {\n $request[$utm] = $_COOKIE[$utm];\n }\n}\nInstructions for sending a new_order request with ApplePay as the payment method and an ApplePay token as the method of payment and its value.
\n","urlObject":{"protocol":"https","host":["{{app_key}}","{{domain}}{{api_ext}}new_order"],"query":[],"variable":[]}},"response":[],"_postman_id":"04b91046-3163-45de-b368-ff46524fbd95"}],"id":"aba45090-4a94-47fd-9323-6def5dfa0972","description":"Guide to implementing ApplePay into checkout flows. There are two implementations available, ApplePay within an iOS app or \"ApplePay on the Web\" with ApplePay.js. Both implementations will require valid Apple developer accounts that are verified by DUNS number (company identifier).
\nTo implement ApplePay in any environment, an Apple Developer account must be set up and verified. To transact with ApplePay Wallet, the appropriate environment, merchant ID and certificates need to be generated and configured.
\nYou will need to go through the following set up process for both ApplePay In-App Purchases via iOS application AND ApplePay on the Web. However, only ApplePay on the Web implementation will need the additional Merchant Identity Certificate.
\nHere is a link to the Apple documentation for this set up process:
\nhttps://developer.apple.com/documentation/apple_pay_on_the_web/configuring_your_environment
\nA sandbox will need to be set up within Apple Developer account to start testing ApplePay implementations. Below is a link to instructions for setting up a sandbox environment as well as test user accounts with test ApplePay wallets.
\nhttps://developer.apple.com/apple-pay/sandbox-testing/
\nAfter successfully setting up a valid Apple developer account, generating a merchant ID, payment certificate and merchant identifier certificate, then setting up a valid sandbox with proper test users and test cards, you will be ready to start developing the checkout page.
\nNote: ApplePay on the Web is only supported within the Safari browser on Apple devices, for example, MacBooks, iPads, iPhones, etc.
\nApplePay on the Web uses ApplePay.js API library. Here is a link to the documentation.
\nhttps://developer.apple.com/documentation/apple_pay_on_the_web/apple_pay_js_api
\nFor example checkout page scripts for ApplePay on the Web, please contact your client success representative. We currently have examples that use HTML, CSS, Javascript and PHP.
\nIf building an iOS app and implementing in-app purchases, below is the link to documentation.
\nhttps://developer.apple.com/documentation/storekit/in-app_purchase#/apple_ref/doc/uid/TP40008267
\nsticky.io will forward the final ApplePay token to the payment provider chosen with their respective parameter name requirements. However, it will be sent to the payment provider exactly how it is passed in with the new_order request. sticky.io will NOT do any interrogation on the token value or encryption/decryption of any kind. Currently sticky.io cannot provide code examples for an iOS app at this time.