/
API documentation

API documentation

Owned by Julio Adrián Morales Vásquez (Unlicensed)
Last updated: Aug 21, 2024
10 min read

Authentication

Zapier authentication.

Login

Zapier login.

Request

POST /api/login

Header parameters

Parameter

Value

Parameter

Value

Accept

STRING Required

application/json

Body parameters

Parameter

Value

Parameter

Value

email

STRING Required

The email of the user

E.g. admin@thiio.com

password

STRING Required

The password for the email

E.g. 123456789

integration

STRING Required

zapier

Response

200 OK

{ "data": { "user": { ... }, "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIxIiwianRpIjoiNDUxMzA2YTkzZDYzY2Q3MTdhNTdmNTNkYjY3MDkxNDgzZDNjMzEyYmMyMTEyMGM5M2IyYWM3ZjJhODkyNjAzOTE1NDBlYzVmMmIxZGFlYWQiLCJpYXQiOjE3MjM1NzkzODAuNzYxNzc2LCJuYmYiOjE3MjM1NzkzODAuNzYxNzgxLCJleHAiOjE4ODEzNDU3ODAuNzM1MzQzLCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.d4fwmsSomnRsDv7l1Ly86D8hlpz2RHPbq37bOuj7Qf_ngoVw3ffe_vbuqI0nQ0tqD6fy5Cqdcycevk3mr52SpcY0hiuDwBHW50w1qSbheKGIYtQOLqA7pNzaAWa5UWFTRQmja1FxZpGq_Iwp3IPztHgM_zTcSGgsclrbn7NT69sGw04hbGxkr2p_q5vMjUyUaC0XSLq5cIcKNPTnna_oVJdN4_gf4G6Q4lNfij5FdE5FZSohnX2r5IrfSgoZdX42jJIsT6SI1vcIrDkqvNDU1XWcE2H1epRQJtcm9a7zvuxWMaQdJIw3Ih7UNe7FRewtxCsQUSgALRkyuZLnhhhKgFtcS-Vx0dY6Mk3sijvpeW4ruYTxuyI85g5E4MFwlQcbYpHLLzWSCLLQqtaiqTXuR94cWyIv0Eyz1td3bLa-26ki9d-zChzkMtze-oO48dPshw1zEIpWeUuE1MnwQ7cqgDLreKtcwKsGxNh5ZcuA0OW7I2Ai6kgMDOX7MNG9DFuOU7YI1qi3KvZtSFxd1C6BRXHzcDIHeJcT_-FC996kg46kNeVW5F7U-bpAFdKoXDPw5sP93KmDv7KVoOCxWjHDLKtlw_l2KnYwLvf4dyiQOxqB0m8SVZUF9dTdRfPgwfIfLAS5iBFzmCNzclk-wKVXiuFULykDAlk4t3Vg9xYFEa8", "expires": 1881345780, "setup_finished": true, "integration_uuid": "92e1234af-d123-4ece-b222-54a1437x4831a" } }

Check user logged in

Zapier check user logged.

Request

get /api/check

Header parameters

Parameter

Value

Parameter

Value

Accept

STRING Required

application/json

Authorization

STRING Required

Base 64 encoded string containing the token value got it from login endpoint. The header value should be Bearer <token>

Response

 

200 OK

{ "user": { "id": 1, "uuid": "32ce1a5a-8e9c-4a20-afff-57c1deaee136", "contact_id": 1, "type": "customer_employee", "email": "admin@thiio.com", "email_verified_at": null, "password": "$2y$10$hg98Bo7a9QFwZPGOf.xRe.9ZXfgb9N2NHfeW9vDHQiQr37gC.MOY2", "metadata": { "language": "en", "dashboards": { "default": "set_up", "favorites": [ "set_up", "default" ] }, "date_format": "DD/MM/YYYY", "workspace_type": "advanced", "test_token_time": 30, "worker_attributes": { "lucas_uri": "agent_1_admin", "contact_uri": "client:1_admin", "inbound_calls": 0, "inbound_conversations": 0 } }, "integrations_meta": null, "dialer_extension": null, "dialer_worker_sid": "WK4a1887b78f41363a21d5e03f3171a873", "dialer_activity_sid": "WA993d72c19cd2b35bfc6e2cc9b2690348", "dialer_activity_name": "Idle", "remember_token": null, "welcome_email_sent": 0, "two_factor_enabled": 0, "two_factor_secret_key": null, "deactivated_at": null, "created_at": "2024-06-21 00:23:02", "updated_at": "2024-06-24 12:33:14", "deleted_at": null, "uri": "client:1_admin" } }

