Dev_StickyAPI (1.0.0)

Download OpenAPI specification:Download

Sticky.io Restful API offers some new functionality as well as fully restful routes. All request with a payload should be sent as JSON.

/offers/{stickyofferid}

path Parameters

stickyofferid

required

string

query Parameters

domain	string
v2_ext	string

header Parameters

x-api-key required	string
Authorization required	string

Request Body schema: application/json
required

name required	string
required	object

Responses

Response Schema: application/json

required	object
status required	string

Request samples

Payload

Content type

application/json

{"name": "string",
"prepaid": {"is_subscription": 0
}
}

Response samples

200

Content type

application/json

{"status": "string",
"data": {"id": 0,
"name": "string",
"template_id": 0,
"cycle_type_id": 0,
"expire_cycles": 0,
"is_seasonal": 0,
"created_at": {"date": "string",
"timezone_type": 0,
"timezone": "string"
},
"updated_at": {"date": "string",
"timezone_type": 0,
"timezone": "string"
},
"is_archived": 0,
"products": [{"is_trial_allowed": 0,
"id": 0,
"name": "string",
"is_bundle": 0,
"is_custom_bundle": 0
}
],
"billing_models": [{"id": 0,
"name": "string",
"expire_cycles": 0,
"buffer_days": 0,
"created_at": {"date": "string",
"timezone_type": 0,
"timezone": "string"
},
"updated_at": {"date": "string",
"timezone_type": 0,
"timezone": "string"
},
"type": {"id": 0,
"name": "string"
},
"creator": {"department_id": 0,
"id": 0,
"is_active": 0,
"name": "string",
"email": "string",
"call_center_provider_id": 0
},
"updator": {"department_id": 0,
"id": 0,
"is_active": 0,
"name": "string",
"email": "string",
"call_center_provider_id": 0
},
"discount": "string"
}
],
"is_prepaid": 0,
"type": {"id": 0,
"name": "string"
},
"cycle_type": {"id": 0,
"name": "string"
},
"terminating_cycle_type": {"id": 0,
"name": "string",
"description": "string"
},
"prepaid_profile": {"is_subscription": 0,
"is_cancel_immediate": 0,
"is_refund_allowed": 0,
"is_initial_shipping_on_restart": 0,
"created_at": "string",
"updated_at": "string",
"terms": [{"cycles": 0,
"discount_value": "string",
"discount_type": {"id": 0,
"name": "string"
}
}
]
},
"trial": ["string"
],
"cycle_products": "string",
"seasonal_products": "string"
}
}

/offers/{stickyofferid}

path Parameters

stickyofferid

required

string

header Parameters

x-api-key required	string
Authorization required	string

Responses

Response Schema: application/json

object (Empty Schema)

Response samples

200

Content type

application/json

{ }

/subscription-orders/next-recurring-product

query Parameters

domain	string
v2_ext	string

header Parameters

x-api-key required	string
Authorization required	string

Responses

Response Schema: application/json

object (Empty Schema)

Response samples

200

Content type

application/json

{ }

/order/new

query Parameters

api_ext	string
domain	string

header Parameters

x-api-key required	string
Authorization required	string

Request Body schema: application/json
required

CVV required	string
billingAddress1 required	string
billingCity required	string
billingCountry required	string
billingFirstName required	string
billingLastName required	string
billingSameAsShipping required	string
billingState required	string
billingZip required	string
campaignId required	string
creditCardNumber required	string
creditCardType required	string
currency required	string
email required	string
expirationDate required	string
firstName required	string
forceGatewayId required	string
ipAddress required	string
lastName required	string
required	Array of objects
phone required	string
preserve_force_gateway required	string
shippingAddress1 required	string
shippingCity required	string
shippingCountry required	string
shippingId required	string
shippingState required	string
shippingZip required	string
tranType required	string

Responses

Response Schema: application/json

authId required	string
customerId required	string
error_found required	string
gatewayCustomerService required	string
gatewayDescriptor required	string
gateway_id required	string
orderSalesTaxAmount required	string
orderSalesTaxPercent required	string
orderTotal required	string
order_id required	string
prepaid_match required	string
resp_msg required	string
response_code required	string
required	object
test required	string
transactionID required	string

Request samples

Payload

Content type

application/json

{"firstName": "string",
"lastName": "string",
"currency": "string",
"billingFirstName": "string",
"billingLastName": "string",
"billingAddress1": "string",
"billingCity": "string",
"billingState": "string",
"billingZip": "string",
"billingCountry": "string",
"phone": "string",
"email": "string",
"creditCardType": "string",
"creditCardNumber": "string",
"expirationDate": "string",
"CVV": "string",
"shippingId": "string",
"tranType": "string",
"ipAddress": "string",
"campaignId": "string",
"offers": [{"offer_id": 0,
"product_id": 0,
"billing_model_id": 0,
"quantity": 0
}
],
"billingSameAsShipping": "string",
"shippingAddress1": "string",
"shippingCity": "string",
"shippingState": "string",
"shippingZip": "string",
"shippingCountry": "string",
"forceGatewayId": "string",
"preserve_force_gateway": "string"
}

Response samples

200

Content type

application/json

{"gateway_id": "string",
"response_code": "string",
"error_found": "string",
"order_id": "string",
"transactionID": "string",
"customerId": "string",
"authId": "string",
"orderTotal": "string",
"orderSalesTaxPercent": "string",
"orderSalesTaxAmount": "string",
"test": "string",
"prepaid_match": "string",
"gatewayCustomerService": "string",
"gatewayDescriptor": "string",
"subscription_id": {"property1": "string",
"property2": "string"
},
"resp_msg": "string"
}

/subscriptions/{subscriptionid}

path Parameters

subscriptionid

required

string

header Parameters

x-api-key required	string
Authorization required	string

Responses

Response Schema: application/json

object (Empty Schema)

Response samples

200

Content type

application/json

{ }

/products/create

query Parameters

api_ext	string
domain	string

header Parameters

x-api-key required	string
Authorization required	string

Request Body schema: application/json
required

category_id required	string
collections required	string
customer_purchase_limit required	string
delivery_confirmation required	string
digitally_delievered required	string
required	object
paired_products required	Array of strings
preserve_quantity required	string
product_description required	string
product_max_quantity required	string
product_name required	string
product_price required	string
product_restocking_fee required	string
product_sku required	string
recurring_discount_max required	string
shippable required	string
shipping_declared_value required	string
shipping_digital_delivery_url required	string
shipping_weight required	string
signature_confirmation required	string
taxable required	string
vertical_id required	string

Responses

Response Schema: application/json

new_product_id required	string
response_code required	string
response_message required	string

Request samples

Payload

Content type

application/json

{"product_name": "string",
"category_id": "string",
"vertical_id": "string",
"product_sku": "string",
"product_price": "string",
"product_description": "string",
"product_max_quantity": "string",
"customer_purchase_limit": "string",
"taxable": "string",
"shippable": "string",
"signature_confirmation": "string",
"delivery_confirmation": "string",
"preserve_quantity": "string",
"collections": "string",
"shipping_declared_value": "string",
"product_restocking_fee": "string",
"shipping_weight": "string",
"digitally_delievered": "string",
"shipping_digital_delivery_url": "string",
"recurring_discount_max": "string",
"events": {"property1": "string",
"property2": "string"
},
"paired_products": ["string"
]
}

Response samples

200

Content type

application/json

{"response_code": "string",
"response_message": "string",
"new_product_id": "string"
}

/order/refund

query Parameters

api_ext	string
domain	string

header Parameters

x-api-key required	string
Authorization required	string

Request Body schema: application/json
required

amount required	string
keep_recurring required	string
note_id required	integer <int32>
order_id required	string

Responses

Response Schema: application/json

response_code

required

string

Request samples

Payload

Content type

application/json