Triggers

All triggers use same endpoint for subscribe and unsubscribe.

Subscribe

Request

post /api/integrations/{integration_uuid}/channels

Header parameters

Parameter

Value

Parameter

Value

Accept

STRING Required

application/json

Authorization

STRING Required

Base 64 encoded string containing the token value got it from login endpoint. The header value should be Bearer <token>

Path parameters

Parameter

Value

Parameter

Value

integration_uuid

STRING Required

The uuid of integration for system notifications, this value is sent by the Login endpoint.

Body parameters

Parameter

Value

Parameter

Value

url

STRING Required

Zapier webhook url stored in {{bundle.targetUrl}}

method

STRING Required

zapier

alias

STRING Required

Alias for the trigger in Thiio, the value should be like this Zapier - <name of trigger> (e.g. Zapier - Order completed)

event

STRING Required

Event for trigger in Thiio, posible values:

  • contact-created

  • order-completed

  • refund-applied

  • subscription-canceled

  • transaction-declined

  • customer-created

  • shipping-tracking-info-updated

  • product-conflicts

  • approved-transaction

  • survey-completed

Response

200 OK

{ "data": { "id": "716fcaa4-4554-449a-aa85-cc75f24ebb77", "metadata": { "alias": "Zapier - Transaction declined", "method": "zapier", "url": "https:\/\/hooks.zapier.com\/hooks\/standard\/19665925\/e47c7eefa5ed47d59379c29158b96c67\/", "event": "transaction-declined" } }, "message": "Integration Channel created" }

Unsubscribe

Request

delete /api/channels/{id}

Header parameters

Parameter

Value

Parameter

Value

Accept

STRING Required

application/json

Authorization

STRING Required

Base 64 encoded string containing the token value got it from login endpoint. The header value should be Bearer <token>

Path parameters

Parameter

Value

Parameter

Value

id

STRING Required

Zapier subscribe id stored in {{bundle.subscribeData.data.id}}

Response

200 OK

{ "message": "Integration Channel deleted", "data": null }

Perform list

Request

get /api/zapier/{list}

Header parameters

Parameter

Value

Parameter

Value

Accept

STRING Required

application/json

Authorization

STRING Required

Base 64 encoded string containing the token value got it from login endpoint. The header value should be Bearer <token>

Path parameters

Parameter

Value

Parameter

Value

list

STRING Required

Posible values

  • customers

  • orders

  • shippings

  • subscriptions

  • surveys

  • transactions

  • transaction-histories

Response for customers

200 OK

{ "first_name": "krista", "last_name": "durgan", "email": "durganfb5a8jf3@gmail.com", "id": 1, "url": "http://koelpin.net/temporibus-sit-et-et-incidunt", "type": "customer", "date": "2024-08-12", "customer_since": "2024-08-12T22:31:00Z", "lifetime_value": 0, "activations_count": 0 }

Response for orders

 

200 OK

{ "contact_id": 1, "agent_id": 1, "env": "test", "source": "admin", "completed_at": "2024-08-12T22:29:00Z", "is_shippable": true, "subtotal_pre_tax": 85862, "shipping_pre_tax": 84215, "subtotal": 53866, "discount": 66667, "shipping": 39421, "taxes": 20390, "total": 48818, "metadata": null, "recurrent": true, "created_at": "2024-08-12T22:29:00Z", "id": 88, "url": "https://thiio.thiio.test/admin#/?order_id=", "type": "sale_approved", "number": 46, "date": "2024-08-12", "subtotal_tax": 41, "shipping_tax": 54, "items": [ { "id": "fd35db1d-727e-35f9-8d3f-36d350c25816", "plan": null, "hard_cost": 85, "unit_price": 973, "quantity": 23, "subtotal": 950, "discount": 90, "subtotal_tax": 8, "shipping": 55, "shipping_tax": 3, "total": 999, "offer": null, "product": { "id": "821de435-e877-365a-9d4f-f158078e8299", "product_variation_id": "018cbbac-9358-3aad-87c4-d9d751de3a9a", "name": "Qui maxime enim est.", "type": "digital", "sku": "et", "upc": 65, "ean": 20, "isbn": 3, "metadata": null } } ], "contact": { "id": "3313f76f-08aa-338c-b5cc-679a8ff0f271", "first_name": "Johnathon", "last_name": "Lockman", "email": "pthiel@hotmail.com", "phones": [ { "number": "254-671-3466", "country": "IO", "default": false }, { "number": "463-967-3313", "country": "NG", "default": true } ] }, "agent": { "id": "6f0adc6d-d457-3c0e-b852-173540a06d44", "first_name": "Letitia", "last_name": "Kilback", "email": "yruecker@jacobi.com", "phones": [ { "number": "+19522670267", "country": "PR", "default": false }, { "number": "(947) 643-4856", "country": "SL", "default": true } ] }, "address": { "id": "14aade11-3114-378b-9fb4-2c01fa7e0f68", "first_name": "Jazmyne", "last_name": "Carroll", "country": "AL", "state": "NM", "city": "Bogisichfort", "line": "67586 Nitzsche Shoals Suite 543", "line2": "961 Flatley Inlet", "zip_code": "69324", "references": null }, "payment_method": { "id": "ad46ac3c-b37f-32ea-a2ed-608d88f8dcb5", "type": "card", "brand": "visa", "last4": 4242, "exp_month": 6, "exp_year": 2030, "address": { "id": "12902b93-1eed-3dde-ae4f-449c19468f98", "first_name": "Dagmar", "last_name": "Mayert", "country": "CD", "state": "OR", "city": "Luettgenhaven", "line": "10033 Kiehn Grove Suite 759", "line2": "552 Cesar Avenue Suite 009", "zip_code": "36500-9396", "references": null } }, "gateway": { "id": "e6f95da3-cdaf-32d9-839e-238aa4227c39", "type": "magnam", "name": "Alberto Cruickshank" }, "transactions": [ { "id": "7d2fe6ea-0c91-31cb-b136-1ee0f3e9b363", "date": "2024-08-12 22:29:00", "external_gateway_id": "d231c37f-f3b9-3aea-b575-eb3003a0cfb7", "subtotal": 434, "discount": 39, "subtotal_tax": 54, "shipping": 20, "shipping_tax": 48, "total": 788, "coupon": null, "items": [ { "id": "71cfb805-f334-3047-b6af-5678cda53191", "plan": null, "hard_cost": 47, "unit_price": 892, "quantity": 30, "subtotal": 762, "discount": 41, "subtotal_tax": 57, "shipping": 96, "shipping_tax": 64, "total": 484, "offer": null, "product": { "id": "6f745291-d064-314f-a1f5-415cd8fb2a43", "product_variation_id": "7af2ec1e-0086-37a9-a3be-cf8eea38a551", "name": "Rerum voluptas eum beatae nam.", "type": "physical", "sku": "ab", "upc": 67, "ean": 19, "isbn": 47, "metadata": null } } ], "page": null } ] }

 

Response for shippings

 

200 OK