{"order_id": "string",
"amount": "string",
"keep_recurring": "string",
"note_id": 0
}

Response samples

200

Content type

application/json

{"response_code": "string"
}

/order/force-bill

query Parameters

api_ext	string
domain	string

header Parameters

x-api-key required	string
Authorization required	string

Request Body schema: application/json
required

forceGatewayId required	string
order_id required	string
preserve_force_gateway required	string
product_id required	integer <int32>

Responses

Response Schema: application/json

authId required	string
declineReason required	string
error_found required	string
error_message required	string
order_id required	string
response_code required	string
response_message required	string
transactionID required	string

Request samples

Payload

Content type

application/json

{"order_id": "string",
"forceGatewayId": "string",
"preserve_force_gateway": "string",
"product_id": 0
}

Response samples

200

Content type

application/json

{"response_code": "string",
"error_found": "string",
"error_message": "string",
"transactionID": "string",
"authId": "string",
"declineReason": "string",
"response_message": "string",
"order_id": "string"
}

/order/void

query Parameters

api_ext	string
domain	string

header Parameters

x-api-key required	string
Authorization required	string

Request Body schema: application/json
required

order_id

required

string

Responses

Response Schema: application/json

response_code

required

string

Request samples

Payload

Content type

application/json

{"order_id": "string"
}

Response samples

200

Content type

application/json

{"response_code": "string"
}

/subscriptions/{subscriptionid}/reset

path Parameters

subscriptionid

required

string

query Parameters

domain	string
v2_ext	string

header Parameters

x-api-key required	string
Authorization required	string

Responses

Response Schema: application/json

required	object
status required	string

Response samples

200

Content type

application/json

{"status": "string",
"data": {"recurring_date": {"date": "string",
"timezone_type": 0,
"timezone": "string"
}
}
}

/order/reprocess

query Parameters

api_ext	string
domain	string

header Parameters

x-api-key required	string
Authorization required	string

Request Body schema: application/json
required

order_id

required

string

Responses

Response Schema: application/json

decline_reason required	string
error_found required	string
response_code required	string
response_message required	string

Request samples

Payload

Content type

application/json

{"order_id": "string"
}

Response samples

200

Content type

application/json

{"error_found": "string",
"response_code": "string",
"response_message": "string",
"decline_reason": "string"
}

/subscriptions/{subscriptionid}/bill_now

path Parameters

subscriptionid

required

string

query Parameters

domain	string
v2_ext	string

header Parameters

x-api-key required	string
Authorization required	string

Request Body schema: application/json
required

message required	string
status required	string

Responses

Response Schema: application/json

required	object
status required	string

Request samples

Payload

Content type

application/json

{"status": "string",
"message": "string"
}

Response samples

200

Content type

application/json

{"status": "string",
"data": {"errorFound": 0,
"declineReason": "string",
"responseCode": 0,
"responseMessage": "string",
"orderId": 0
}
}

/products/{stickyproductid}/custom_fields

path Parameters

stickyproductid

required

string

query Parameters

domain	string
v2_ext	string

header Parameters

x-api-key required	string
Authorization required	string

Request Body schema: application/json
required

required

Array of objects

Array

id required	integer <int32>
value required	integer <int32>

Responses

Response Schema: application/json

status

required

string

Request samples

Payload

Content type

application/json

{"custom_fields": [{"id": 0,
"value": 0
}
]
}

Response samples

200

Content type

application/json

{"status": "string"
}

/subscriptions/order_update

header Parameters

x-api-key required	string
Authorization required	string

Responses

Response Schema: application/json

object (Empty Schema)

Response samples

200

Content type

application/json

{ }

/products/delete

query Parameters

api_ext	string
domain	string

header Parameters

x-api-key required	string
Authorization required	string

Request Body schema: application/json
required

product_id

required

string

Responses

Response Schema: application/json

deleted_product_id required	string
response_code required	string
response_message required	string

Request samples

Payload

Content type

application/json