{ "id": 2, "url": "https://www.gleichner.com/qui-animi-a-occaecati-ut-molestiae-voluptatem-cum", "number": 53, "date": "2024-08-12T22:35:24Z", "source": "admin", "env": "test", "recurrent": false, "subtotal": 81109, "discount": 74977, "subtotal_tax": 7, "shipping": 39, "shipping_tax": 68, "total": 11766, "coupon": null, "items": [ { "id": "b6003b6b-dcc2-3e02-968a-6fa9eb8c72e2", "product": { "id": "eec20b5f-e396-3555-a485-d33c6838dcfc", "product_variation_id": "cd92206e-f20f-3a1a-ab2f-106443c032a1", "name": "Harum illo exercitationem.", "type": "digital", "sku": "maxime", "upc": 97, "ean": 11, "isbn": 85, "metadata": null }, "plan": null, "hard_cost": 74, "unit_price": 109, "quantity": 21, "subtotal": 753, "discount": 34, "subtotal_tax": 46, "shipping": 35, "shipping_tax": 44, "total": 919, "offer": null } ], "contact": { "id": "713c8f98-b447-3e0e-97b9-04e94103cd2b", "first_name": "Coty", "last_name": "Cartwright", "email": "dooley.travis@aufderhar.com", "phones": [ { "number": "1-219-209-1606", "country": "BR", "default": false }, { "number": "+1-571-877-1535", "country": "KP", "default": true } ] }, "agent": { "id": "720d3a08-9312-3a53-8336-c431d8069452", "first_name": "Moses", "last_name": "Schowalter", "email": "effie.rath@gmail.com", "phones": [ { "number": "636.339.0523", "country": "AE", "default": true }, { "number": "1-229-746-2842", "country": "VU", "default": false } ] }, "address": { "id": "db697dd6-8af9-37c3-a7ce-a885c2336319", "first_name": "Arnold", "last_name": "Becker", "country": "JM", "state": "MS", "city": "South Ofelia", "line": "36865 Daniel Inlet", "line2": "23483 Bauch Lights", "zip_code": "61440", "references": null }, "tracking": null, "payment_method": { "id": "8ecf2eb7-de39-3cde-ac7f-d30a2a1c08a3", "type": "card", "brand": "visa", "last4": 4242, "exp_month": 6, "exp_year": 2030, "address": { "id": "23c4239a-ed87-3e44-9217-0814b2f6bb00", "first_name": "Emerald", "last_name": "Harris", "country": "CV", "state": "MA", "city": "Schmidtside", "line": "840 Milton Mount Apt. 095", "line2": "3118 Bradtke Ports Suite 729", "zip_code": "05016", "references": null } }, "gateway": { "id": "f063b5b2-1e4a-3ad1-a02c-951f913a7b84", "type": "et", "name": "Maxine Hyatt" }, "funnel": null, "shippings": [ { "id": "fa08baed-2f4d-3f66-993c-bcb483a21233", "carrier": "redpack", "tracking_number": 78598, "tracking_url": "http://www.pouros.com/", "external_id": "0134173c-aafb-3e14-98cf-d95ef6cb8af3", "items": [], "created_at": "2024-08-12 22:35:24" } ], "transactions": [ { "id": "ec5d5313-73a6-36a0-a9dc-83bdbbed38ae", "date": "2024-08-12 22:35:24", "external_gateway_id": "3d8b0bc1-1971-3961-af37-18b5e116b426", "subtotal": 877, "discount": 46, "subtotal_tax": 81, "shipping": 73, "shipping_tax": 65, "total": 404, "coupon": null, "items": [ { "id": "d70a6858-4cd3-3a99-9172-7379d183eddc", "product": { "id": "7b659d0b-5d4b-37e3-b3d1-0be5e7baa5be", "product_variation_id": "8a89d25c-1349-3125-8da0-d273951fdd2b", "name": "Aut repudiandae inventore mollitia.", "type": "digital", "sku": "exercitationem", "upc": 57, "ean": 98, "isbn": 51, "metadata": null }, "plan": null, "hard_cost": 44, "unit_price": 31, "quantity": 47, "subtotal": 854, "discount": 16, "subtotal_tax": 56, "shipping": 87, "shipping_tax": 87, "total": 190, "offer": null } ] } ] }

 

Response for subscriptions

 

200 OK

{ "env": "test", "status": "canceled", "current_plan_intervals": 1, "period_started_at": "2024-08-14 00:00:00", "accessible_until": "2024-08-14 00:00:00", "coupon": null, "amount": 81977, "on_grace_period": false, "next_payment_date": null, "id": 1, "date": "2024-08-14", "canceled_at": "2024-08-14 00:00:00", "contact": { "id": "e61b99f6-c35c-3372-a098-bf84e8608479", "first_name": "Nelda", "last_name": "Tillman", "email": "delta07@spinka.com", "phones": [ { "number": "+1-732-790-3543", "country": "AO", "default": false }, { "number": "1-940-841-7272", "country": "BJ", "default": false } ] }, "plan": { "id": "03d79b80-ea59-3908-94e1-7666113ef1da", "product_variation_id": "fab6c2c1-bd2a-3e9f-875b-f411998645f5", "name": "Ipsa tempore excepturi sed esse.", "type": "service_drip", "period": "biweekly", "quantity": 96, "unit_price": 851, "shipping_price": 64, "total": 493 }, "product": { "id": "2adafac8-c246-30f8-ae56-51e7d05509d6", "product_variation_id": "71c1db6b-dfd3-3a3f-b5d4-5fbaabddfe06", "name": "Vitae distinctio dolorum optio.", "type": "digital", "sku": "magni", "upc": 98, "ean": 90, "isbn": 16, "metadata": null } }

Response for surveys

200 OK

{ "title": "Survey recusandae sint tempora voluptatibus modi", "description": "Laudantium repudiandae est ea corporis.", "take": "once", "capture_name": true, "capture_phone": true, "capture_at_end": true, "status": true, "start_question_id": null, "lead_capture": "at_end", "metadata": { "end": { "x_position": 890, "y_position": 100 }, "start": { "x_position": 100, "y_position": 100 } } }

Response for transactions

 

200 OK

{ "order_id": 74, "gateway_id": 21, "payment_method_id": 97, "page_visit_id": 53, "env": "test", "type": "sale_approved", "settled": 0, "currency": "USD", "subtotal_pre_tax": 66, "discount": 79, "subtotal_discount_pre_tax": 50, "subtotal_taxes": 93, "subtotal": 69, "shipping_pre_tax": 95, "shipping_taxes": 13, "shipping": 0, "taxes": 95, "total": 78, "subtotal_refunded": 18, "shipping_refunded": 57, "id": 0, "date": "2024-08-14", "source": "admin", "external_gateway_id": "f5a55767-64b3-3480-93b7-7e0a62082ec1", "recurrent": false, "subtotal_tax": 68, "shipping_tax": 85, "coupon": null, "items": [ { "id": "8dd36d56-1f65-3c25-a075-376c6569fac5", "product": { "id": "bd10ca8e-a190-3eb6-a408-0982cd72f457", "product_variation_id": "de47274d-a4b8-3881-a544-236ef04ed500", "name": "Molestiae ea.", "type": "digital", "sku": "quasi", "upc": 99, "ean": 37, "isbn": 57, "metadata": null }, "plan": null, "hard_cost": 26, "unit_price": 495, "quantity": 95, "subtotal": 914, "discount": 86, "subtotal_tax": 85, "shipping": 67, "shipping_tax": 83, "total": 129, "offer": null } ], "contact": { "id": "f047fd44-2db1-36d0-817a-0f49c7ec00ac", "first_name": "Stella", "last_name": "Robel", "email": "uhane@hayes.biz", "phones": [ { "number": "+1-678-579-6362", "country": "UM", "default": true }, { "number": "972-232-9502", "country": "CK", "default": true } ] }, "agent": { "id": "d0dc21f5-a6f1-30d8-ac49-2b5c376ab5ba", "first_name": "Orpha", "last_name": "Hand", "email": "glen.jakubowski@yahoo.com", "phones": [ { "number": "+1-860-975-7558", "country": "MQ", "default": true }, { "number": "1-661-796-5918", "country": "PK", "default": true } ] }, "address": { "id": "216d0d94-9952-3dcc-b200-a9c8d16ab7bb", "first_name": "Russel", "last_name": "Rowe", "country": "NC", "state": "MN", "city": "Port Salvadorshire", "line": "60365 Kilback Overpass", "line2": "783 Angela Row", "zip_code": "19582", "references": null }, "tracking": null, "payment_method": { "id": "6f74ec61-9c35-38da-a413-b36a09949bc0", "type": "card", "brand": "visa", "last4": 4242, "exp_month": 6, "exp_year": 2030, "address": { "id": "fa659cb4-dbbd-3638-9957-17bc51caae84", "first_name": "Makenna", "last_name": "Krajcik", "country": "MO", "state": "NM", "city": "Efrenfurt", "line": "41381 Lacey Club", "line2": "4123 Carlie Views Suite 940", "zip_code": "51917-5380", "references": null } }, "gateway": { "id": "c648f7a2-4a45-37ac-a472-73ca3614323f", "type": "dolores", "name": "Prof. Wiley Boyle MD" }, "funnel": null, "page": null }

 