{"product_id": "string"
}

Response samples

200

Content type

application/json

{"response_code": "string",
"response_message": "string",
"deleted_product_id": "string"
}

/order/view

query Parameters

api_ext	string
domain	string

header Parameters

x-api-key required	string
Authorization required	string

Request Body schema: application/json
required

order_id required	Array of integers <int32> [ items <int32 > ]
return_variants required	integer <int32>

Responses

Response Schema: application/json

acquisition_date required	string
affid required	string
affiliate required	string
afid required	string
aid required	string
amount_refunded_to_date required	string
ancestor_id required	string
auth_id required	string
billing_city required	string
billing_country required	string
billing_cycle required	string
billing_first_name required	string
billing_last_name required	string
billing_postcode required	string
billing_state required	string
billing_state_id required	string
billing_street_address required	string
billing_street_address2 required	string
c1 required	string
c2 required	string
c3 required	string
campaign_id required	string
cc_expires required	string
cc_first_6 required	string
cc_last_4 required	string
cc_number required	string
cc_orig_first_6 required	string
cc_orig_last_4 required	string
cc_type required	string
chargeback_date required	string
check_account_last_4 required	string
check_routing_last_4 required	string
check_ssn_last_4 required	string
check_transitnum required	string
child_id required	string
click_id required	string
coupon_discount_amount required	string
coupon_id required	string
created_by_employee_name required	string
created_by_user_name required	string
credit_applied required	string
credit_card_number required	string
current_rebill_discount_percent required	string
customer_id required	string
customers_telephone required	string
decline_reason required	string
decline_salvage_discount_percent required	string
email_address required	string
employeeNotes required	Array of strings
first_name required	string
gateway_descriptor required	string
gateway_id required	string
required	object
hold_date required	string
ip_address required	string
is_any_product_recurring required	string
is_blacklisted required	string
is_chargeback required	string
is_fraud required	string
is_recurring required	string
is_refund required	string
is_rma required	string
is_test_cc required	string
is_void required	string
last_name required	string
main_product_id required	string
main_product_quantity required	string
next_subscription_product required	string
next_subscription_product_id required	string
on_hold required	string
on_hold_by required	string
opt required	string
order_confirmed required	string
order_confirmed_date required	string
order_id required	string
order_sales_tax required	string
order_sales_tax_amount required	string
order_status required	string
order_total required	string
parent_id required	string
prepaid_match required	string
preserve_gateway required	string
processor_id required	string
required	Array of objects
promo_code required	string
rebill_discount_percent required	string
recurring_date required	string
refund_amount required	string
refund_date required	string
response_code required	string
retry_date required	string
rma_number required	string
rma_reason required	string
shippable required	string
shipping_city required	string
shipping_country required	string
shipping_date required	string
shipping_first_name required	string
shipping_id required	string
shipping_last_name required	string
shipping_method_name required	string
shipping_postcode required	string
shipping_state required	string
shipping_state_id required	string
shipping_street_address required	string
shipping_street_address2 required	string
sid required	string
sub_affiliate required	string
systemNotes required	Array of strings
time_stamp required	string
tracking_number required	string
transaction_id required	string
upsell_product_id required	string
upsell_product_quantity required	string
void_amount required	string
void_date required	string
website_received required	string
website_sent required	string

Request samples

Payload

Content type

application/json

{"order_id": [0
],
"return_variants": 0
}

Response samples

200

Content type

application/json