Response for transaction-histories

 

200 OK

{ "order_id": "e887329b-237b-39b7-ad6f-7222e25aa06e", "transaction_id": "d3910180-2ae0-3f8c-8551-0078056adf05", "agent_id": 1, "created_by": 1, "gateway_id": null, "transaction_history_id": null, "tax_integration_id": null, "visible": true, "env": "test", "source": "admin", "external_gateway_id": "8b2e5cf1-a409-36eb-8236-02fb1eb20b29", "external_fraud_prevention_id": null, "external_tax_id": null, "type": "sale_approved", "method": null, "reference": null, "subtotal_pre_tax": 91.45, "discount": 0, "subtotal_discount_pre_tax": 91.45, "subtotal_taxes": 0, "subtotal": 91.45, "shipping_pre_tax": 54.36, "shipping_taxes": 0, "shipping": 54.36, "taxes": 0, "total": 145.81, "hard_cost": 91.45, "processing_fee": 0, "additional_fee": 0, "transaction_subtotal": 91.45, "transaction_shipping": 54.36, "description": null, "gateway_fees": [], "gateway_response": [], "antifraud_response": null, "referral_date": null, "refund_days": null, "approved_refund": null, "has_commissions": false, "date_at": "2024-08-14 09:21:41", "id": 4, "date": "2024-08-14", "recurrent": false, "subtotal_tax": 0, "shipping_tax": 0, "refunded_items": [ { "id": "2fd49121-fa96-3e1a-b21a-6c67b1d72099", "item_id": "5ecc255b-a329-3cfd-8a67-ef8b23483608", "quantity_returned": 0, "quantity_refunded": 5, "subtotal": 524, "subtotal_tax": 0, "shipping": 0, "shipping_tax": 0, "total": 785, "created_at": "2024-08-14", "product": { "id": "c160d525-08c3-3d8b-8737-cfc1e29a14ad", "product_variation_id": "c95d333b-8dd8-30a5-8084-160a976094ef", "name": "Non in omnis laboriosam.", "type": "physical", "sku": "blanditiis", "upc": 14, "ean": 44, "isbn": 38, "metadata": null }, "plan": null, "offer": null } ], "agent": { "id": "be798215-facf-3517-bc72-ae38fd98c3b9", "first_name": "Adaline", "last_name": "Kunde", "email": "narciso.dickinson@yahoo.com", "phones": [ { "number": "+1-206-834-2536", "country": "ES", "default": true }, { "number": "+1-878-450-3219", "country": "ST", "default": true } ] }, "contact": { "id": "58875c44-52cd-3fd4-8017-9113e24631cc", "first_name": "Evelyn", "last_name": "Lynch", "email": "khuel@hotmail.com", "phones": [ { "number": "+17723611127", "country": "BZ", "default": false }, { "number": "+1-651-288-0297", "country": "CL", "default": false } ] }, "address": { "id": "c0ef1e4e-658f-3188-9bed-4a80b7b47858", "first_name": "Trey", "last_name": "Nicolas", "country": "MY", "state": "OK", "city": "Lake Myah", "line": "2894 Wintheiser Inlet", "line2": "79611 Prosacco Trail Suite 971", "zip_code": "14986-8402", "references": null }, "tracking": null, "payment_method": { "id": "c577e57e-c8c7-3adf-b30b-8ebead07f4c9", "type": "card", "brand": "visa", "last4": 4242, "exp_month": 6, "exp_year": 2030, "address": { "id": "2aa3293b-49ef-3bf3-a615-8573db977848", "first_name": "Watson", "last_name": "Quigley", "country": "LC", "state": "VT", "city": "Hunterton", "line": "430 Predovic Flats", "line2": "3325 Ward Cliffs Suite 157", "zip_code": "87920", "references": null } }, "gateway": { "id": "d49ce1f8-b0b7-3db9-a52c-0b8f77c58f4b", "type": "est", "name": "Arielle Reichel" }, "funnel": null, "page": null }

 

Actions

Create lead with customer note

Request

POST /api/zapier/store-customer-order

Header parameters

Parameter

Value

Parameter

Value

Accept

STRING Required

application/json

Authorization

STRING Required

Base 64 encoded string containing the token value got it from login endpoint. The header value should be Bearer <token>

Body parameters

Parameter

Value

Parameter

Value

event

customer

source

zapier

contact

object Required

The contact object

contact.email

STRING Required

The customer email

E.g. customer@thiio.com

contact.first_name

STRING Required

The customer first name

E.g. John

contact.last_name

STRING Required

The customer last_name

E.g. Doe

phone

object Required

The phone object

phone.country

STRING Required

The customer phone country code

E.g. US

phone.number

STRING Required

The customer phone number

E.g. +17723611127

Response

200 OK

{ "event": "customer", "source": "zapier", "contact": { "email": "customer@thiio.com", "last_name": "Doe", "first_name": "John" }, "phone": { "country": "US", "number": "+17723611127" } }

Create shipping tracking info update

Request

PUT /api/zapier/update-shipping-tracking-info/{shipping_uuid}

Header parameters

Parameter

Value

Parameter

Value

Accept

STRING Required

application/json

Authorization

STRING Required

Base 64 encoded string containing the token value got it from login endpoint. The header value should be Bearer <token>

Path parameters

Parameter

Value

Parameter

Value

shipping_uuid

STRING Required

The uuid of the shipping to update.

Body parameters

Parameter

Value

Parameter

Value

carrier

STRING Required

Carrier of the shipping

E.g. dhl

tracking_number

STRING Required

Tracking number of shipping

E.g. 123

Response

200 OK

{ "id": "7862121f-b903-43bf-ae31-d77ecd585f12", "carrier": "dhl", "tracking_number": "123", "tracking_url": null, "external_id": null, "created_at": "2024-07-30 12:12:16", "order_id": "cd500928-4f8d-415a-bf57-07f8cd73c86d", "order": { "id": "cd500928-4f8d-415a-bf57-07f8cd73c86d", "number": 114, "type": null, "source": "admin", "env": "test", "receipt_sent_at": "2024-07-30 11:50:44", "is_shippable": true, "subtotal_pre_tax": 675, "shipping_pre_tax": 27, "subtotal": 675, "discount": 0, "shipping": 27, "taxes": 0, "total": 702, "metadata": null, "recurrent": false, "payment_method": null, "coupon": null, "created_at": "2024-07-30 11:50", "shipping_overwritten": false, "lucas_call_sid": null } }

Create subscription cancelation

Request

post /api/zapier/subscriptions/{subscription_uuid}/cancel

Header parameters

Parameter

Value

Parameter

Value

Accept

STRING Required

application/json

Authorization

STRING Required

Base 64 encoded string containing the token value got it from login endpoint. The header value should be Bearer <token>

Path parameters

Parameter

Value

Parameter

Value

subscription_uuid

STRING Required

The uuid of the subscription to cancel.

Response

200 OK

{ "id": "e7df6809-2917-4cd6-b368-2bb8080a3b8c", "env": "test", "coupon": null, "plan": { "id": "02f8c19b-527b-4100-9586-b6b399913724", "name": "Plan for Product Physical with Variations and Plans ", "period": "biweekly", "quantity": 1, "trial_days": 0, "type": "service_drip" }, "product_variation_plan": { "id": "3c305af7-e10e-4868-8846-939151e7f59c", "unit_price": 571, "shipping_price": 14, "amount": 585 }, "current_plan_intervals": 1, "product": { "id": "ed2ba3c2-18fd-431b-8619-881c3c981901", "name": "Product Physical with Variations and Plans ", "type": "physical", "has_variations": true, "main_image": { "conversions": { "sm": "https://webassets.dev/img/products/physical.svg" }, "url": "https://webassets.dev/img/products/physical.svg" } }, "product_variation": { "id": "e357e7c5-4e01-40f8-92f5-89872e4c41f5", "name": "Color RED", "sku": "80mWJdRse3d", "main_image": null }, "status": "canceled", "amount": 585, "on_grace_period": false, "period_started_at": "2024-07-30 00:00:00", "accessible_until": "2024-08-15 23:59:59", "next_payment_date": null, "created_at": "2024-07-30 14:26:46", "updated_at": "2024-07-30 14:39:02", "metadata": null }