{"response_code": "string",
"order_id": "string",
"acquisition_date": "string",
"ancestor_id": "string",
"affiliate": "string",
"afid": "string",
"sid": "string",
"affid": "string",
"c1": "string",
"c2": "string",
"c3": "string",
"aid": "string",
"opt": "string",
"amount_refunded_to_date": "string",
"auth_id": "string",
"billing_city": "string",
"billing_country": "string",
"billing_cycle": "string",
"billing_first_name": "string",
"billing_last_name": "string",
"billing_postcode": "string",
"billing_state": "string",
"billing_state_id": "string",
"billing_street_address": "string",
"billing_street_address2": "string",
"campaign_id": "string",
"cc_expires": "string",
"cc_first_6": "string",
"cc_last_4": "string",
"cc_number": "string",
"credit_card_number": "string",
"cc_orig_first_6": "string",
"cc_orig_last_4": "string",
"cc_type": "string",
"chargeback_date": "string",
"check_account_last_4": "string",
"check_routing_last_4": "string",
"check_ssn_last_4": "string",
"check_transitnum": "string",
"child_id": "string",
"click_id": "string",
"created_by_user_name": "string",
"created_by_employee_name": "string",
"coupon_discount_amount": "string",
"coupon_id": "string",
"credit_applied": "string",
"customer_id": "string",
"customers_telephone": "string",
"decline_salvage_discount_percent": "string",
"decline_reason": "string",
"email_address": "string",
"first_name": "string",
"gateway_id": "string",
"gateway_descriptor": "string",
"hold_date": "string",
"ip_address": "string",
"is_blacklisted": "string",
"is_chargeback": "string",
"is_fraud": "string",
"is_recurring": "string",
"is_refund": "string",
"is_any_product_recurring": "string",
"is_rma": "string",
"is_test_cc": "string",
"is_void": "string",
"last_name": "string",
"main_product_id": "string",
"main_product_quantity": "string",
"next_subscription_product": "string",
"next_subscription_product_id": "string",
"on_hold": "string",
"on_hold_by": "string",
"order_confirmed": "string",
"order_confirmed_date": "string",
"order_sales_tax": "string",
"order_sales_tax_amount": "string",
"order_status": "string",
"order_total": "string",
"parent_id": "string",
"prepaid_match": "string",
"preserve_gateway": "string",
"processor_id": "string",
"promo_code": "string",
"rebill_discount_percent": "string",
"current_rebill_discount_percent": "string",
"recurring_date": "string",
"refund_amount": "string",
"refund_date": "string",
"retry_date": "string",
"rma_number": "string",
"rma_reason": "string",
"shipping_city": "string",
"shipping_country": "string",
"shipping_date": "string",
"shipping_first_name": "string",
"shipping_id": "string",
"shipping_last_name": "string",
"shipping_method_name": "string",
"shipping_postcode": "string",
"shipping_state": "string",
"shipping_state_id": "string",
"shipping_street_address": "string",
"shipping_street_address2": "string",
"sub_affiliate": "string",
"time_stamp": "string",
"tracking_number": "string",
"transaction_id": "string",
"upsell_product_id": "string",
"upsell_product_quantity": "string",
"void_amount": "string",
"void_date": "string",
"shippable": "string",
"website_received": "string",
"website_sent": "string",
"gift": {"email": "string",
"message": "string"
},
"products": [{"product_id": "string",
"sku": "string",
"price": "string",
"product_qty": "string",
"name": "string",
"on_hold": "string",
"is_recurring": "string",
"recurring_date": "string",
"subscription_id": "string",
"next_subscription_product": "string",
"next_subscription_product_id": "string",
"next_subscription_product_price": "string",
"is_add_on": "string",
"is_in_trial": "string",
"subscription_type": "string",
"subscription_desc": "string",
"billing_model": {"id": "string",
"name": "string",
"description": "string"
},
"offer": {"id": "string",
"name": "string"
},
"step_number": "string"
}
],
"employeeNotes": ["string"
],
"systemNotes": ["string"
]
}

/subscriptions/{subscriptionid}/stop

path Parameters

subscriptionid

required

string

query Parameters

cancellation_id	string
cancellation_reason	string
domain	string
v2_ext	string

header Parameters

x-api-key required	string
Authorization required	string

Request Body schema: application/json
required

code required	integer <int32>
message required	string
status required	string

Responses

Response Schema: application/json

status

required

string

Request samples

Payload

Content type

application/json

{"status": "string",
"code": 0,
"message": "string"
}