Create lead with order note

Request

POST /api/zapier/store-customer-order

Header parameters

Parameter

Value

Parameter

Value

Accept

STRING Required

application/json

Authorization

STRING Required

Base 64 encoded string containing the token value got it from login endpoint. The header value should be Bearer <token>

Body parameters

Parameter

Value

Parameter

Value

event

order

source

zapier

contact

object Required

The contact object

contact.email

STRING Required

The customer email

E.g. john.doe@thiio.com

contact.first_name

STRING Required

The customer first name

E.g. John

contact.last_name

STRING Required

The customer last_name

E.g. Doe

phone

object Required

The phone object

phone.country

STRING Required

The customer phone country code

E.g. US

phone.number

STRING Required

The customer phone number

E.g. +15124713434

billing_address

object Required

The billing address object

billing_address.first_name

STRING Required

The billing address first name

E.g. John

billing_address.last_name

STRING Required

The billing address last_name

E.g. Doe

billing_address.line1

STRING Required

The billing address line 1

E.g. 11801 Stonehollow Drive

billing_address.line2

object Required

The billing address line 2

E.g. Line 2

billing_address.city

STRING Required

The billing address city

E.g. Austin

billing_address.state

STRING Required

The billing address state

E.g. TX

billing_address.zip_code

STRING Required

The billing address zip code

E.g. 78758

billing_address.country

STRING Required

The billing address country

E.g. US

shipping_address

object

The shipping address object

shipping_address.first_name

STRING

The shipping address first name

E.g. John

shipping_address.last_name

STRING

The shipping address last_name

E.g. Doe

shipping_address.line1

STRING

The shipping address line 1

E.g. 11801 Stonehollow Drive

shipping_address.line2

object

The shipping address line 2

E.g. Line 2

shipping_address.city

STRING

The shipping address city

E.g. Austin

shipping_address.state

STRING

The shipping address state

E.g. TX

shipping_address.zip_code

STRING

The shipping address zip code

E.g. 78758

shipping_address.country

STRING

The shipping address country

E.g. US

order

object Required

The order object

order.id

integer Required

The order id

E.g. 123

order.type

STRING Required

The order type

E.g. Doe

order.user_id

integer Required

The order user id

E.g. 10

order.date

string Required

The order date

E.g. 2024-08-14

order.shipping

number Required

The order shipping

E.g. 10

order.taxes

STRING Required

The order taxes

E.g. 10

order.total

STRING Required

The order total

E.g. 120

order.items

object Required

The order items object

 

order.items.name

STRING Required

The order item name

E.g. Product 1

order.items.title

STRING Required

The order item title

E.g. Product 1 red

order.items.quantity

STRING Required

The order item quantity

E.g. 1

order.items.price

STRING Required

The order item price

E.g. 50

Response

200 OK

{ "success": true, "msg": "received successfully", "err": "", "data": { "event": "order", "source": "zapier", "contact": { "first_name": "John", "last_name": "Doe", "email": "john.doe@thiio.com" }, "phone": { "country": "US", "number": "+15124713434" }, "billing_address": { "first_name": "John", "last_name": "Doe", "line1": "11801 Stonehollow Drive", "line2": "line two", "city": "Austin", "state": "TX", "zip_code": "78758", "country": "US" }, "shipping_address": { "first_name": "John", "last_name": "Doe", "line1": "11801 Stonehollow Drive", "line2": "line two", "city": "Austin", "state": "TX", "zip_code": "78758", "country": "US" }, "order": { "id": 123, "type": "success", "user_id": 10, "date": "2024-08-14", "shipping": 10, "taxes": 10, "total": 120, "items": [ { "name": "Product one", "title": "Product one Red", "quantity": 1, "price": 50 }, { "name": "Product two", "title": "Product two White", "quantity": 1, "price": 50 } ] } } }

Related content