Response samples

200

Content type

application/json

{"status": "string"
}

/products/update

query Parameters

api_ext	string
domain	string

header Parameters

x-api-key required	string
Authorization required	string

Request Body schema: application/json
required

required

object

additional property

object

category_id required	string
declared_value required	string
delivery_confirmation required	string
digital_delivery required	string
digital_delivery_url required	string
is_shippable required	string
max_quantity required	string
product_description required	string
product_name required	string
product_price required	string
product_sku required	string
product_weight required	string
signature_confirmation required	string
vertical_id required	string

Responses

Response Schema: application/json

response_code

required

string

Request samples

Payload

Content type

application/json

{"product_id": {"property1": {"product_name": "string",
"product_price": "string",
"product_description": "string",
"product_sku": "string",
"product_weight": "string",
"is_shippable": "string",
"signature_confirmation": "string",
"delivery_confirmation": "string",
"digital_delivery": "string",
"digital_delivery_url": "string",
"declared_value": "string",
"max_quantity": "string",
"category_id": "string",
"vertical_id": "string"
},
"property2": {"product_name": "string",
"product_price": "string",
"product_description": "string",
"product_sku": "string",
"product_weight": "string",
"is_shippable": "string",
"signature_confirmation": "string",
"delivery_confirmation": "string",
"digital_delivery": "string",
"digital_delivery_url": "string",
"declared_value": "string",
"max_quantity": "string",
"category_id": "string",
"vertical_id": "string"
}
}
}

Response samples

200

Content type

application/json

{"response_code": "string"
}

/subscriptions/{subscriptionid}/history

path Parameters

subscriptionid

required

string

query Parameters

domain	string
v2_ext	string

header Parameters

x-api-key required	string
Authorization required	string

Responses

Response Schema: application/json

object (Empty Schema)

Response samples

200

Content type

application/json

{ }

/order/update

query Parameters

api_ext	string
domain	string

header Parameters

x-api-key required	string
Authorization required	string

Request Body schema: application/json
required

required

object

additional property

object

cc_expiration_date required	integer <int32>
cc_number required	string
cc_payment_type required	string
notes required	string

Responses

Response Schema: application/json

required	object
response_code required	string

Request samples

Payload

Content type

application/json

{"order_id": {"property1": {"cc_number": "string",
"cc_payment_type": "string",
"notes": "string",
"cc_expiration_date": 0
},
"property2": {"cc_number": "string",
"cc_payment_type": "string",
"notes": "string",
"cc_expiration_date": 0
}
}
}

Response samples

200

Content type

application/json

{"response_code": "string",
"order_id": {"property1": {"notes": {"response_code": "string"
},
"email": {"response_code": "string"
},
"first_name": {"response_code": "string"
},
"last_name": {"response_code": "string"
}
},
"property2": {"notes": {"response_code": "string"
},
"email": {"response_code": "string"
},
"first_name": {"response_code": "string"
},
"last_name": {"response_code": "string"
}
}
}
}

Dev_StickyAPI (1.0.0)

/offers/{stickyofferid}

path Parameters

query Parameters

header Parameters

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

/offers/{stickyofferid}

path Parameters

header Parameters

Responses

Response Schema: application/json

Response samples

/subscription-orders/next-recurring-product

query Parameters

header Parameters

Responses

Response Schema: application/json

Response samples

/order/new

query Parameters

header Parameters

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

/subscriptions/{subscriptionid}

path Parameters

header Parameters

Responses

Response Schema: application/json

Response samples

/products/create

query Parameters

header Parameters

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

/order/refund

query Parameters

header Parameters

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

/order/force-bill

query Parameters

header Parameters

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

/order/void

query Parameters

header Parameters

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

/subscriptions/{subscriptionid}/reset

path Parameters

query Parameters

header Parameters

Responses

Response Schema: application/json

Response samples

/order/reprocess

query Parameters

header Parameters

Request Body schema: application/jsonrequired

Responses

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required