{ "uuid": "6acb4775-ce29-4999-b676-02c7818b48c8", "lastMigration": 19, "name": "Square Connect API", "endpointPrefix": "", "latency": 0, "port": 3000, "hostname": "0.0.0.0", "routes": [ { "uuid": "38ba4a11-7f70-41e4-a4dd-da80edcb0390", "documentation": "CreateMobileAuthorizationCode", "method": "post", "endpoint": "mobile/authorization-code", "responses": [ { "uuid": "7810bf52-df28-461a-b846-ccda0c35366d", "body": "{\n \"authorization_code\": \"YOUR_MOBILE_AUTHORIZATION_CODE\",\n \"expires_at\": \"2019-01-10T19:42:08Z\"\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "b0c8be1f-cda5-400d-8abf-d7842ae106d3", "documentation": "RenewToken", "method": "post", "endpoint": "oauth2/clients/:client_id/access-token/renew", "responses": [ { "uuid": "3eeaddf9-3055-4e0c-a205-4f642a8cd2e0", "body": "{\n \"access_token\": \"ACCESS_TOKEN\",\n \"expires_at\": \"2006-01-02T15:04:05Z\",\n \"merchant_id\": \"MERCHANT_ID\",\n \"token_type\": \"bearer\"\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "b4d9b170-9676-4362-a2db-67af9bde943b", "documentation": "RevokeToken", "method": "post", "endpoint": "oauth2/revoke", "responses": [ { "uuid": "d2539a4a-0e9f-4d2a-93a4-10267d695d3d", "body": "{\n \"success\": true\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "ed22541c-966e-4e58-801d-57ed6a9d8396", "documentation": "ObtainToken", "method": "post", "endpoint": "oauth2/token", "responses": [ { "uuid": "33979571-9d69-4ca7-9d4e-5a195e349501", "body": "{\n \"access_token\": \"ACCESS_TOKEN\",\n \"expires_at\": \"2006-01-02T15:04:05Z\",\n \"merchant_id\": \"MERCHANT_ID\",\n \"refresh_token\": \"REFRESH_TOKEN\",\n \"token_type\": \"bearer\"\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "7bcf8fac-d706-411f-90b7-40dd3e49c844", "documentation": "ListEmployees", "method": "get", "endpoint": "v1/me/employees", "responses": [ { "uuid": "09102d0c-fc25-46d0-82f9-34cca917e695", "body": "[\n {\n \"authorized_location_ids\": [\n \"\"\n ],\n \"created_at\": \"\",\n \"email\": \"\",\n \"external_id\": \"\",\n \"first_name\": \"\",\n \"id\": \"\",\n \"last_name\": \"\",\n \"role_ids\": [\n \"\"\n ],\n \"status\": \"\",\n \"updated_at\": \"\"\n }\n]", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "5693c4e8-60ad-43a0-a590-bb36728a6d10", "documentation": "CreateEmployee", "method": "post", "endpoint": "v1/me/employees", "responses": [ { "uuid": "4cedc58d-4574-4bf0-88c0-133d0a6d095f", "body": "{\n \"authorized_location_ids\": [\n \"\"\n ],\n \"created_at\": \"\",\n \"email\": \"\",\n \"external_id\": \"\",\n \"first_name\": \"\",\n \"id\": \"\",\n \"last_name\": \"\",\n \"role_ids\": [\n \"\"\n ],\n \"status\": \"\",\n \"updated_at\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "d4aa82c3-eb0a-4384-9bce-f6fab6a29697", "documentation": "RetrieveEmployee", "method": "get", "endpoint": "v1/me/employees/:employee_id", "responses": [ { "uuid": "cdf4069e-b171-4c1a-90a1-4861eda0e767", "body": "{\n \"authorized_location_ids\": [\n \"\"\n ],\n \"created_at\": \"\",\n \"email\": \"\",\n \"external_id\": \"\",\n \"first_name\": \"\",\n \"id\": \"\",\n \"last_name\": \"\",\n \"role_ids\": [\n \"\"\n ],\n \"status\": \"\",\n \"updated_at\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "97aa0c57-4454-4696-8380-4a9f6a10fd21", "documentation": "UpdateEmployee", "method": "put", "endpoint": "v1/me/employees/:employee_id", "responses": [ { "uuid": "07c686f7-d565-4a4e-b277-af22196fccfd", "body": "{\n \"authorized_location_ids\": [\n \"\"\n ],\n \"created_at\": \"\",\n \"email\": \"\",\n \"external_id\": \"\",\n \"first_name\": \"\",\n \"id\": \"\",\n \"last_name\": \"\",\n \"role_ids\": [\n \"\"\n ],\n \"status\": \"\",\n \"updated_at\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "e5d0e335-0889-4135-958a-55a4c32851bf", "documentation": "ListEmployeeRoles", "method": "get", "endpoint": "v1/me/roles", "responses": [ { "uuid": "49c47083-b7db-4a30-ad9d-fec6725c9d8d", "body": "[\n {\n \"created_at\": \"\",\n \"id\": \"\",\n \"is_owner\": {{faker 'random.boolean'}},\n \"name\": \"\",\n \"permissions\": [\n \"\"\n ],\n \"updated_at\": \"\"\n }\n]", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "725b7542-96d7-4671-ba6c-49b1aa2d9416", "documentation": "CreateEmployeeRole", "method": "post", "endpoint": "v1/me/roles", "responses": [ { "uuid": "f89f0192-f559-411a-8f15-6876d1fd4346", "body": "{\n \"created_at\": \"\",\n \"id\": \"\",\n \"is_owner\": {{faker 'random.boolean'}},\n \"name\": \"\",\n \"permissions\": [\n \"\"\n ],\n \"updated_at\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "5056f310-aae7-4e0f-9fbc-73e0d13a9787", "documentation": "RetrieveEmployeeRole", "method": "get", "endpoint": "v1/me/roles/:role_id", "responses": [ { "uuid": "de9b62d6-4c1e-4f94-81e2-55af30c5955e", "body": "{\n \"created_at\": \"\",\n \"id\": \"\",\n \"is_owner\": {{faker 'random.boolean'}},\n \"name\": \"\",\n \"permissions\": [\n \"\"\n ],\n \"updated_at\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "30a691bc-b6a1-4f83-94b1-9dbc276ea776", "documentation": "UpdateEmployeeRole", "method": "put", "endpoint": "v1/me/roles/:role_id", "responses": [ { "uuid": "b38bd985-cacd-4215-b3f3-63043bf6c220", "body": "{\n \"created_at\": \"\",\n \"id\": \"\",\n \"is_owner\": {{faker 'random.boolean'}},\n \"name\": \"\",\n \"permissions\": [\n \"\"\n ],\n \"updated_at\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "c61965ab-18b2-4ec1-91b0-28c0d158647d", "documentation": "ListOrders", "method": "get", "endpoint": "v1/:location_id/orders", "responses": [ { "uuid": "c3ae90d2-7626-479d-b449-1b49dc2bf804", "body": "[\n {\n \"btc_price_satoshi\": {{faker 'random.number'}},\n \"btc_receive_address\": \"\",\n \"buyer_email\": \"\",\n \"buyer_note\": \"\",\n \"canceled_note\": \"\",\n \"completed_note\": \"\",\n \"created_at\": \"\",\n \"errors\": [\n {\n \"category\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"expires_at\": \"\",\n \"id\": \"\",\n \"order_history\": [\n {\n \"action\": \"\",\n \"created_at\": \"\"\n }\n ],\n \"payment_id\": \"\",\n \"promo_code\": \"\",\n \"recipient_name\": \"\",\n \"recipient_phone_number\": \"\",\n \"refunded_note\": \"\",\n \"shipping_address\": {\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"address_line_3\": \"\",\n \"administrative_district_level_1\": \"\",\n \"administrative_district_level_2\": \"\",\n \"administrative_district_level_3\": \"\",\n \"country\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"locality\": \"\",\n \"organization\": \"\",\n \"postal_code\": \"\",\n \"sublocality\": \"\",\n \"sublocality_2\": \"\",\n \"sublocality_3\": \"\"\n },\n \"state\": \"\",\n \"subtotal_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"tender\": {\n \"card_brand\": \"\",\n \"change_back_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"employee_id\": \"\",\n \"entry_method\": \"\",\n \"id\": \"\",\n \"is_exchange\": {{faker 'random.boolean'}},\n \"name\": \"\",\n \"pan_suffix\": \"\",\n \"payment_note\": \"\",\n \"receipt_url\": \"\",\n \"refunded_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"settled_at\": \"\",\n \"tendered_at\": \"\",\n \"tendered_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"total_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"type\": \"\"\n },\n \"total_discount_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"total_price_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"total_shipping_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"total_tax_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"updated_at\": \"\"\n }\n]", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "2702a201-de25-4a93-bf71-4e346919991e", "documentation": "RetrieveOrder", "method": "get", "endpoint": "v1/:location_id/orders/:order_id", "responses": [ { "uuid": "66c2cb9c-c9d7-4a51-959e-1dbcadfc6b0c", "body": "{\n \"btc_price_satoshi\": {{faker 'random.number'}},\n \"btc_receive_address\": \"\",\n \"buyer_email\": \"\",\n \"buyer_note\": \"\",\n \"canceled_note\": \"\",\n \"completed_note\": \"\",\n \"created_at\": \"\",\n \"errors\": [\n {\n \"category\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"expires_at\": \"\",\n \"id\": \"\",\n \"order_history\": [\n {\n \"action\": \"\",\n \"created_at\": \"\"\n }\n ],\n \"payment_id\": \"\",\n \"promo_code\": \"\",\n \"recipient_name\": \"\",\n \"recipient_phone_number\": \"\",\n \"refunded_note\": \"\",\n \"shipping_address\": {\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"address_line_3\": \"\",\n \"administrative_district_level_1\": \"\",\n \"administrative_district_level_2\": \"\",\n \"administrative_district_level_3\": \"\",\n \"country\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"locality\": \"\",\n \"organization\": \"\",\n \"postal_code\": \"\",\n \"sublocality\": \"\",\n \"sublocality_2\": \"\",\n \"sublocality_3\": \"\"\n },\n \"state\": \"\",\n \"subtotal_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"tender\": {\n \"card_brand\": \"\",\n \"change_back_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"employee_id\": \"\",\n \"entry_method\": \"\",\n \"id\": \"\",\n \"is_exchange\": {{faker 'random.boolean'}},\n \"name\": \"\",\n \"pan_suffix\": \"\",\n \"payment_note\": \"\",\n \"receipt_url\": \"\",\n \"refunded_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"settled_at\": \"\",\n \"tendered_at\": \"\",\n \"tendered_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"total_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"type\": \"\"\n },\n \"total_discount_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"total_price_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"total_shipping_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"total_tax_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"updated_at\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "4f1bbb62-c4ae-42a5-9077-9a9389d90153", "documentation": "UpdateOrder", "method": "put", "endpoint": "v1/:location_id/orders/:order_id", "responses": [ { "uuid": "0f123729-ec2f-4177-aaa8-11ed65a591c1", "body": "{\n \"btc_price_satoshi\": {{faker 'random.number'}},\n \"btc_receive_address\": \"\",\n \"buyer_email\": \"\",\n \"buyer_note\": \"\",\n \"canceled_note\": \"\",\n \"completed_note\": \"\",\n \"created_at\": \"\",\n \"errors\": [\n {\n \"category\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"expires_at\": \"\",\n \"id\": \"\",\n \"order_history\": [\n {\n \"action\": \"\",\n \"created_at\": \"\"\n }\n ],\n \"payment_id\": \"\",\n \"promo_code\": \"\",\n \"recipient_name\": \"\",\n \"recipient_phone_number\": \"\",\n \"refunded_note\": \"\",\n \"shipping_address\": {\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"address_line_3\": \"\",\n \"administrative_district_level_1\": \"\",\n \"administrative_district_level_2\": \"\",\n \"administrative_district_level_3\": \"\",\n \"country\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"locality\": \"\",\n \"organization\": \"\",\n \"postal_code\": \"\",\n \"sublocality\": \"\",\n \"sublocality_2\": \"\",\n \"sublocality_3\": \"\"\n },\n \"state\": \"\",\n \"subtotal_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"tender\": {\n \"card_brand\": \"\",\n \"change_back_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"employee_id\": \"\",\n \"entry_method\": \"\",\n \"id\": \"\",\n \"is_exchange\": {{faker 'random.boolean'}},\n \"name\": \"\",\n \"pan_suffix\": \"\",\n \"payment_note\": \"\",\n \"receipt_url\": \"\",\n \"refunded_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"settled_at\": \"\",\n \"tendered_at\": \"\",\n \"tendered_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"total_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"type\": \"\"\n },\n \"total_discount_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"total_price_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"total_shipping_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"total_tax_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"updated_at\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "a836e4e4-9eb8-4553-baf1-16ae9dd85a93", "documentation": "ListPayments", "method": "get", "endpoint": "v1/:location_id/payments", "responses": [ { "uuid": "aef57803-8839-49b1-ad0e-c601cd1b93ed", "body": "[\n {\n \"additive_tax\": [\n {\n \"applied_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"errors\": [\n {\n \"category\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"fee_id\": \"\",\n \"inclusion_type\": \"\",\n \"name\": \"\",\n \"rate\": \"\"\n }\n ],\n \"additive_tax_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"created_at\": \"\",\n \"creator_id\": \"\",\n \"device\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"discount_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"gross_sales_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"id\": \"\",\n \"inclusive_tax\": [\n {\n \"applied_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"errors\": [\n {\n \"category\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"fee_id\": \"\",\n \"inclusion_type\": \"\",\n \"name\": \"\",\n \"rate\": \"\"\n }\n ],\n \"inclusive_tax_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"is_partial\": {{faker 'random.boolean'}},\n \"itemizations\": [\n {\n \"discount_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"discounts\": [\n {\n \"applied_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"discount_id\": \"\",\n \"name\": \"\"\n }\n ],\n \"gross_sales_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"item_detail\": {\n \"category_name\": \"\",\n \"item_id\": \"\",\n \"item_variation_id\": \"\",\n \"sku\": \"\"\n },\n \"item_variation_name\": \"\",\n \"itemization_type\": \"\",\n \"modifiers\": [\n {\n \"applied_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"modifier_option_id\": \"\",\n \"name\": \"\"\n }\n ],\n \"name\": \"\",\n \"net_sales_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"notes\": \"\",\n \"quantity\": {{faker 'random.number'}},\n \"single_quantity_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"taxes\": [\n {\n \"applied_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"errors\": [\n {\n \"category\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"fee_id\": \"\",\n \"inclusion_type\": \"\",\n \"name\": \"\",\n \"rate\": \"\"\n }\n ],\n \"total_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n }\n }\n ],\n \"merchant_id\": \"\",\n \"net_sales_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"net_total_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"payment_url\": \"\",\n \"processing_fee_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"receipt_url\": \"\",\n \"refunded_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"refunds\": [\n {\n \"created_at\": \"\",\n \"is_exchange\": {{faker 'random.boolean'}},\n \"merchant_id\": \"\",\n \"payment_id\": \"\",\n \"processed_at\": \"\",\n \"reason\": \"\",\n \"refunded_additive_tax\": [\n {\n \"applied_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"errors\": [\n {\n \"category\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"fee_id\": \"\",\n \"inclusion_type\": \"\",\n \"name\": \"\",\n \"rate\": \"\"\n }\n ],\n \"refunded_additive_tax_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"refunded_discount_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"refunded_inclusive_tax\": [\n {\n \"applied_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"errors\": [\n {\n \"category\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"fee_id\": \"\",\n \"inclusion_type\": \"\",\n \"name\": \"\",\n \"rate\": \"\"\n }\n ],\n \"refunded_inclusive_tax_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"refunded_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"refunded_processing_fee_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"refunded_surcharge_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"refunded_surcharges\": [\n {\n \"amount_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"applied_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"name\": \"\",\n \"rate\": \"\",\n \"surcharge_id\": \"\",\n \"taxable\": {{faker 'random.boolean'}},\n \"taxes\": [\n {\n \"applied_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"errors\": [\n {\n \"category\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"fee_id\": \"\",\n \"inclusion_type\": \"\",\n \"name\": \"\",\n \"rate\": \"\"\n }\n ],\n \"type\": \"\"\n }\n ],\n \"refunded_tax_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"refunded_tip_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"type\": \"\"\n }\n ],\n \"surcharge_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"surcharges\": [\n {\n \"amount_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"applied_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"name\": \"\",\n \"rate\": \"\",\n \"surcharge_id\": \"\",\n \"taxable\": {{faker 'random.boolean'}},\n \"taxes\": [\n {\n \"applied_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"errors\": [\n {\n \"category\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"fee_id\": \"\",\n \"inclusion_type\": \"\",\n \"name\": \"\",\n \"rate\": \"\"\n }\n ],\n \"type\": \"\"\n }\n ],\n \"swedish_rounding_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"tax_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"tender\": [\n {\n \"card_brand\": \"\",\n \"change_back_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"employee_id\": \"\",\n \"entry_method\": \"\",\n \"id\": \"\",\n \"is_exchange\": {{faker 'random.boolean'}},\n \"name\": \"\",\n \"pan_suffix\": \"\",\n \"payment_note\": \"\",\n \"receipt_url\": \"\",\n \"refunded_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"settled_at\": \"\",\n \"tendered_at\": \"\",\n \"tendered_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"total_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"type\": \"\"\n }\n ],\n \"tip_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"total_collected_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n }\n }\n]", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "bbc67daf-0b5c-451f-b8a8-4794198c5659", "documentation": "RetrievePayment", "method": "get", "endpoint": "v1/:location_id/payments/:payment_id", "responses": [ { "uuid": "985bf946-fc97-4f5d-bd97-4f76b8a77aa9", "body": "{\n \"additive_tax\": [\n {\n \"applied_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"errors\": [\n {\n \"category\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"fee_id\": \"\",\n \"inclusion_type\": \"\",\n \"name\": \"\",\n \"rate\": \"\"\n }\n ],\n \"additive_tax_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"created_at\": \"\",\n \"creator_id\": \"\",\n \"device\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"discount_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"gross_sales_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"id\": \"\",\n \"inclusive_tax\": [\n {\n \"applied_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"errors\": [\n {\n \"category\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"fee_id\": \"\",\n \"inclusion_type\": \"\",\n \"name\": \"\",\n \"rate\": \"\"\n }\n ],\n \"inclusive_tax_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"is_partial\": {{faker 'random.boolean'}},\n \"itemizations\": [\n {\n \"discount_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"discounts\": [\n {\n \"applied_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"discount_id\": \"\",\n \"name\": \"\"\n }\n ],\n \"gross_sales_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"item_detail\": {\n \"category_name\": \"\",\n \"item_id\": \"\",\n \"item_variation_id\": \"\",\n \"sku\": \"\"\n },\n \"item_variation_name\": \"\",\n \"itemization_type\": \"\",\n \"modifiers\": [\n {\n \"applied_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"modifier_option_id\": \"\",\n \"name\": \"\"\n }\n ],\n \"name\": \"\",\n \"net_sales_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"notes\": \"\",\n \"quantity\": {{faker 'random.number'}},\n \"single_quantity_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"taxes\": [\n {\n \"applied_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"errors\": [\n {\n \"category\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"fee_id\": \"\",\n \"inclusion_type\": \"\",\n \"name\": \"\",\n \"rate\": \"\"\n }\n ],\n \"total_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n }\n }\n ],\n \"merchant_id\": \"\",\n \"net_sales_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"net_total_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"payment_url\": \"\",\n \"processing_fee_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"receipt_url\": \"\",\n \"refunded_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"refunds\": [\n {\n \"created_at\": \"\",\n \"is_exchange\": {{faker 'random.boolean'}},\n \"merchant_id\": \"\",\n \"payment_id\": \"\",\n \"processed_at\": \"\",\n \"reason\": \"\",\n \"refunded_additive_tax\": [\n {\n \"applied_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"errors\": [\n {\n \"category\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"fee_id\": \"\",\n \"inclusion_type\": \"\",\n \"name\": \"\",\n \"rate\": \"\"\n }\n ],\n \"refunded_additive_tax_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"refunded_discount_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"refunded_inclusive_tax\": [\n {\n \"applied_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"errors\": [\n {\n \"category\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"fee_id\": \"\",\n \"inclusion_type\": \"\",\n \"name\": \"\",\n \"rate\": \"\"\n }\n ],\n \"refunded_inclusive_tax_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"refunded_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"refunded_processing_fee_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"refunded_surcharge_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"refunded_surcharges\": [\n {\n \"amount_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"applied_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"name\": \"\",\n \"rate\": \"\",\n \"surcharge_id\": \"\",\n \"taxable\": {{faker 'random.boolean'}},\n \"taxes\": [\n {\n \"applied_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"errors\": [\n {\n \"category\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"fee_id\": \"\",\n \"inclusion_type\": \"\",\n \"name\": \"\",\n \"rate\": \"\"\n }\n ],\n \"type\": \"\"\n }\n ],\n \"refunded_tax_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"refunded_tip_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"type\": \"\"\n }\n ],\n \"surcharge_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"surcharges\": [\n {\n \"amount_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"applied_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"name\": \"\",\n \"rate\": \"\",\n \"surcharge_id\": \"\",\n \"taxable\": {{faker 'random.boolean'}},\n \"taxes\": [\n {\n \"applied_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"errors\": [\n {\n \"category\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"fee_id\": \"\",\n \"inclusion_type\": \"\",\n \"name\": \"\",\n \"rate\": \"\"\n }\n ],\n \"type\": \"\"\n }\n ],\n \"swedish_rounding_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"tax_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"tender\": [\n {\n \"card_brand\": \"\",\n \"change_back_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"employee_id\": \"\",\n \"entry_method\": \"\",\n \"id\": \"\",\n \"is_exchange\": {{faker 'random.boolean'}},\n \"name\": \"\",\n \"pan_suffix\": \"\",\n \"payment_note\": \"\",\n \"receipt_url\": \"\",\n \"refunded_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"settled_at\": \"\",\n \"tendered_at\": \"\",\n \"tendered_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"total_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"type\": \"\"\n }\n ],\n \"tip_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"total_collected_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "e52bed46-b96a-4ac9-8520-fec0b9b5a1cc", "documentation": "ListRefunds", "method": "get", "endpoint": "v1/:location_id/refunds", "responses": [ { "uuid": "44965607-a8b2-4fdf-a6c0-340a2402f4d5", "body": "[\n {\n \"created_at\": \"\",\n \"is_exchange\": {{faker 'random.boolean'}},\n \"merchant_id\": \"\",\n \"payment_id\": \"\",\n \"processed_at\": \"\",\n \"reason\": \"\",\n \"refunded_additive_tax\": [\n {\n \"applied_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"errors\": [\n {\n \"category\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"fee_id\": \"\",\n \"inclusion_type\": \"\",\n \"name\": \"\",\n \"rate\": \"\"\n }\n ],\n \"refunded_additive_tax_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"refunded_discount_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"refunded_inclusive_tax\": [\n {\n \"applied_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"errors\": [\n {\n \"category\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"fee_id\": \"\",\n \"inclusion_type\": \"\",\n \"name\": \"\",\n \"rate\": \"\"\n }\n ],\n \"refunded_inclusive_tax_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"refunded_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"refunded_processing_fee_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"refunded_surcharge_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"refunded_surcharges\": [\n {\n \"amount_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"applied_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"name\": \"\",\n \"rate\": \"\",\n \"surcharge_id\": \"\",\n \"taxable\": {{faker 'random.boolean'}},\n \"taxes\": [\n {\n \"applied_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"errors\": [\n {\n \"category\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"fee_id\": \"\",\n \"inclusion_type\": \"\",\n \"name\": \"\",\n \"rate\": \"\"\n }\n ],\n \"type\": \"\"\n }\n ],\n \"refunded_tax_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"refunded_tip_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"type\": \"\"\n }\n]", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "dc515476-cafc-4dbd-b40d-ac574320c73f", "documentation": "CreateRefund", "method": "post", "endpoint": "v1/:location_id/refunds", "responses": [ { "uuid": "e2e30d4e-2546-47ee-84d0-a8558ddae84a", "body": "{\n \"created_at\": \"\",\n \"is_exchange\": {{faker 'random.boolean'}},\n \"merchant_id\": \"\",\n \"payment_id\": \"\",\n \"processed_at\": \"\",\n \"reason\": \"\",\n \"refunded_additive_tax\": [\n {\n \"applied_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"errors\": [\n {\n \"category\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"fee_id\": \"\",\n \"inclusion_type\": \"\",\n \"name\": \"\",\n \"rate\": \"\"\n }\n ],\n \"refunded_additive_tax_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"refunded_discount_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"refunded_inclusive_tax\": [\n {\n \"applied_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"errors\": [\n {\n \"category\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"fee_id\": \"\",\n \"inclusion_type\": \"\",\n \"name\": \"\",\n \"rate\": \"\"\n }\n ],\n \"refunded_inclusive_tax_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"refunded_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"refunded_processing_fee_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"refunded_surcharge_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"refunded_surcharges\": [\n {\n \"amount_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"applied_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"name\": \"\",\n \"rate\": \"\",\n \"surcharge_id\": \"\",\n \"taxable\": {{faker 'random.boolean'}},\n \"taxes\": [\n {\n \"applied_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"errors\": [\n {\n \"category\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"fee_id\": \"\",\n \"inclusion_type\": \"\",\n \"name\": \"\",\n \"rate\": \"\"\n }\n ],\n \"type\": \"\"\n }\n ],\n \"refunded_tax_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"refunded_tip_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "350e3a78-f799-4471-a454-538697237812", "documentation": "ListSettlements", "method": "get", "endpoint": "v1/:location_id/settlements", "responses": [ { "uuid": "8abef664-ea5e-4b01-9818-7d9d3b2d8264", "body": "[\n {\n \"bank_account_id\": \"\",\n \"entries\": [\n {\n \"amount_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"fee_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"payment_id\": \"\",\n \"type\": \"\"\n }\n ],\n \"id\": \"\",\n \"initiated_at\": \"\",\n \"status\": \"\",\n \"total_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n }\n }\n]", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "5d34ad6d-d079-4baf-870a-266a0d16d626", "documentation": "RetrieveSettlement", "method": "get", "endpoint": "v1/:location_id/settlements/:settlement_id", "responses": [ { "uuid": "f4fcfd1f-5eb0-4f7e-a5c4-ebe6ec99232f", "body": "{\n \"bank_account_id\": \"\",\n \"entries\": [\n {\n \"amount_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"fee_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n },\n \"payment_id\": \"\",\n \"type\": \"\"\n }\n ],\n \"id\": \"\",\n \"initiated_at\": \"\",\n \"status\": \"\",\n \"total_money\": {\n \"amount\": {{faker 'random.number'}},\n \"currency_code\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "64160bbf-0f1f-4541-a009-4e39e99aafc2", "documentation": "RegisterDomain", "method": "post", "endpoint": "v2/apple-pay/domains", "responses": [ { "uuid": "dae3b6c1-973e-4bb8-a94e-f9440b5dbf79", "body": "{\n \"status\": \"VERIFIED\"\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "d715433e-e658-4176-99f2-4d75ee26346e", "documentation": "ListBankAccounts", "method": "get", "endpoint": "v2/bank-accounts", "responses": [ { "uuid": "78debb96-c625-44fe-934b-b27bda2eb9e9", "body": "{\n \"bank_accounts\": [\n {\n \"account_number_suffix\": \"971\",\n \"account_type\": \"CHECKING\",\n \"bank_name\": \"Bank Name\",\n \"country\": \"US\",\n \"creditable\": false,\n \"currency\": \"USD\",\n \"debitable\": false,\n \"holder_name\": \"Jane Doe\",\n \"id\": \"ao6iaQ9vhDiaQD7n3GB\",\n \"location_id\": \"S8GWD5example\",\n \"primary_bank_identification_number\": \"112200303\",\n \"status\": \"VERIFICATION_IN_PROGRESS\",\n \"version\": 5\n },\n {\n \"account_number_suffix\": \"972\",\n \"account_type\": \"CHECKING\",\n \"bank_name\": \"Bank Name\",\n \"country\": \"US\",\n \"creditable\": false,\n \"currency\": \"USD\",\n \"debitable\": false,\n \"holder_name\": \"Jane Doe\",\n \"id\": \"4x7WXuaxrkQkVlka3GB\",\n \"location_id\": \"S8GWD5example\",\n \"primary_bank_identification_number\": \"112200303\",\n \"status\": \"VERIFICATION_IN_PROGRESS\",\n \"version\": 5\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "bc9d3d76-799d-4834-8f37-8595ff2f565b", "documentation": "GetBankAccountByV1Id", "method": "get", "endpoint": "v2/bank-accounts/by-v1-id/:v1_bank_account_id", "responses": [ { "uuid": "b899436c-496b-44fb-b3b3-c5d8c010adc2", "body": "{\n \"bank_account\": {\n \"account_number_suffix\": \"971\",\n \"account_type\": \"CHECKING\",\n \"bank_name\": \"Bank Name\",\n \"country\": \"US\",\n \"creditable\": false,\n \"currency\": \"USD\",\n \"debitable\": false,\n \"holder_name\": \"Jane Doe\",\n \"id\": \"w3yRgCGYQnwmdl0R3GB\",\n \"location_id\": \"S8GWD5example\",\n \"primary_bank_identification_number\": \"112200303\",\n \"status\": \"VERIFICATION_IN_PROGRESS\",\n \"version\": 5\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "c2abf31a-895d-44ce-bceb-651ce7db99b1", "documentation": "GetBankAccount", "method": "get", "endpoint": "v2/bank-accounts/:bank_account_id", "responses": [ { "uuid": "72d6079f-e43f-4df0-8041-8ef063198060", "body": "{\n \"bank_account\": {\n \"account_number_suffix\": \"971\",\n \"account_type\": \"CHECKING\",\n \"bank_name\": \"Bank Name\",\n \"country\": \"US\",\n \"creditable\": false,\n \"currency\": \"USD\",\n \"debitable\": false,\n \"holder_name\": \"Jane Doe\",\n \"id\": \"w3yRgCGYQnwmdl0R3GB\",\n \"location_id\": \"S8GWD5example\",\n \"primary_bank_identification_number\": \"112200303\",\n \"status\": \"VERIFICATION_IN_PROGRESS\",\n \"version\": 5\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "70b3ffe4-a766-4a8f-8074-a772ea1ac6c1", "documentation": "CreateBooking", "method": "post", "endpoint": "v2/bookings", "responses": [ { "uuid": "963e82a6-c00a-4310-89b0-94bb32388b83", "body": "{\n \"booking\": {\n \"appointment_segments\": [\n {\n \"duration_minutes\": 60,\n \"service_variation_id\": \"RU3PBTZTK7DXZDQFCJHOK2MC\",\n \"service_variation_version\": 1599775456731,\n \"team_member_id\": \"TMXUrsBWWcHTt79t\"\n }\n ],\n \"created_at\": \"2020-10-28T15:47:41Z\",\n \"customer_id\": \"EX2QSVGTZN4K1E5QE1CBFNVQ8M\",\n \"customer_note\": \"\",\n \"id\": \"zkras0xv0xwswx\",\n \"location_id\": \"LEQHH0YY8B42M\",\n \"seller_note\": \"\",\n \"start_at\": \"2020-11-26T13:00:00Z\",\n \"status\": \"ACCEPTED\",\n \"updated_at\": \"2020-10-28T15:47:41Z\",\n \"version\": 0\n },\n \"errors\": []\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "0306eca3-9282-4552-adc8-135d178b36e1", "documentation": "SearchAvailability", "method": "post", "endpoint": "v2/bookings/availability/search", "responses": [ { "uuid": "1bb1a031-ff17-4d8b-be1b-07fcd3270124", "body": "{\n \"availabilities\": [\n {\n \"appointment_segments\": [\n {\n \"duration_minutes\": 60,\n \"service_variation_id\": \"RU3PBTZTK7DXZDQFCJHOK2MC\",\n \"service_variation_version\": 1599775456731,\n \"team_member_id\": \"TMXUrsBWWcHTt79t\"\n }\n ],\n \"location_id\": \"LEQHH0YY8B42M\",\n \"start_at\": \"2020-11-26T13:00:00Z\"\n },\n {\n \"appointment_segments\": [\n {\n \"duration_minutes\": 60,\n \"service_variation_id\": \"RU3PBTZTK7DXZDQFCJHOK2MC\",\n \"service_variation_version\": 1599775456731,\n \"team_member_id\": \"TMXUrsBWWcHTt79t\"\n }\n ],\n \"location_id\": \"LEQHH0YY8B42M\",\n \"start_at\": \"2020-11-26T13:30:00Z\"\n },\n {\n \"appointment_segments\": [\n {\n \"duration_minutes\": 60,\n \"service_variation_id\": \"RU3PBTZTK7DXZDQFCJHOK2MC\",\n \"service_variation_version\": 1599775456731,\n \"team_member_id\": \"TMaJcbiRqPIGZuS9\"\n }\n ],\n \"location_id\": \"LEQHH0YY8B42M\",\n \"start_at\": \"2020-11-26T14:00:00Z\"\n },\n {\n \"appointment_segments\": [\n {\n \"duration_minutes\": 60,\n \"service_variation_id\": \"RU3PBTZTK7DXZDQFCJHOK2MC\",\n \"service_variation_version\": 1599775456731,\n \"team_member_id\": \"TMaJcbiRqPIGZuS9\"\n }\n ],\n \"location_id\": \"LEQHH0YY8B42M\",\n \"start_at\": \"2020-11-26T14:30:00Z\"\n },\n {\n \"appointment_segments\": [\n {\n \"duration_minutes\": 60,\n \"service_variation_id\": \"RU3PBTZTK7DXZDQFCJHOK2MC\",\n \"service_variation_version\": 1599775456731,\n \"team_member_id\": \"TMaJcbiRqPIGZuS9\"\n }\n ],\n \"location_id\": \"LEQHH0YY8B42M\",\n \"start_at\": \"2020-11-26T15:00:00Z\"\n },\n {\n \"appointment_segments\": [\n {\n \"duration_minutes\": 60,\n \"service_variation_id\": \"RU3PBTZTK7DXZDQFCJHOK2MC\",\n \"service_variation_version\": 1599775456731,\n \"team_member_id\": \"TMaJcbiRqPIGZuS9\"\n }\n ],\n \"location_id\": \"LEQHH0YY8B42M\",\n \"start_at\": \"2020-11-26T15:30:00Z\"\n },\n {\n \"appointment_segments\": [\n {\n \"duration_minutes\": 60,\n \"service_variation_id\": \"RU3PBTZTK7DXZDQFCJHOK2MC\",\n \"service_variation_version\": 1599775456731,\n \"team_member_id\": \"TMaJcbiRqPIGZuS9\"\n }\n ],\n \"location_id\": \"LEQHH0YY8B42M\",\n \"start_at\": \"2020-11-26T16:00:00Z\"\n },\n {\n \"appointment_segments\": [\n {\n \"duration_minutes\": 60,\n \"service_variation_id\": \"RU3PBTZTK7DXZDQFCJHOK2MC\",\n \"service_variation_version\": 1599775456731,\n \"team_member_id\": \"TMXUrsBWWcHTt79t\"\n }\n ],\n \"location_id\": \"LEQHH0YY8B42M\",\n \"start_at\": \"2020-11-27T09:00:00Z\"\n },\n {\n \"appointment_segments\": [\n {\n \"duration_minutes\": 60,\n \"service_variation_id\": \"RU3PBTZTK7DXZDQFCJHOK2MC\",\n \"service_variation_version\": 1599775456731,\n \"team_member_id\": \"TMaJcbiRqPIGZuS9\"\n }\n ],\n \"location_id\": \"LEQHH0YY8B42M\",\n \"start_at\": \"2020-11-27T09:30:00Z\"\n },\n {\n \"appointment_segments\": [\n {\n \"duration_minutes\": 60,\n \"service_variation_id\": \"RU3PBTZTK7DXZDQFCJHOK2MC\",\n \"service_variation_version\": 1599775456731,\n \"team_member_id\": \"TMXUrsBWWcHTt79t\"\n }\n ],\n \"location_id\": \"LEQHH0YY8B42M\",\n \"start_at\": \"2020-11-27T10:00:00Z\"\n },\n {\n \"appointment_segments\": [\n {\n \"duration_minutes\": 60,\n \"service_variation_id\": \"RU3PBTZTK7DXZDQFCJHOK2MC\",\n \"service_variation_version\": 1599775456731,\n \"team_member_id\": \"TMXUrsBWWcHTt79t\"\n }\n ],\n \"location_id\": \"LEQHH0YY8B42M\",\n \"start_at\": \"2020-11-27T10:30:00Z\"\n },\n {\n \"appointment_segments\": [\n {\n \"duration_minutes\": 60,\n \"service_variation_id\": \"RU3PBTZTK7DXZDQFCJHOK2MC\",\n \"service_variation_version\": 1599775456731,\n \"team_member_id\": \"TMXUrsBWWcHTt79t\"\n }\n ],\n \"location_id\": \"LEQHH0YY8B42M\",\n \"start_at\": \"2020-11-27T11:00:00Z\"\n },\n {\n \"appointment_segments\": [\n {\n \"duration_minutes\": 60,\n \"service_variation_id\": \"RU3PBTZTK7DXZDQFCJHOK2MC\",\n \"service_variation_version\": 1599775456731,\n \"team_member_id\": \"TMaJcbiRqPIGZuS9\"\n }\n ],\n \"location_id\": \"LEQHH0YY8B42M\",\n \"start_at\": \"2020-11-27T11:30:00Z\"\n },\n {\n \"appointment_segments\": [\n {\n \"duration_minutes\": 60,\n \"service_variation_id\": \"RU3PBTZTK7DXZDQFCJHOK2MC\",\n \"service_variation_version\": 1599775456731,\n \"team_member_id\": \"TMaJcbiRqPIGZuS9\"\n }\n ],\n \"location_id\": \"LEQHH0YY8B42M\",\n \"start_at\": \"2020-11-27T12:00:00Z\"\n },\n {\n \"appointment_segments\": [\n {\n \"duration_minutes\": 60,\n \"service_variation_id\": \"RU3PBTZTK7DXZDQFCJHOK2MC\",\n \"service_variation_version\": 1599775456731,\n \"team_member_id\": \"TMaJcbiRqPIGZuS9\"\n }\n ],\n \"location_id\": \"LEQHH0YY8B42M\",\n \"start_at\": \"2020-11-27T12:30:00Z\"\n },\n {\n \"appointment_segments\": [\n {\n \"duration_minutes\": 60,\n \"service_variation_id\": \"RU3PBTZTK7DXZDQFCJHOK2MC\",\n \"service_variation_version\": 1599775456731,\n \"team_member_id\": \"TMXUrsBWWcHTt79t\"\n }\n ],\n \"location_id\": \"LEQHH0YY8B42M\",\n \"start_at\": \"2020-11-27T13:00:00Z\"\n },\n {\n \"appointment_segments\": [\n {\n \"duration_minutes\": 60,\n \"service_variation_id\": \"RU3PBTZTK7DXZDQFCJHOK2MC\",\n \"service_variation_version\": 1599775456731,\n \"team_member_id\": \"TMXUrsBWWcHTt79t\"\n }\n ],\n \"location_id\": \"LEQHH0YY8B42M\",\n \"start_at\": \"2020-11-27T13:30:00Z\"\n },\n {\n \"appointment_segments\": [\n {\n \"duration_minutes\": 60,\n \"service_variation_id\": \"RU3PBTZTK7DXZDQFCJHOK2MC\",\n \"service_variation_version\": 1599775456731,\n \"team_member_id\": \"TMaJcbiRqPIGZuS9\"\n }\n ],\n \"location_id\": \"LEQHH0YY8B42M\",\n \"start_at\": \"2020-11-27T14:00:00Z\"\n }\n ],\n \"errors\": []\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "a3ec4428-82f3-4963-9144-e4cf143036a4", "documentation": "RetrieveBusinessBookingProfile", "method": "get", "endpoint": "v2/bookings/business-booking-profile", "responses": [ { "uuid": "7f6fad43-53e6-4960-85fb-7107e4ac6b66", "body": "{\n \"business_booking_profile\": {\n \"allow_user_cancel\": true,\n \"booking_enabled\": true,\n \"booking_policy\": \"ACCEPT_ALL\",\n \"business_appointment_settings\": {\n \"alignment_time\": \"HALF_HOURLY\",\n \"any_team_member_booking_enabled\": true,\n \"cancellation_fee_money\": {\n \"currency\": \"USD\"\n },\n \"cancellation_policy\": \"CUSTOM_POLICY\",\n \"location_types\": [\n \"BUSINESS_LOCATION\"\n ],\n \"max_booking_lead_time_seconds\": 31536000,\n \"min_booking_lead_time_seconds\": 0,\n \"multiple_service_booking_enabled\": true,\n \"skip_booking_flow_staff_selection\": false\n },\n \"created_at\": \"2020-09-10T21:40:38Z\",\n \"customer_timezone_choice\": \"CUSTOMER_CHOICE\",\n \"seller_id\": \"MLJQYZZRM0D3Y\"\n },\n \"errors\": []\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "596a13af-7b50-4672-b019-2e61ba38c23e", "documentation": "ListTeamMemberBookingProfiles", "method": "get", "endpoint": "v2/bookings/team-member-booking-profiles", "responses": [ { "uuid": "18463f5e-1877-4a21-944a-51834bd36187", "body": "{\n \"errors\": [],\n \"team_member_booking_profiles\": [\n {\n \"display_name\": \"Sandbox Seller\",\n \"is_bookable\": true,\n \"team_member_id\": \"TMXUrsBWWcHTt79t\"\n },\n {\n \"display_name\": \"Sandbox Staff\",\n \"is_bookable\": true,\n \"team_member_id\": \"TMaJcbiRqPIGZuS9\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "46c1853b-5c43-448e-a193-9d52d705e4bd", "documentation": "RetrieveTeamMemberBookingProfile", "method": "get", "endpoint": "v2/bookings/team-member-booking-profiles/:team_member_id", "responses": [ { "uuid": "5cf9c596-a186-42fd-80e5-df4c3de94781", "body": "{\n \"errors\": [],\n \"team_member_booking_profile\": {\n \"display_name\": \"Sandbox Staff\",\n \"is_bookable\": true,\n \"team_member_id\": \"TMaJcbiRqPIGZuS9\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "f27ab8d1-cfb6-45fb-a550-d54b0327f10b", "documentation": "RetrieveBooking", "method": "get", "endpoint": "v2/bookings/:booking_id", "responses": [ { "uuid": "6c2a4125-cefe-4b85-83e7-a41cd65b0ea7", "body": "{\n \"booking\": {\n \"appointment_segments\": [\n {\n \"duration_minutes\": 60,\n \"service_variation_id\": \"RU3PBTZTK7DXZDQFCJHOK2MC\",\n \"service_variation_version\": 1599775456731,\n \"team_member_id\": \"TMXUrsBWWcHTt79t\"\n }\n ],\n \"created_at\": \"2020-10-28T15:47:41Z\",\n \"customer_id\": \"EX2QSVGTZN4K1E5QE1CBFNVQ8M\",\n \"customer_note\": \"\",\n \"id\": \"zkras0xv0xwswx\",\n \"location_id\": \"LEQHH0YY8B42M\",\n \"seller_note\": \"\",\n \"start_at\": \"2020-11-26T13:00:00Z\",\n \"status\": \"ACCEPTED\",\n \"updated_at\": \"2020-10-28T15:49:25Z\",\n \"version\": 1\n },\n \"errors\": []\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "0f14f215-229f-4cea-bc6b-b82e0094c393", "documentation": "UpdateBooking", "method": "put", "endpoint": "v2/bookings/:booking_id", "responses": [ { "uuid": "b9ded373-1777-4fe2-ac26-4c948d7cdb90", "body": "{\n \"booking\": {\n \"appointment_segments\": [\n {\n \"duration_minutes\": 60,\n \"service_variation_id\": \"RU3PBTZTK7DXZDQFCJHOK2MC\",\n \"service_variation_version\": 1599775456731,\n \"team_member_id\": \"TMXUrsBWWcHTt79t\"\n }\n ],\n \"created_at\": \"2020-10-28T15:47:41Z\",\n \"customer_id\": \"EX2QSVGTZN4K1E5QE1CBFNVQ8M\",\n \"customer_note\": \"I would like to sit near the window please\",\n \"id\": \"zkras0xv0xwswx\",\n \"location_id\": \"LEQHH0YY8B42M\",\n \"seller_note\": \"\",\n \"start_at\": \"2020-11-26T13:00:00Z\",\n \"status\": \"ACCEPTED\",\n \"updated_at\": \"2020-10-28T15:49:25Z\",\n \"version\": 2\n },\n \"errors\": []\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "846439e7-09f8-4308-bb7e-7059b2b57001", "documentation": "CancelBooking", "method": "post", "endpoint": "v2/bookings/:booking_id/cancel", "responses": [ { "uuid": "88962469-ddda-41ac-9312-ed0fdc7fdad0", "body": "{\n \"booking\": {\n \"appointment_segments\": [\n {\n \"duration_minutes\": 60,\n \"service_variation_id\": \"RU3PBTZTK7DXZDQFCJHOK2MC\",\n \"service_variation_version\": 1599775456731,\n \"team_member_id\": \"TMXUrsBWWcHTt79t\"\n }\n ],\n \"created_at\": \"2020-10-28T15:47:41Z\",\n \"customer_id\": \"EX2QSVGTZN4K1E5QE1CBFNVQ8M\",\n \"customer_note\": \"\",\n \"id\": \"zkras0xv0xwswx\",\n \"location_id\": \"LEQHH0YY8B42M\",\n \"seller_note\": \"\",\n \"start_at\": \"2020-11-26T13:00:00Z\",\n \"status\": \"CANCELLED_BY_CUSTOMER\",\n \"updated_at\": \"2020-10-28T15:49:25Z\",\n \"version\": 1\n },\n \"errors\": []\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "29e66e8a-0017-4e0d-a570-2e8426c55ce0", "documentation": "ListCards", "method": "get", "endpoint": "v2/cards", "responses": [ { "uuid": "e01216b8-5017-492c-a869-998423f41bf9", "body": "{\n \"cards\": [\n {\n \"card\": {\n \"billing_address\": {\n \"address_line_1\": \"500 Electric Ave\",\n \"address_line_2\": \"Suite 600\",\n \"administrative_district_level_1\": \"NY\",\n \"country\": \"US\",\n \"locality\": \"New York\",\n \"postal_code\": \"10003\"\n },\n \"bin\": \"411111\",\n \"card_brand\": \"VISA\",\n \"card_type\": \"CREDIT\",\n \"cardholder_name\": \"Amelia Earhart\",\n \"customer_id\": \"VDKXEEKPJN48QDG3BGGFAK05P8\",\n \"enabled\": true,\n \"exp_month\": 11,\n \"exp_year\": 2022,\n \"fingerprint\": \"ex-p-cs80EK9Flz7LsCMv-szbptQ_ssAGrhemzSTsPFgt9nzyE6t7okiLIQc-qw_quqKX4Q\",\n \"id\": \"ccof:uIbfJXhXETSP197M3GB\",\n \"last_4\": \"1111\",\n \"prepaid_type\": \"NOT_PREPAID\",\n \"reference_id\": \"user-id-1\",\n \"version\": 1\n }\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "a5c1995f-4cda-48a2-8f0c-5215677fb5e2", "documentation": "CreateCard", "method": "post", "endpoint": "v2/cards", "responses": [ { "uuid": "c8fc041b-5df4-48f1-be37-ad40976427d8", "body": "{\n \"card\": {\n \"billing_address\": {\n \"address_line_1\": \"500 Electric Ave\",\n \"address_line_2\": \"Suite 600\",\n \"administrative_district_level_1\": \"NY\",\n \"country\": \"US\",\n \"locality\": \"New York\",\n \"postal_code\": \"10003\"\n },\n \"bin\": \"411111\",\n \"card_brand\": \"VISA\",\n \"card_type\": \"CREDIT\",\n \"cardholder_name\": \"Amelia Earhart\",\n \"customer_id\": \"VDKXEEKPJN48QDG3BGGFAK05P8\",\n \"enabled\": true,\n \"exp_month\": 11,\n \"exp_year\": 2022,\n \"fingerprint\": \"ex-p-cs80EK9Flz7LsCMv-szbptQ_ssAGrhemzSTsPFgt9nzyE6t7okiLIQc-qw_quqKX4Q\",\n \"id\": \"ccof:uIbfJXhXETSP197M3GB\",\n \"last_4\": \"1111\",\n \"prepaid_type\": \"NOT_PREPAID\",\n \"reference_id\": \"user-id-1\",\n \"version\": 1\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "98a7e3b8-85aa-4e52-bf78-7ff19e1ddd04", "documentation": "RetrieveCard", "method": "get", "endpoint": "v2/cards/:card_id", "responses": [ { "uuid": "640febe7-67c5-4d24-abe8-f16f9a90509b", "body": "{\n \"card\": {\n \"billing_address\": {\n \"address_line_1\": \"500 Electric Ave\",\n \"address_line_2\": \"Suite 600\",\n \"administrative_district_level_1\": \"NY\",\n \"country\": \"US\",\n \"locality\": \"New York\",\n \"postal_code\": \"10003\"\n },\n \"bin\": \"411111\",\n \"card_brand\": \"VISA\",\n \"card_type\": \"CREDIT\",\n \"cardholder_name\": \"Amelia Earhart\",\n \"customer_id\": \"VDKXEEKPJN48QDG3BGGFAK05P8\",\n \"enabled\": true,\n \"exp_month\": 11,\n \"exp_year\": 2022,\n \"fingerprint\": \"ex-p-cs80EK9Flz7LsCMv-szbptQ_ssAGrhemzSTsPFgt9nzyE6t7okiLIQc-qw_quqKX4Q\",\n \"id\": \"ccof:uIbfJXhXETSP197M3GB\",\n \"last_4\": \"1111\",\n \"prepaid_type\": \"NOT_PREPAID\",\n \"reference_id\": \"user-id-1\",\n \"version\": 1\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "bd00464e-a7bc-4eab-8061-c77ecaf11d8c", "documentation": "DisableCard", "method": "post", "endpoint": "v2/cards/:card_id/disable", "responses": [ { "uuid": "1ef6762c-bb35-45f6-8706-0d7adaf58e0e", "body": "{\n \"card\": {\n \"billing_address\": {\n \"address_line_1\": \"500 Electric Ave\",\n \"address_line_2\": \"Suite 600\",\n \"administrative_district_level_1\": \"NY\",\n \"country\": \"US\",\n \"locality\": \"New York\",\n \"postal_code\": \"10003\"\n },\n \"bin\": \"411111\",\n \"card_brand\": \"VISA\",\n \"card_type\": \"CREDIT\",\n \"cardholder_name\": \"Amelia Earhart\",\n \"customer_id\": \"VDKXEEKPJN48QDG3BGGFAK05P8\",\n \"enabled\": false,\n \"exp_month\": 11,\n \"exp_year\": 2022,\n \"fingerprint\": \"ex-p-cs80EK9Flz7LsCMv-szbptQ_ssAGrhemzSTsPFgt9nzyE6t7okiLIQc-qw_quqKX4Q\",\n \"id\": \"ccof:uIbfJXhXETSP197M3GB\",\n \"last_4\": \"1111\",\n \"prepaid_type\": \"NOT_PREPAID\",\n \"reference_id\": \"user-id-1\",\n \"version\": 2\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "ce7a94a8-2e9f-47ed-87e6-8829fbd743f8", "documentation": "ListCashDrawerShifts", "method": "get", "endpoint": "v2/cash-drawers/shifts", "responses": [ { "uuid": "9e1a555c-95d5-41a1-a374-2e487e5c0068", "body": "{\n \"items\": [\n {\n \"closed_at\": \"2019-11-22T00:44:49.000Z\",\n \"closed_cash_money\": {\n \"amount\": 9970,\n \"currency\": \"USD\"\n },\n \"description\": \"Misplaced some change\",\n \"ended_at\": \"2019-11-22T00:44:49.000Z\",\n \"expected_cash_money\": {\n \"amount\": 10000,\n \"currency\": \"USD\"\n },\n \"id\": \"DCC99978-09A6-4926-849F-300BE9C5793A\",\n \"opened_at\": \"2019-11-22T00:42:54.000Z\",\n \"opened_cash_money\": {\n \"amount\": 10000,\n \"currency\": \"USD\"\n },\n \"state\": \"CLOSED\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "072637d1-c00a-4665-a452-e5e40c78e6ec", "documentation": "RetrieveCashDrawerShift", "method": "get", "endpoint": "v2/cash-drawers/shifts/:shift_id", "responses": [ { "uuid": "fb08ef98-d50b-404a-989b-55cc8d85a6a4", "body": "{\n \"cash_drawer_shift\": {\n \"cash_paid_in_money\": {\n \"amount\": 10000,\n \"currency\": \"USD\"\n },\n \"cash_paid_out_money\": {\n \"amount\": -10000,\n \"currency\": \"USD\"\n },\n \"cash_payment_money\": {\n \"amount\": 100,\n \"currency\": \"USD\"\n },\n \"cash_refunds_money\": {\n \"amount\": -100,\n \"currency\": \"USD\"\n },\n \"closed_at\": \"2019-11-22T00:44:49.000Z\",\n \"closed_cash_money\": {\n \"amount\": 9970,\n \"currency\": \"USD\"\n },\n \"closing_employee_id\": \"\",\n \"description\": \"Misplaced some change\",\n \"device\": {\n \"name\": \"My iPad\"\n },\n \"ended_at\": \"2019-11-22T00:44:49.000Z\",\n \"ending_employee_id\": \"\",\n \"expected_cash_money\": {\n \"amount\": 10000,\n \"currency\": \"USD\"\n },\n \"id\": \"DCC99978-09A6-4926-849F-300BE9C5793A\",\n \"opened_at\": \"2019-11-22T00:42:54.000Z\",\n \"opened_cash_money\": {\n \"amount\": 10000,\n \"currency\": \"USD\"\n },\n \"opening_employee_id\": \"\",\n \"state\": \"CLOSED\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "a560e012-eb30-41e2-89cd-86204e152d02", "documentation": "ListCashDrawerShiftEvents", "method": "get", "endpoint": "v2/cash-drawers/shifts/:shift_id/events", "responses": [ { "uuid": "bed13d5c-1f03-48fa-9e36-1b93d2e66ceb", "body": "{\n \"events\": [\n {\n \"created_at\": \"2019-11-22T00:43:02.000Z\",\n \"description\": \"\",\n \"event_money\": {\n \"amount\": 100,\n \"currency\": \"USD\"\n },\n \"event_type\": \"CASH_TENDER_PAYMENT\",\n \"id\": \"9F07DB01-D85A-4B77-88C3-D5C64CEB5155\"\n },\n {\n \"created_at\": \"2019-11-22T00:43:12.000Z\",\n \"description\": \"\",\n \"event_money\": {\n \"amount\": 250,\n \"currency\": \"USD\"\n },\n \"event_type\": \"CASH_TENDER_PAYMENT\",\n \"id\": \"B2854CEA-A781-49B3-8F31-C64558231F48\"\n },\n {\n \"created_at\": \"2019-11-22T00:43:23.000Z\",\n \"description\": \"\",\n \"event_money\": {\n \"amount\": 250,\n \"currency\": \"USD\"\n },\n \"event_type\": \"CASH_TENDER_CANCELLED_PAYMENT\",\n \"id\": \"B5FB7F72-95CD-44A3-974D-26C41064D042\"\n },\n {\n \"created_at\": \"2019-11-22T00:43:46.000Z\",\n \"description\": \"\",\n \"event_money\": {\n \"amount\": 100,\n \"currency\": \"USD\"\n },\n \"event_type\": \"CASH_TENDER_REFUND\",\n \"id\": \"0B425480-8504-40B4-A867-37B23543931B\"\n },\n {\n \"created_at\": \"2019-11-22T00:44:18.000Z\",\n \"description\": \"Transfer from another drawer\",\n \"event_money\": {\n \"amount\": 10000,\n \"currency\": \"USD\"\n },\n \"event_type\": \"PAID_IN\",\n \"id\": \"8C66E60E-FDCF-4EEF-A98D-3B14B7ED5CBE\"\n },\n {\n \"created_at\": \"2019-11-22T00:44:29.000Z\",\n \"description\": \"Transfer out to another drawer\",\n \"event_money\": {\n \"amount\": 10000,\n \"currency\": \"USD\"\n },\n \"event_type\": \"PAID_OUT\",\n \"id\": \"D5ACA7FE-C64D-4ADA-8BC8-82118A2DAE4F\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "01e04f7f-42c4-4e3c-bf56-2fe1343c856a", "documentation": "BatchDeleteCatalogObjects", "method": "post", "endpoint": "v2/catalog/batch-delete", "responses": [ { "uuid": "a5216a5c-1392-45b0-bc26-7e0f4141334a", "body": "{\n \"deleted_at\": \"2016-11-16T22:25:24.878Z\",\n \"deleted_object_ids\": [\n \"W62UWFY35CWMYGVWK6TWJDNI\",\n \"AA27W3M2GGTF3H6AVPNB77CK\"\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "3fffcdf9-b29a-43cc-bdef-1b4c351fae3e", "documentation": "BatchRetrieveCatalogObjects", "method": "post", "endpoint": "v2/catalog/batch-retrieve", "responses": [ { "uuid": "581b6f4b-de57-4c6b-a3fa-25fcdba08c11", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "2e090b32-1803-4ebe-b1ce-66bfe29a9e92", "documentation": "BatchUpsertCatalogObjects", "method": "post", "endpoint": "v2/catalog/batch-upsert", "responses": [ { "uuid": "8ebca0ae-5dcf-4e45-a48d-381d0045fc66", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "c792782f-9b7c-475b-baeb-e610f8842b70", "documentation": "CatalogInfo", "method": "get", "endpoint": "v2/catalog/info", "responses": [ { "uuid": "68d17830-b3ea-4289-85b7-906cf9d88386", "body": "{\n \"limits\": {\n \"batch_delete_max_object_ids\": 200,\n \"batch_retrieve_max_object_ids\": 1000,\n \"batch_upsert_max_objects_per_batch\": 1000,\n \"batch_upsert_max_total_objects\": 10000,\n \"search_max_page_limit\": 1000,\n \"update_item_modifier_lists_max_item_ids\": 1000,\n \"update_item_modifier_lists_max_modifier_lists_to_disable\": 1000,\n \"update_item_modifier_lists_max_modifier_lists_to_enable\": 1000,\n \"update_item_taxes_max_item_ids\": 1000,\n \"update_item_taxes_max_taxes_to_disable\": 1000,\n \"update_item_taxes_max_taxes_to_enable\": 1000\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "bdb60d8e-95a4-4d2a-b4e8-0ac40eb4f720", "documentation": "ListCatalog", "method": "get", "endpoint": "v2/catalog/list", "responses": [ { "uuid": "a85dc041-a726-4dac-ae94-9fda0b842f54", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "d43fdd62-eeea-4da6-92be-7a5362d259c0", "documentation": "UpsertCatalogObject", "method": "post", "endpoint": "v2/catalog/object", "responses": [ { "uuid": "32379d9a-0aef-422c-8d59-d396b5d7fb73", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "753b3a2f-9a6e-4381-bd87-11408bd93fcf", "documentation": "DeleteCatalogObject", "method": "delete", "endpoint": "v2/catalog/object/:object_id", "responses": [ { "uuid": "1772afa9-92d6-4e20-8876-adf887e78b45", "body": "{\n \"deleted_at\": \"2016-11-16T22:25:24.878Z\",\n \"deleted_object_ids\": [\n \"7SB3ZQYJ5GDMVFL7JK46JCHT\",\n \"KQLFFHA6K6J3YQAQAWDQAL57\"\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "2a5cb2fa-cf24-4af2-adbc-51d9b2d89933", "documentation": "RetrieveCatalogObject", "method": "get", "endpoint": "v2/catalog/object/:object_id", "responses": [ { "uuid": "2cc8d786-9a55-475a-bf23-b4787ba3effb", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "7bc3150c-8470-4825-8fff-772b9b0bea92", "documentation": "SearchCatalogObjects", "method": "post", "endpoint": "v2/catalog/search", "responses": [ { "uuid": "c6f83937-4748-4966-9b9a-c011ebd8c0f3", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "df8b2f50-132c-436b-ad8d-9fdbc3c10a77", "documentation": "SearchCatalogItems", "method": "post", "endpoint": "v2/catalog/search-catalog-items", "responses": [ { "uuid": "6f1c79d5-a8dd-49eb-b83d-9d7bf4dd2927", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "4c364e60-41f2-42df-9d45-3d34a05e6b24", "documentation": "UpdateItemModifierLists", "method": "post", "endpoint": "v2/catalog/update-item-modifier-lists", "responses": [ { "uuid": "e277bc1b-88d8-4e25-bade-608a394dd262", "body": "{\n \"updated_at\": \"2016-11-16T22:25:24.878Z\"\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "7869f3d5-21f8-4dc7-bb71-e15679440afe", "documentation": "UpdateItemTaxes", "method": "post", "endpoint": "v2/catalog/update-item-taxes", "responses": [ { "uuid": "3b0dffb4-27aa-4f44-adf7-cf199dc70e71", "body": "{\n \"updated_at\": \"2016-11-16T22:25:24.878Z\"\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "08b44c08-155d-457b-96d2-53137177711e", "documentation": "ListCustomers", "method": "get", "endpoint": "v2/customers", "responses": [ { "uuid": "da1840e5-45af-4261-a5f8-d97a4ec4ad52", "body": "{\n \"customers\": [\n {\n \"address\": {\n \"address_line_1\": \"500 Electric Ave\",\n \"address_line_2\": \"Suite 600\",\n \"administrative_district_level_1\": \"NY\",\n \"country\": \"US\",\n \"locality\": \"New York\",\n \"postal_code\": \"10003\"\n },\n \"created_at\": \"2016-03-23T20:21:54.859Z\",\n \"creation_source\": \"THIRD_PARTY\",\n \"email_address\": \"Amelia.Earhart@example.com\",\n \"family_name\": \"Earhart\",\n \"given_name\": \"Amelia\",\n \"group_ids\": [\n \"545AXB44B4XXWMVQ4W8SBT3HHF\"\n ],\n \"id\": \"JDKYHBWT1D4F8MFH63DBMEN8Y4\",\n \"note\": \"a customer\",\n \"phone_number\": \"1-212-555-4240\",\n \"preferences\": {\n \"email_unsubscribed\": false\n },\n \"reference_id\": \"YOUR_REFERENCE_ID\",\n \"segment_ids\": [\n \"1KB9JE5EGJXCW.REACHABLE\"\n ],\n \"updated_at\": \"2016-03-23T20:21:55Z\",\n \"version\": 1\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "809e2dd0-246f-431e-8506-c3773d907902", "documentation": "CreateCustomer", "method": "post", "endpoint": "v2/customers", "responses": [ { "uuid": "f174e159-0a47-4712-97ed-5a9d997bb9f8", "body": "{\n \"customer\": {\n \"address\": {\n \"address_line_1\": \"500 Electric Ave\",\n \"address_line_2\": \"Suite 600\",\n \"administrative_district_level_1\": \"NY\",\n \"country\": \"US\",\n \"locality\": \"New York\",\n \"postal_code\": \"10003\"\n },\n \"created_at\": \"2016-03-23T20:21:54.859Z\",\n \"creation_source\": \"THIRD_PARTY\",\n \"email_address\": \"Amelia.Earhart@example.com\",\n \"family_name\": \"Earhart\",\n \"given_name\": \"Amelia\",\n \"id\": \"JDKYHBWT1D4F8MFH63DBMEN8Y4\",\n \"note\": \"a customer\",\n \"phone_number\": \"1-212-555-4240\",\n \"preferences\": {\n \"email_unsubscribed\": false\n },\n \"reference_id\": \"YOUR_REFERENCE_ID\",\n \"updated_at\": \"2016-03-23T20:21:54.859Z\",\n \"version\": 0\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "95f4006b-897f-4e2d-9290-92d3aa691dea", "documentation": "ListCustomerGroups", "method": "get", "endpoint": "v2/customers/groups", "responses": [ { "uuid": "1582719b-d27e-4b4f-8fd5-559fefac818f", "body": "{\n \"groups\": [\n {\n \"created_at\": \"2020-04-13T21:54:57.863Z\",\n \"id\": \"2TAT3CMH4Q0A9M87XJZED0WMR3\",\n \"name\": \"Loyal Customers\",\n \"updated_at\": \"2020-04-13T21:54:58Z\"\n },\n {\n \"created_at\": \"2020-04-13T21:55:18.795Z\",\n \"id\": \"4XMEHESXJBNE9S9JAKZD2FGB14\",\n \"name\": \"Super Loyal Customers\",\n \"updated_at\": \"2020-04-13T21:55:19Z\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "2a0c3be7-a38c-4077-b78b-7e93648799d4", "documentation": "CreateCustomerGroup", "method": "post", "endpoint": "v2/customers/groups", "responses": [ { "uuid": "ccefa48f-f26c-4933-9cdb-4161f5486536", "body": "{\n \"group\": {\n \"created_at\": \"2020-04-13T21:54:57.863Z\",\n \"id\": \"2TAT3CMH4Q0A9M87XJZED0WMR3\",\n \"name\": \"Loyal Customers\",\n \"updated_at\": \"2020-04-13T21:54:58Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "53cfcf3a-6a91-4a79-b83e-421f12e0af77", "documentation": "DeleteCustomerGroup", "method": "delete", "endpoint": "v2/customers/groups/:group_id", "responses": [ { "uuid": "6e24dfa9-6d1a-4b4a-b8e0-305c93da4d86", "body": "{}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "7a10a764-f19b-4333-a4d8-5ccef76fedb3", "documentation": "RetrieveCustomerGroup", "method": "get", "endpoint": "v2/customers/groups/:group_id", "responses": [ { "uuid": "600010f4-27a0-4874-9ffe-93e4cdbf84b5", "body": "{\n \"group\": {\n \"created_at\": \"2020-04-13T21:54:57.863Z\",\n \"id\": \"2TAT3CMH4Q0A9M87XJZED0WMR3\",\n \"name\": \"Loyal Customers\",\n \"updated_at\": \"2020-04-13T21:54:58Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "48347585-e98d-498e-a050-c29e0b66b9ee", "documentation": "UpdateCustomerGroup", "method": "put", "endpoint": "v2/customers/groups/:group_id", "responses": [ { "uuid": "e930e0ab-e5ad-4deb-ba45-0803b991a52e", "body": "{\n \"group\": {\n \"created_at\": \"2020-04-13T21:54:57.863Z\",\n \"id\": \"2TAT3CMH4Q0A9M87XJZED0WMR3\",\n \"name\": \"Loyal Customers\",\n \"updated_at\": \"2020-04-13T21:54:58Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "3c085c8a-a9eb-4ac4-8cad-f5ef92335101", "documentation": "SearchCustomers", "method": "post", "endpoint": "v2/customers/search", "responses": [ { "uuid": "ba63a829-f1c4-4b62-b0d6-d06e37f1aab6", "body": "{\n \"cursor\": \"9dpS093Uy12AzeE\",\n \"customers\": [\n {\n \"address\": {\n \"address_line_1\": \"505 Electric Ave\",\n \"address_line_2\": \"Suite 600\",\n \"administrative_district_level_1\": \"NY\",\n \"country\": \"US\",\n \"locality\": \"New York\",\n \"postal_code\": \"10003\"\n },\n \"created_at\": \"2018-01-23T20:21:54.859Z\",\n \"creation_source\": \"DIRECTORY\",\n \"email_address\": \"james.bond@example.com\",\n \"family_name\": \"Bond\",\n \"given_name\": \"James\",\n \"group_ids\": [\n \"545AXB44B4XXWMVQ4W8SBT3HHF\"\n ],\n \"id\": \"JDKYHBWT1D4F8MFH63DBMEN8Y4\",\n \"phone_number\": \"1-212-555-4250\",\n \"preferences\": {\n \"email_unsubscribed\": false\n },\n \"reference_id\": \"YOUR_REFERENCE_ID_2\",\n \"segment_ids\": [\n \"1KB9JE5EGJXCW.REACHABLE\"\n ],\n \"updated_at\": \"2020-04-20T10:02:43.083Z\",\n \"version\": 7\n },\n {\n \"address\": {\n \"address_line_1\": \"500 Electric Ave\",\n \"address_line_2\": \"Suite 600\",\n \"administrative_district_level_1\": \"NY\",\n \"country\": \"US\",\n \"locality\": \"New York\",\n \"postal_code\": \"10003\"\n },\n \"created_at\": \"2018-01-30T14:10:54.859Z\",\n \"creation_source\": \"THIRD_PARTY\",\n \"email_address\": \"amelia.earhart@example.com\",\n \"family_name\": \"Earhart\",\n \"given_name\": \"Amelia\",\n \"group_ids\": [\n \"545AXB44B4XXWMVQ4W8SBT3HHF\"\n ],\n \"id\": \"JDKYHBWT1D4F8MFH63DBMEN8Y4\",\n \"note\": \"a customer\",\n \"phone_number\": \"1-212-555-4240\",\n \"preferences\": {\n \"email_unsubscribed\": false\n },\n \"reference_id\": \"YOUR_REFERENCE_ID_1\",\n \"segment_ids\": [\n \"1KB9JE5EGJXCW.REACHABLE\"\n ],\n \"updated_at\": \"2018-03-08T18:25:21.342Z\",\n \"version\": 1\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "6e2b03a4-dbf8-44bc-b325-a2951d27789c", "documentation": "ListCustomerSegments", "method": "get", "endpoint": "v2/customers/segments", "responses": [ { "uuid": "ed66bf7b-38db-4de7-b047-fccbd936ac44", "body": "{\n \"segments\": [\n {\n \"created_at\": \"2020-01-09T19:33:24.469Z\",\n \"id\": \"GMNXRZVEXNQDF.CHURN_RISK\",\n \"name\": \"Lapsed\",\n \"updated_at\": \"2020-04-13T21:47:04Z\"\n },\n {\n \"created_at\": \"2020-01-09T19:33:24.486Z\",\n \"id\": \"GMNXRZVEXNQDF.LOYAL\",\n \"name\": \"Regulars\",\n \"updated_at\": \"2020-04-13T21:47:04Z\"\n },\n {\n \"created_at\": \"2020-01-09T19:33:21.813Z\",\n \"id\": \"GMNXRZVEXNQDF.REACHABLE\",\n \"name\": \"Reachable\",\n \"updated_at\": \"2020-04-13T21:47:04Z\"\n },\n {\n \"created_at\": \"2020-01-09T19:33:25Z\",\n \"id\": \"gv2:KF92J19VXN5FK30GX2E8HSGQ20\",\n \"name\": \"Instant Profile\",\n \"updated_at\": \"2020-04-13T23:01:03Z\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "396335d5-1ccd-4f42-9873-2576e4072e3d", "documentation": "RetrieveCustomerSegment", "method": "get", "endpoint": "v2/customers/segments/:segment_id", "responses": [ { "uuid": "4eabbd7a-8b65-4ea3-a457-e5ea54f58b6f", "body": "{\n \"segment\": {\n \"created_at\": \"2020-01-09T19:33:24.469Z\",\n \"id\": \"GMNXRZVEXNQDF.CHURN_RISK\",\n \"name\": \"Lapsed\",\n \"updated_at\": \"2020-04-13T23:01:13Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "efde1627-c3e4-4456-8fcf-a39f45a619ad", "documentation": "DeleteCustomer", "method": "delete", "endpoint": "v2/customers/:customer_id", "responses": [ { "uuid": "16d89cc8-9647-4d98-bb3b-fc34128d7803", "body": "{}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "2025a073-4820-46ef-ba4e-56220d97b2b3", "documentation": "RetrieveCustomer", "method": "get", "endpoint": "v2/customers/:customer_id", "responses": [ { "uuid": "d5a99549-ea96-4180-a5de-c9c54c043e18", "body": "{\n \"customer\": {\n \"address\": {\n \"address_line_1\": \"500 Electric Ave\",\n \"address_line_2\": \"Suite 600\",\n \"administrative_district_level_1\": \"NY\",\n \"country\": \"US\",\n \"locality\": \"New York\",\n \"postal_code\": \"10003\"\n },\n \"created_at\": \"2016-03-23T20:21:54.859Z\",\n \"creation_source\": \"THIRD_PARTY\",\n \"email_address\": \"Amelia.Earhart@example.com\",\n \"family_name\": \"Earhart\",\n \"given_name\": \"Amelia\",\n \"group_ids\": [\n \"545AXB44B4XXWMVQ4W8SBT3HHF\"\n ],\n \"id\": \"JDKYHBWT1D4F8MFH63DBMEN8Y4\",\n \"note\": \"a customer\",\n \"phone_number\": \"1-212-555-4240\",\n \"preferences\": {\n \"email_unsubscribed\": false\n },\n \"reference_id\": \"YOUR_REFERENCE_ID\",\n \"segment_ids\": [\n \"1KB9JE5EGJXCW.REACHABLE\"\n ],\n \"updated_at\": \"2016-03-23T20:21:54.859Z\",\n \"version\": 1\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "7ed9d55b-7c70-4dff-a52f-b4ada7ce415c", "documentation": "UpdateCustomer", "method": "put", "endpoint": "v2/customers/:customer_id", "responses": [ { "uuid": "624648e2-707a-4379-a586-62d140fc98c5", "body": "{\n \"customer\": {\n \"address\": {\n \"address_line_1\": \"500 Electric Ave\",\n \"address_line_2\": \"Suite 600\",\n \"administrative_district_level_1\": \"NY\",\n \"country\": \"US\",\n \"locality\": \"New York\",\n \"postal_code\": \"10003\"\n },\n \"created_at\": \"2016-03-23T20:21:54.859Z\",\n \"creation_source\": \"THIRD_PARTY\",\n \"email_address\": \"New.Amelia.Earhart@example.com\",\n \"family_name\": \"Earhart\",\n \"given_name\": \"Amelia\",\n \"id\": \"JDKYHBWT1D4F8MFH63DBMEN8Y4\",\n \"note\": \"updated customer note\",\n \"preferences\": {\n \"email_unsubscribed\": false\n },\n \"reference_id\": \"YOUR_REFERENCE_ID\",\n \"updated_at\": \"2016-05-15T20:21:55Z\",\n \"version\": 3\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "6cbbaf04-4036-4c4f-890f-931431e15141", "documentation": "CreateCustomerCard", "method": "post", "endpoint": "v2/customers/:customer_id/cards", "responses": [ { "uuid": "934bdd41-edea-4784-b8d4-973ec471be38", "body": "{\n \"card\": {\n \"billing_address\": {\n \"address_line_1\": \"500 Electric Ave\",\n \"address_line_2\": \"Suite 600\",\n \"administrative_district_level_1\": \"NY\",\n \"country\": \"US\",\n \"locality\": \"New York\",\n \"postal_code\": \"10003\"\n },\n \"card_brand\": \"VISA\",\n \"cardholder_name\": \"Amelia Earhart\",\n \"exp_month\": 11,\n \"exp_year\": 2018,\n \"id\": \"icard-card_id\",\n \"last_4\": \"1111\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "9d9b3f08-3cf9-4729-bbe8-90b09b0730c9", "documentation": "DeleteCustomerCard", "method": "delete", "endpoint": "v2/customers/:customer_id/cards/:card_id", "responses": [ { "uuid": "22f7c847-48f9-4f95-be1e-a8591e051bca", "body": "{}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "78de6941-ada2-4817-b878-91f75ce3d964", "documentation": "RemoveGroupFromCustomer", "method": "delete", "endpoint": "v2/customers/:customer_id/groups/:group_id", "responses": [ { "uuid": "e40a29cc-8ff9-4d9b-8c8f-ef2391b2bc6a", "body": "{}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "989b4a86-1efc-4ac9-9d79-fab03489c86f", "documentation": "AddGroupToCustomer", "method": "put", "endpoint": "v2/customers/:customer_id/groups/:group_id", "responses": [ { "uuid": "c3f696d7-ec77-48d2-b976-4c8a83577ad6", "body": "{}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "db654a38-8a7c-4f13-a06f-1c36f90360ae", "documentation": "ListDeviceCodes", "method": "get", "endpoint": "v2/devices/codes", "responses": [ { "uuid": "b6e83236-2c8f-4906-8324-9f758f88a855", "body": "{\n \"device_codes\": [\n {\n \"code\": \"EBCARJ\",\n \"created_at\": \"2020-02-06T18:44:33.000Z\",\n \"device_id\": \"907CS13101300122\",\n \"id\": \"B3Z6NAMYQSMTM\",\n \"location_id\": \"B5E4484SHHNYH\",\n \"name\": \"Counter 1\",\n \"pair_by\": \"2020-02-06T18:49:33.000Z\",\n \"product_type\": \"TERMINAL_API\",\n \"status\": \"PAIRED\",\n \"status_changed_at\": \"2020-02-06T18:47:28.000Z\"\n },\n {\n \"code\": \"GVXNYN\",\n \"created_at\": \"2020-02-07T19:55:04.000Z\",\n \"id\": \"YKGMJMYK8H4PQ\",\n \"location_id\": \"A6SYFRSV4WAFW\",\n \"name\": \"Unused device code\",\n \"pair_by\": \"2020-02-07T20:00:04.000Z\",\n \"product_type\": \"TERMINAL_API\",\n \"status\": \"UNPAIRED\",\n \"status_changed_at\": \"2020-02-07T19:55:04.000Z\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "628e8f4e-7945-4e7b-b95b-878c7c03d9bb", "documentation": "CreateDeviceCode", "method": "post", "endpoint": "v2/devices/codes", "responses": [ { "uuid": "4954efdb-6efb-4959-b949-4caa95022ede", "body": "{\n \"device_code\": {\n \"code\": \"EBCARJ\",\n \"created_at\": \"2020-02-06T18:44:33.000Z\",\n \"id\": \"B3Z6NAMYQSMTM\",\n \"location_id\": \"B5E4484SHHNYH\",\n \"name\": \"Counter 1\",\n \"pair_by\": \"2020-02-06T18:49:33.000Z\",\n \"product_type\": \"TERMINAL_API\",\n \"status\": \"UNPAIRED\",\n \"status_changed_at\": \"2020-02-06T18:44:33.000Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "a2f318b0-2e8e-4bf8-bedc-749264462137", "documentation": "GetDeviceCode", "method": "get", "endpoint": "v2/devices/codes/:id", "responses": [ { "uuid": "a6db7494-ef44-4c9a-8bfc-dd593a1dbc3b", "body": "{\n \"device_code\": {\n \"code\": \"EBCARJ\",\n \"created_at\": \"2020-02-06T18:44:33.000Z\",\n \"device_id\": \"907CS13101300122\",\n \"id\": \"B3Z6NAMYQSMTM\",\n \"location_id\": \"B5E4484SHHNYH\",\n \"name\": \"Counter 1\",\n \"pair_by\": \"2020-02-06T18:49:33.000Z\",\n \"product_type\": \"TERMINAL_API\",\n \"status\": \"PAIRED\",\n \"status_changed_at\": \"2020-02-06T18:47:28.000Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "aff5a02a-c06c-43d1-b5b0-3c02d0543943", "documentation": "ListDisputes", "method": "get", "endpoint": "v2/disputes", "responses": [ { "uuid": "f289b9f0-46c1-4325-b5d4-c2574e58ff4b", "body": "{\n \"cursor\": \"G1aSTRm48CLjJsg6Sg3hQN1b1OMaoVuG\",\n \"disputes\": [\n {\n \"amount_money\": {\n \"amount\": 1000,\n \"currency\": \"USD\"\n },\n \"brand_dispute_id\": \"100000809947\",\n \"card_brand\": \"VISA\",\n \"created_at\": \"2018-10-12T02:20:25.577Z\",\n \"disputed_payments\": [\n {\n \"payment_id\": \"APgIq6RX2jM6DKDhMHiC6QEkuaB\"\n }\n ],\n \"due_at\": \"2018-10-11T00:00:00.000Z\",\n \"id\": \"OnY1AZwhSi775rbNIK4gv\",\n \"reason\": \"NO_KNOWLEDGE\",\n \"state\": \"EVIDENCE_REQUIRED\",\n \"updated_at\": \"2018-10-12T02:20:25.577Z\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "4932588a-73b8-4e38-b15c-49a64a4df65d", "documentation": "RetrieveDispute", "method": "get", "endpoint": "v2/disputes/:dispute_id", "responses": [ { "uuid": "7be4e546-106e-4ab4-98fc-044d986c0192", "body": "{\n \"dispute\": {\n \"amount_money\": {\n \"amount\": 2000,\n \"currency\": \"USD\"\n },\n \"brand_dispute_id\": \"100000282394\",\n \"card_brand\": \"VISA\",\n \"created_at\": \"2018-10-18T15:59:13.613Z\",\n \"disputed_payments\": [\n {\n \"payment_id\": \"6Ee10wvqhfipStz297mtUhBXvaB\"\n }\n ],\n \"due_at\": \"2018-11-01T00:00:00.000Z\",\n \"id\": \"XDgyFu7yo1E2S5lQGGpYn\",\n \"reason\": \"NO_KNOWLEDGE\",\n \"state\": \"LOST\",\n \"updated_at\": \"2018-10-18T15:59:13.613Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "17393c0b-7af5-44c4-90ae-6a083c0f63c7", "documentation": "AcceptDispute", "method": "post", "endpoint": "v2/disputes/:dispute_id/accept", "responses": [ { "uuid": "1b5cb25e-c9c3-4174-bfa8-c54d68b024a7", "body": "{\n \"dispute\": {\n \"amount_money\": {\n \"amount\": 2000,\n \"currency\": \"USD\"\n },\n \"brand_dispute_id\": \"100000282394\",\n \"card_brand\": \"VISA\",\n \"created_at\": \"2018-10-18T15:59:13.613Z\",\n \"disputed_payments\": [\n {\n \"payment_id\": \"6Ee10wvqhfipStz297mtUhBXvaB\"\n }\n ],\n \"due_at\": \"2018-11-01T00:00:00.000Z\",\n \"id\": \"XDgyFu7yo1E2S5lQGGpYn\",\n \"reason\": \"NO_KNOWLEDGE\",\n \"state\": \"LOST\",\n \"updated_at\": \"2018-10-18T15:59:13.613Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "ffe414d3-ea93-49d8-a982-cc4c2fad2ffe", "documentation": "ListDisputeEvidence", "method": "get", "endpoint": "v2/disputes/:dispute_id/evidence", "responses": [ { "uuid": "10284a48-a5ad-4801-96b9-2b8796fc03f1", "body": "{\n \"cursor\": \"G1aSTRm48CLjJsg6Sg3hQN1b1OMaoVuG\",\n \"evidence\": [\n {\n \"dispute_id\": \"bVTprrwk0gygTLZ96VX1oB\",\n \"evidence_text\": \"1Z8888888888888888\",\n \"evidence_type\": \"TRACKING_NUMBER\",\n \"id\": \"TOomLInj6iWmP3N8qfCXrB\",\n \"uploaded_at\": \"2018-10-18T16:01:10.000Z\"\n },\n {\n \"dispute_id\": \"bVTprrwk0gygTLZ96VX1oB\",\n \"evidence_file\": {\n \"filename\": \"evidence.tiff\",\n \"filetype\": \"image/tiff\"\n },\n \"evidence_id\": \"TOomLInj6iWmP3N8qfCXrB\",\n \"evidence_type\": \"GENERIC_EVIDENCE\",\n \"uploaded_at\": \"2018-10-18T16:01:10.000Z\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "d483a4b3-1ae7-44ba-8541-e1ed1e6e01f3", "documentation": "CreateDisputeEvidenceText", "method": "post", "endpoint": "v2/disputes/:dispute_id/evidence-text", "responses": [ { "uuid": "bbfa1dd2-d30b-4010-832f-1dec0b38748e", "body": "{\n \"evidence\": {\n \"dispute_id\": \"bVTprrwk0gygTLZ96VX1oB\",\n \"evidence_text\": \"1Z8888888888888888\",\n \"evidence_type\": \"TRACKING_NUMBER\",\n \"id\": \"TOomLInj6iWmP3N8qfCXrB\",\n \"uploaded_at\": \"2018-10-18T16:01:10.000Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "ce677e56-5a0d-4b0e-8f7e-3d452b5416a6", "documentation": "DeleteDisputeEvidence", "method": "delete", "endpoint": "v2/disputes/:dispute_id/evidence/:evidence_id", "responses": [ { "uuid": "8a8c84ab-24df-4d0e-95cc-111caf95c6e3", "body": "{}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "a680595e-3cd9-4e35-8589-16a8135d1651", "documentation": "RetrieveDisputeEvidence", "method": "get", "endpoint": "v2/disputes/:dispute_id/evidence/:evidence_id", "responses": [ { "uuid": "a038c00c-3e86-4b50-9034-e775cfff5803", "body": "{\n \"evidence\": {\n \"dispute_id\": \"bVTprrwk0gygTLZ96VX1oB\",\n \"evidence_file\": {\n \"filename\": \"evidence.tiff\",\n \"filetype\": \"image/tiff\"\n },\n \"evidence_type\": \"GENERIC_EVIDENCE\",\n \"id\": \"TOomLInj6iWmP3N8qfCXrB\",\n \"uploaded_at\": \"2018-10-18T16:01:10.000Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "10e98d5a-3658-43f5-911e-933e0baf8630", "documentation": "SubmitEvidence", "method": "post", "endpoint": "v2/disputes/:dispute_id/submit-evidence", "responses": [ { "uuid": "08cf2dfd-c57c-4b51-b23c-5d5174c406f7", "body": "{\n \"dispute\": {\n \"amount_money\": {\n \"amount\": 2000,\n \"currency\": \"USD\"\n },\n \"brand_dispute_id\": \"100000399240\",\n \"card_brand\": \"VISA\",\n \"created_at\": \"2018-10-18T16:02:15.313Z\",\n \"disputed_payments\": [\n {\n \"payment_id\": \"2yeBUWJzllJTpmnSqtMRAL19taB\"\n }\n ],\n \"due_at\": \"2018-11-01T00:00:00.000Z\",\n \"id\": \"EAZoK70gX3fyvibecLwIGB\",\n \"reason\": \"NO_KNOWLEDGE\",\n \"state\": \"PROCESSING\",\n \"updated_at\": \"2018-10-18T16:02:15.313Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "85668c4f-1459-4461-8cc9-e38ad569667d", "documentation": "ListEmployees", "method": "get", "endpoint": "v2/employees", "responses": [ { "uuid": "c2ca0644-7ba4-4c4a-b594-9f0f5ec8d93e", "body": "{\n \"cursor\": \"\",\n \"employees\": [\n {\n \"created_at\": \"\",\n \"email\": \"\",\n \"first_name\": \"\",\n \"id\": \"\",\n \"is_owner\": {{faker 'random.boolean'}},\n \"last_name\": \"\",\n \"location_ids\": [\n \"\"\n ],\n \"phone_number\": \"\",\n \"status\": \"\",\n \"updated_at\": \"\"\n }\n ],\n \"errors\": [\n {\n \"category\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "e441983e-a522-4b45-9fbf-20f75ff9715a", "documentation": "RetrieveEmployee", "method": "get", "endpoint": "v2/employees/:id", "responses": [ { "uuid": "5fd2932e-636c-46b2-bacf-7165c7f475cb", "body": "{\n \"employee\": {\n \"created_at\": \"\",\n \"email\": \"\",\n \"first_name\": \"\",\n \"id\": \"\",\n \"is_owner\": {{faker 'random.boolean'}},\n \"last_name\": \"\",\n \"location_ids\": [\n \"\"\n ],\n \"phone_number\": \"\",\n \"status\": \"\",\n \"updated_at\": \"\"\n },\n \"errors\": [\n {\n \"category\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "c757c6a2-d83e-4dca-8bb0-2cb89d366f6f", "documentation": "ListGiftCards", "method": "get", "endpoint": "v2/gift-cards", "responses": [ { "uuid": "38856e9c-f9cf-476d-b6c8-43fa9176920e", "body": "{\n \"cursor\": \"JbFmyvUpaNKsfC1hoLSA4WlqkgkZXTWeKuStajR5BkP7OE0ETAbeWSi6U6u7sH\",\n \"gift_cards\": [\n {\n \"balance_money\": {\n \"amount\": 3900,\n \"currency\": \"USD\"\n },\n \"created_at\": \"2021-06-09T22:26:54.000Z\",\n \"gan\": \"7783320008524605\",\n \"gan_source\": \"SQUARE\",\n \"id\": \"gftc:00113070ba5745f0b2377c1b9570cb03\",\n \"state\": \"ACTIVE\",\n \"type\": \"DIGITAL\"\n },\n {\n \"balance_money\": {\n \"amount\": 2000,\n \"currency\": \"USD\"\n },\n \"created_at\": \"2021-05-20T22:26:54.000Z\",\n \"gan\": \"7783320002692465\",\n \"gan_source\": \"SQUARE\",\n \"id\": \"gftc:00128a12725b41e58e0de1d20497a9dd\",\n \"state\": \"ACTIVE\",\n \"type\": \"DIGITAL\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "e74822c6-b55f-4b27-b34e-1f88057a72f5", "documentation": "CreateGiftCard", "method": "post", "endpoint": "v2/gift-cards", "responses": [ { "uuid": "d31cfb76-5fcc-4b53-b2ff-4dcf1ba78166", "body": "{\n \"gift_card\": {\n \"balance_money\": {\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n \"created_at\": \"2021-05-20T22:26:54.000Z\",\n \"gan\": \"7783320006753271\",\n \"gan_source\": \"SQUARE\",\n \"id\": \"gftc:6cbacbb64cf54e2ca9f573d619038059\",\n \"state\": \"PENDING\",\n \"type\": \"DIGITAL\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "f682fce2-c69d-4acd-befb-c65578234177", "documentation": "ListGiftCardActivities", "method": "get", "endpoint": "v2/gift-cards/activities", "responses": [ { "uuid": "ae613425-b849-40ae-a701-5c51a14d9750", "body": "{\n \"gift_card_activities\": [\n {\n \"created_at\": \"2021-06-02T22:26:38.000Z\",\n \"gift_card_balance_money\": {\n \"amount\": 700,\n \"currency\": \"USD\"\n },\n \"gift_card_gan\": \"7783320002929081\",\n \"gift_card_id\": \"gftc:6d55a72470d940c6ba09c0ab8ad08d20\",\n \"id\": \"gcact_897698f894b44b3db46c6147e26a0e19\",\n \"location_id\": \"81FN9BNFZTKS4\",\n \"redeem_activity_details\": {\n \"amount_money\": {\n \"amount\": 300,\n \"currency\": \"USD\"\n }\n },\n \"type\": \"REDEEM\"\n },\n {\n \"activate_activity_details\": {\n \"amount_money\": {\n \"amount\": 1000,\n \"currency\": \"USD\"\n },\n \"line_item_uid\": \"eIWl7X0nMuO9Ewbh0ChIx\",\n \"order_id\": \"jJNGHm4gLI6XkFbwtiSLqK72KkAZY\"\n },\n \"created_at\": \"2021-05-20T22:26:54.000Z\",\n \"gift_card_balance_money\": {\n \"amount\": 1000,\n \"currency\": \"USD\"\n },\n \"gift_card_gan\": \"7783320002929081\",\n \"gift_card_id\": \"gftc:6d55a72470d940c6ba09c0ab8ad08d20\",\n \"id\": \"gcact_b968ebfc7d46437b945be7b9e09123b4\",\n \"location_id\": \"81FN9BNFZTKS4\",\n \"type\": \"ACTIVATE\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "ef269d37-daaa-40fc-99e4-671503af6ec7", "documentation": "CreateGiftCardActivity", "method": "post", "endpoint": "v2/gift-cards/activities", "responses": [ { "uuid": "11c590a6-021f-4865-a869-039a73b79632", "body": "{\n \"gift_card_activity\": {\n \"activate_activity_details\": {\n \"amount_money\": {\n \"amount\": 1000,\n \"currency\": \"USD\"\n },\n \"line_item_uid\": \"eIWl7X0nMuO9Ewbh0ChIx\",\n \"order_id\": \"jJNGHm4gLI6XkFbwtiSLqK72KkAZY\"\n },\n \"created_at\": \"2021-05-20T22:26:54.000Z\",\n \"gift_card_balance_money\": {\n \"amount\": 1000,\n \"currency\": \"USD\"\n },\n \"gift_card_gan\": \"7783320002929081\",\n \"gift_card_id\": \"gftc:6d55a72470d940c6ba09c0ab8ad08d20\",\n \"id\": \"gcact_c8f8cbf1f24b448d8ecf39ed03f97864\",\n \"location_id\": \"81FN9BNFZTKS4\",\n \"type\": \"ACTIVATE\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "99059f0e-ef34-42d1-bf50-fe434c65d273", "documentation": "RetrieveGiftCardFromGAN", "method": "post", "endpoint": "v2/gift-cards/from-gan", "responses": [ { "uuid": "dc7908ea-e8f0-48d7-9786-37c2ccd8e190", "body": "{\n \"gift_card\": {\n \"balance_money\": {\n \"amount\": 5000,\n \"currency\": \"USD\"\n },\n \"created_at\": \"2021-05-20T22:26:54.000Z\",\n \"gan\": \"7783320001001635\",\n \"gan_source\": \"SQUARE\",\n \"id\": \"gftc:6944163553804e439d89adb47caf806a\",\n \"state\": \"ACTIVE\",\n \"type\": \"DIGITAL\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "0769af0e-ec47-4948-a115-6b143d31e1f7", "documentation": "RetrieveGiftCardFromNonce", "method": "post", "endpoint": "v2/gift-cards/from-nonce", "responses": [ { "uuid": "87306012-bd5f-4d32-bc0c-a997f9442a37", "body": "{\n \"gift_card\": {\n \"balance_money\": {\n \"amount\": 5000,\n \"currency\": \"USD\"\n },\n \"created_at\": \"2021-05-20T22:26:54.000Z\",\n \"gan\": \"7783320001001635\",\n \"gan_source\": \"SQUARE\",\n \"id\": \"gftc:6944163553804e439d89adb47caf806a\",\n \"state\": \"ACTIVE\",\n \"type\": \"DIGITAL\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "78374bba-0a5d-4746-9eb7-bb45d97f548b", "documentation": "LinkCustomerToGiftCard", "method": "post", "endpoint": "v2/gift-cards/:gift_card_id/link-customer", "responses": [ { "uuid": "7b4244da-5be8-48f7-b9bf-da3da8b281ba", "body": "{\n \"gift_card\": {\n \"balance_money\": {\n \"amount\": 2500,\n \"currency\": \"USD\"\n },\n \"created_at\": \"2021-03-25T05:13:01Z\",\n \"customer_ids\": [\n \"GKY0FZ3V717AH8Q2D821PNT2ZW\"\n ],\n \"gan\": \"7783320005440920\",\n \"gan_source\": \"SQUARE\",\n \"id\": \"gftc:71ea002277a34f8a945e284b04822edb\",\n \"state\": \"ACTIVE\",\n \"type\": \"DIGITAL\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "fabdbc29-1c93-45ca-aac6-14eb31eb7324", "documentation": "UnlinkCustomerFromGiftCard", "method": "post", "endpoint": "v2/gift-cards/:gift_card_id/unlink-customer", "responses": [ { "uuid": "66e1a11b-1a39-42ef-9219-fec3cac75b90", "body": "{\n \"gift_card\": {\n \"balance_money\": {\n \"amount\": 2500,\n \"currency\": \"USD\"\n },\n \"created_at\": \"2021-03-25T05:13:01Z\",\n \"gan\": \"7783320005440920\",\n \"gan_source\": \"SQUARE\",\n \"id\": \"gftc:71ea002277a34f8a945e284b04822edb\",\n \"state\": \"ACTIVE\",\n \"type\": \"DIGITAL\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "30321da0-334b-4003-b52d-b9abaf65a990", "documentation": "RetrieveGiftCard", "method": "get", "endpoint": "v2/gift-cards/:id", "responses": [ { "uuid": "b6f1e01c-d6ab-4dd8-adba-ab1f36b69ec0", "body": "{\n \"gift_card\": {\n \"balance_money\": {\n \"amount\": 1000,\n \"currency\": \"USD\"\n },\n \"created_at\": \"2021-05-20T22:26:54.000Z\",\n \"gan\": \"7783320001001635\",\n \"gan_source\": \"SQUARE\",\n \"id\": \"gftc:00113070ba5745f0b2377c1b9570cb03\",\n \"state\": \"ACTIVE\",\n \"type\": \"DIGITAL\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "26c4cfd1-8f53-4b37-b435-1baedee17047", "documentation": "DeprecatedRetrieveInventoryAdjustment", "method": "get", "endpoint": "v2/inventory/adjustment/:adjustment_id", "responses": [ { "uuid": "08296ebc-1369-4c80-bf2c-de18ff4fc474", "body": "{\n \"adjustment\": {\n \"catalog_object_id\": \"W62UWFY35CWMYGVWK6TWJDNI\",\n \"catalog_object_type\": \"ITEM_VARIATION\",\n \"created_at\": \"2016-11-17T13:02:15.142Z\",\n \"employee_id\": \"LRK57NSQ5X7PUD05\",\n \"from_state\": \"IN_STOCK\",\n \"id\": \"UDMOEO78BG6GYWA2XDRYX3KB\",\n \"location_id\": \"C6W5YS5QM06F5\",\n \"occurred_at\": \"2016-11-16T25:44:22.837Z\",\n \"quantity\": \"7\",\n \"reference_id\": \"4a366069-4096-47a2-99a5-0084ac879509\",\n \"source\": {\n \"application_id\": \"416ff29c-86c4-4feb-b58c-9705f21f3ea0\",\n \"name\": \"Square Point of Sale 4.37\",\n \"product\": \"SQUARE_POS\"\n },\n \"to_state\": \"SOLD\",\n \"total_price_money\": {\n \"amount\": 4550,\n \"currency\": \"USD\"\n }\n },\n \"errors\": []\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "75558779-81bd-4ce0-802c-78566c132902", "documentation": "RetrieveInventoryAdjustment", "method": "get", "endpoint": "v2/inventory/adjustments/:adjustment_id", "responses": [ { "uuid": "df7a805a-7bf3-476f-89d9-84402914aa19", "body": "{\n \"adjustment\": {\n \"catalog_object_id\": \"W62UWFY35CWMYGVWK6TWJDNI\",\n \"catalog_object_type\": \"ITEM_VARIATION\",\n \"created_at\": \"2016-11-17T13:02:15.142Z\",\n \"employee_id\": \"LRK57NSQ5X7PUD05\",\n \"from_state\": \"IN_STOCK\",\n \"id\": \"UDMOEO78BG6GYWA2XDRYX3KB\",\n \"location_id\": \"C6W5YS5QM06F5\",\n \"occurred_at\": \"2016-11-16T25:44:22.837Z\",\n \"quantity\": \"7\",\n \"reference_id\": \"4a366069-4096-47a2-99a5-0084ac879509\",\n \"source\": {\n \"application_id\": \"416ff29c-86c4-4feb-b58c-9705f21f3ea0\",\n \"name\": \"Square Point of Sale 4.37\",\n \"product\": \"SQUARE_POS\"\n },\n \"to_state\": \"SOLD\",\n \"total_price_money\": {\n \"amount\": 4550,\n \"currency\": \"USD\"\n }\n },\n \"errors\": []\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "e45258d0-5d9d-4c7f-ac1c-c36cf8ff48c4", "documentation": "DeprecatedBatchChangeInventory", "method": "post", "endpoint": "v2/inventory/batch-change", "responses": [ { "uuid": "766bd6eb-9027-4401-9e5f-1e008d13de3b", "body": "{\n \"counts\": [\n {\n \"calculated_at\": \"2016-11-16T22:28:01.223Z\",\n \"catalog_object_id\": \"W62UWFY35CWMYGVWK6TWJDNI\",\n \"catalog_object_type\": \"ITEM_VARIATION\",\n \"location_id\": \"C6W5YS5QM06F5\",\n \"quantity\": \"53\",\n \"state\": \"IN_STOCK\"\n }\n ],\n \"errors\": []\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "079fa895-9064-4a3d-848a-9a59f5c8ac64", "documentation": "DeprecatedBatchRetrieveInventoryChanges", "method": "post", "endpoint": "v2/inventory/batch-retrieve-changes", "responses": [ { "uuid": "da2bfd61-4b6f-456a-ad77-adb517625920", "body": "{\n \"changes\": [\n {\n \"physical_count\": {\n \"catalog_object_id\": \"W62UWFY35CWMYGVWK6TWJDNI\",\n \"catalog_object_type\": \"ITEM_VARIATION\",\n \"created_at\": \"2016-11-16T22:25:24.878Z\",\n \"employee_id\": \"LRK57NSQ5X7PUD05\",\n \"id\": \"46YDTW253DWGGK9HMAE6XCAO\",\n \"location_id\": \"C6W5YS5QM06F5\",\n \"occurred_at\": \"2016-11-16T22:24:49.028Z\",\n \"quantity\": \"86\",\n \"reference_id\": \"22c07cf4-5626-4224-89f9-691112019399\",\n \"source\": {\n \"application_id\": \"416ff29c-86c4-4feb-b58c-9705f21f3ea0\",\n \"name\": \"Square Point of Sale 4.37\",\n \"product\": \"SQUARE_POS\"\n },\n \"state\": \"IN_STOCK\"\n },\n \"type\": \"PHYSICAL_COUNT\"\n }\n ],\n \"errors\": []\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "0eb39102-0f7c-4836-b33d-466a2d707f75", "documentation": "DeprecatedBatchRetrieveInventoryCounts", "method": "post", "endpoint": "v2/inventory/batch-retrieve-counts", "responses": [ { "uuid": "617518bd-0daa-4b47-8c29-ad72a41745a3", "body": "{\n \"counts\": [\n {\n \"calculated_at\": \"2016-11-16T22:28:01.223Z\",\n \"catalog_object_id\": \"W62UWFY35CWMYGVWK6TWJDNI\",\n \"catalog_object_type\": \"ITEM_VARIATION\",\n \"location_id\": \"59TNP9SA8VGDA\",\n \"quantity\": \"79\",\n \"state\": \"IN_STOCK\"\n }\n ],\n \"errors\": []\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "017e6329-9461-440d-b700-a4b6b8bfd418", "documentation": "BatchChangeInventory", "method": "post", "endpoint": "v2/inventory/changes/batch-create", "responses": [ { "uuid": "c8e4aa4c-8af3-4c03-82ca-36cc55e48ebf", "body": "{\n \"counts\": [\n {\n \"calculated_at\": \"2016-11-16T22:28:01.223Z\",\n \"catalog_object_id\": \"W62UWFY35CWMYGVWK6TWJDNI\",\n \"catalog_object_type\": \"ITEM_VARIATION\",\n \"location_id\": \"C6W5YS5QM06F5\",\n \"quantity\": \"53\",\n \"state\": \"IN_STOCK\"\n }\n ],\n \"errors\": []\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "67c055e1-ca8f-413f-92c0-78786ee2a465", "documentation": "BatchRetrieveInventoryChanges", "method": "post", "endpoint": "v2/inventory/changes/batch-retrieve", "responses": [ { "uuid": "02e882d5-d891-4c31-9916-1a8108278db7", "body": "{\n \"changes\": [\n {\n \"physical_count\": {\n \"catalog_object_id\": \"W62UWFY35CWMYGVWK6TWJDNI\",\n \"catalog_object_type\": \"ITEM_VARIATION\",\n \"created_at\": \"2016-11-16T22:25:24.878Z\",\n \"employee_id\": \"LRK57NSQ5X7PUD05\",\n \"id\": \"46YDTW253DWGGK9HMAE6XCAO\",\n \"location_id\": \"C6W5YS5QM06F5\",\n \"occurred_at\": \"2016-11-16T22:24:49.028Z\",\n \"quantity\": \"86\",\n \"reference_id\": \"22c07cf4-5626-4224-89f9-691112019399\",\n \"source\": {\n \"application_id\": \"416ff29c-86c4-4feb-b58c-9705f21f3ea0\",\n \"name\": \"Square Point of Sale 4.37\",\n \"product\": \"SQUARE_POS\"\n },\n \"state\": \"IN_STOCK\"\n },\n \"type\": \"PHYSICAL_COUNT\"\n }\n ],\n \"errors\": []\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "edfd100f-3c7d-403b-b097-162e6c0b390c", "documentation": "BatchRetrieveInventoryCounts", "method": "post", "endpoint": "v2/inventory/counts/batch-retrieve", "responses": [ { "uuid": "a7219a27-46df-412d-9bc2-90cce5e0b5bb", "body": "{\n \"counts\": [\n {\n \"calculated_at\": \"2016-11-16T22:28:01.223Z\",\n \"catalog_object_id\": \"W62UWFY35CWMYGVWK6TWJDNI\",\n \"catalog_object_type\": \"ITEM_VARIATION\",\n \"location_id\": \"59TNP9SA8VGDA\",\n \"quantity\": \"79\",\n \"state\": \"IN_STOCK\"\n }\n ],\n \"errors\": []\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "0303516e-3206-4ff4-8bca-3548fecdce1a", "documentation": "DeprecatedRetrieveInventoryPhysicalCount", "method": "get", "endpoint": "v2/inventory/physical-count/:physical_count_id", "responses": [ { "uuid": "12333dd5-6bab-4375-b99e-320880bf288b", "body": "{\n \"count\": {\n \"catalog_object_id\": \"W62UWFY35CWMYGVWK6TWJDNI\",\n \"catalog_object_type\": \"ITEM_VARIATION\",\n \"created_at\": \"2016-11-16T22:25:24.878Z\",\n \"employee_id\": \"LRK57NSQ5X7PUD05\",\n \"id\": \"ANZADNPLKADOJKJIUANKLMLQ\",\n \"location_id\": \"C6W5YS5QM06F5\",\n \"occurred_at\": \"2016-11-16T22:25:24.878Z\",\n \"quantity\": \"15\",\n \"reference_id\": \"f857ec37-f9a0-4458-8e23-5b5e0bea4e53\",\n \"source\": {\n \"application_id\": \"416ff29c-86c4-4feb-b58c-9705f21f3ea0\",\n \"name\": \"Square Point of Sale 4.37\",\n \"product\": \"SQUARE_POS\"\n },\n \"state\": \"IN_STOCK\"\n },\n \"errors\": []\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "f98db51d-5473-4ce5-8f62-30b863bfe485", "documentation": "RetrieveInventoryPhysicalCount", "method": "get", "endpoint": "v2/inventory/physical-counts/:physical_count_id", "responses": [ { "uuid": "e027d111-2ce3-4a9d-a6c1-4992a387ffa1", "body": "{\n \"count\": {\n \"catalog_object_id\": \"W62UWFY35CWMYGVWK6TWJDNI\",\n \"catalog_object_type\": \"ITEM_VARIATION\",\n \"created_at\": \"2016-11-16T22:25:24.878Z\",\n \"employee_id\": \"LRK57NSQ5X7PUD05\",\n \"id\": \"ANZADNPLKADOJKJIUANKLMLQ\",\n \"location_id\": \"C6W5YS5QM06F5\",\n \"occurred_at\": \"2016-11-16T22:25:24.878Z\",\n \"quantity\": \"15\",\n \"reference_id\": \"f857ec37-f9a0-4458-8e23-5b5e0bea4e53\",\n \"source\": {\n \"application_id\": \"416ff29c-86c4-4feb-b58c-9705f21f3ea0\",\n \"name\": \"Square Point of Sale 4.37\",\n \"product\": \"SQUARE_POS\"\n },\n \"state\": \"IN_STOCK\"\n },\n \"errors\": []\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "2851e04e-b5ef-490e-9644-3e3c4b38b97f", "documentation": "RetrieveInventoryTransfer", "method": "get", "endpoint": "v2/inventory/transfers/:transfer_id", "responses": [ { "uuid": "6f57d655-5db4-4e34-950a-5b528f75df9c", "body": "{\n \"errors\": [],\n \"transfer\": {\n \"catalog_object_id\": \"W62UWFY35CWMYGVWK6TWJDNI\",\n \"catalog_object_type\": \"ITEM_VARIATION\",\n \"created_at\": \"2016-11-17T13:02:15.142Z\",\n \"employee_id\": \"LRK57NSQ5X7PUD05\",\n \"from_location_id\": \"C6W5YS5QM06F5\",\n \"id\": \"UDMOEO78BG6GYWA2XDRYX3KB\",\n \"occurred_at\": \"2016-11-16T25:44:22.837Z\",\n \"quantity\": \"7\",\n \"reference_id\": \"4a366069-4096-47a2-99a5-0084ac879509\",\n \"source\": {\n \"application_id\": \"416ff29c-86c4-4feb-b58c-9705f21f3ea0\",\n \"name\": \"Square Point of Sale 4.37\",\n \"product\": \"SQUARE_POS\"\n },\n \"state\": \"IN_STOCK\",\n \"to_location_id\": \"59TNP9SA8VGDA\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "7e5418b4-832b-42aa-a7d9-2beb2cb1e3e4", "documentation": "RetrieveInventoryCount", "method": "get", "endpoint": "v2/inventory/:catalog_object_id", "responses": [ { "uuid": "c46fab66-f705-4830-93cf-548efc7c7bea", "body": "{\n \"counts\": [\n {\n \"calculated_at\": \"2016-11-16T22:28:01.223Z\",\n \"catalog_object_id\": \"W62UWFY35CWMYGVWK6TWJDNI\",\n \"catalog_object_type\": \"ITEM_VARIATION\",\n \"location_id\": \"C6W5YS5QM06F5\",\n \"quantity\": \"22\",\n \"state\": \"IN_STOCK\"\n }\n ],\n \"errors\": []\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "f0014718-e2d6-4367-b640-8502b62a7388", "documentation": "RetrieveInventoryChanges", "method": "get", "endpoint": "v2/inventory/:catalog_object_id/changes", "responses": [ { "uuid": "78c6961a-b0cb-4ae5-9293-22a48174a5a8", "body": "{\n \"changes\": [\n {\n \"adjustment\": {\n \"catalog_object_id\": \"W62UWFY35CWMYGVWK6TWJDNI\",\n \"catalog_object_type\": \"ITEM_VARIATION\",\n \"created_at\": \"2016-11-16T22:25:24.878Z\",\n \"employee_id\": \"AV7YRCGI2H1J5NQ8E1XIZCNA\",\n \"from_state\": \"IN_STOCK\",\n \"id\": \"OJKJIUANKLMLQANZADNPLKAD\",\n \"location_id\": \"C6W5YS5QM06F5\",\n \"occurred_at\": \"2016-11-16T22:25:24.878Z\",\n \"quantity\": \"3\",\n \"reference_id\": \"d8207693-168f-4b44-a2fd-a7ff533ddd26\",\n \"source\": {\n \"application_id\": \"416ff29c-86c4-4feb-b58c-9705f21f3ea0\",\n \"name\": \"Square Point of Sale 4.37\",\n \"product\": \"SQUARE_POS\"\n },\n \"to_state\": \"SOLD\",\n \"total_price_money\": {\n \"amount\": 5000,\n \"currency\": \"USD\"\n },\n \"transaction_id\": \"5APV6JYK1SNCZD11AND2RX1Z\"\n },\n \"type\": \"ADJUSTMENT\"\n }\n ],\n \"errors\": []\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "037814e5-5467-48ea-b5b4-d38a5dc815b4", "documentation": "ListInvoices", "method": "get", "endpoint": "v2/invoices", "responses": [ { "uuid": "87de7f8b-9c75-4ab0-8943-2384bf6d0907", "body": "{\n \"cursor\": \"ChoIDhIWVm54ZVRhLXhySFBOejBBM2xJb2daUQoFCI4IGAE\",\n \"invoices\": [\n {\n \"accepted_payment_methods\": {\n \"bank_account\": false,\n \"card\": true,\n \"square_gift_card\": false\n },\n \"created_at\": \"2020-06-18T17:45:13Z\",\n \"custom_fields\": [\n {\n \"label\": \"Event Reference Number\",\n \"placement\": \"ABOVE_LINE_ITEMS\",\n \"value\": \"Ref. #1234\"\n },\n {\n \"label\": \"Terms of Service\",\n \"placement\": \"BELOW_LINE_ITEMS\",\n \"value\": \"The terms of service are...\"\n }\n ],\n \"delivery_method\": \"EMAIL\",\n \"description\": \"We appreciate your business!\",\n \"id\": \"inv:0-ChCHu2mZEabLeeHahQnXDjZQECY\",\n \"invoice_number\": \"inv-100\",\n \"location_id\": \"ES0RJRZYEC39A\",\n \"order_id\": \"CAISENgvlJ6jLWAzERDzjyHVybY\",\n \"payment_requests\": [\n {\n \"automatic_payment_source\": \"NONE\",\n \"computed_amount_money\": {\n \"amount\": 10000,\n \"currency\": \"USD\"\n },\n \"due_date\": \"2030-01-24\",\n \"reminders\": [\n {\n \"message\": \"Your invoice is due tomorrow\",\n \"relative_scheduled_days\": -1,\n \"status\": \"PENDING\",\n \"uid\": \"beebd363-e47f-4075-8785-c235aaa7df11\"\n }\n ],\n \"request_type\": \"BALANCE\",\n \"tipping_enabled\": true,\n \"total_completed_amount_money\": {\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n \"uid\": \"2da7964f-f3d2-4f43-81e8-5aa220bf3355\"\n }\n ],\n \"primary_recipient\": {\n \"customer_id\": \"JDKYHBWT1D4F8MFH63DBMEN8Y4\",\n \"email_address\": \"Amelia.Earhart@example.com\",\n \"family_name\": \"Earhart\",\n \"given_name\": \"Amelia\",\n \"phone_number\": \"1-212-555-4240\"\n },\n \"scheduled_at\": \"2030-01-13T10:00:00Z\",\n \"status\": \"DRAFT\",\n \"timezone\": \"America/Los_Angeles\",\n \"title\": \"Event Planning Services\",\n \"updated_at\": \"2020-06-18T17:45:13Z\",\n \"version\": 0\n },\n {\n \"accepted_payment_methods\": {\n \"bank_account\": false,\n \"card\": true,\n \"square_gift_card\": true\n },\n \"created_at\": \"2021-01-23T15:29:12Z\",\n \"delivery_method\": \"EMAIL\",\n \"id\": \"inv:0-ChC366qAfskpGrBI_1bozs9mEA3\",\n \"invoice_number\": \"inv-455\",\n \"location_id\": \"ES0RJRZYEC39A\",\n \"next_payment_amount_money\": {\n \"amount\": 3000,\n \"currency\": \"USD\"\n },\n \"order_id\": \"a65jnS8NXbfprvGJzY9F4fQTuaB\",\n \"payment_requests\": [\n {\n \"automatic_payment_source\": \"CARD_ON_FILE\",\n \"card_id\": \"ccof:IkWfpLj4tNHMyFii3GB\",\n \"computed_amount_money\": {\n \"amount\": 1000,\n \"currency\": \"USD\"\n },\n \"due_date\": \"2021-01-23\",\n \"percentage_requested\": \"25\",\n \"request_type\": \"DEPOSIT\",\n \"tipping_enabled\": false,\n \"total_completed_amount_money\": {\n \"amount\": 1000,\n \"currency\": \"USD\"\n },\n \"uid\": \"66c3bdfd-5090-4ff9-a8a0-c1e1a2ffa176\"\n },\n {\n \"automatic_payment_source\": \"CARD_ON_FILE\",\n \"card_id\": \"ccof:IkWfpLj4tNHMyFii3GB\",\n \"computed_amount_money\": {\n \"amount\": 3000,\n \"currency\": \"USD\"\n },\n \"due_date\": \"2021-06-15\",\n \"request_type\": \"BALANCE\",\n \"tipping_enabled\": false,\n \"total_completed_amount_money\": {\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n \"uid\": \"120c5e18-4f80-4f6b-b159-774cb9bf8f99\"\n }\n ],\n \"primary_recipient\": {\n \"customer_id\": \"JDKYHBWT1D4F8MFH63DBMEN8Y4\",\n \"email_address\": \"Amelia.Earhart@example.com\",\n \"family_name\": \"Earhart\",\n \"given_name\": \"Amelia\",\n \"phone_number\": \"1-212-555-4240\"\n },\n \"public_url\": \"https://squareup.com/pay-invoice/h9sfsfTGTSnYEhISUDBhEQ\",\n \"status\": \"PARTIALLY_PAID\",\n \"timezone\": \"America/Los_Angeles\",\n \"updated_at\": \"2021-01-23T15:29:56Z\",\n \"version\": 3\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "96fb92c5-a78d-487f-aed0-c4d91d835140", "documentation": "CreateInvoice", "method": "post", "endpoint": "v2/invoices", "responses": [ { "uuid": "2c56b73d-3832-463e-8ecd-f8c836eb7a70", "body": "{\n \"invoice\": {\n \"accepted_payment_methods\": {\n \"bank_account\": false,\n \"card\": true,\n \"square_gift_card\": false\n },\n \"created_at\": \"2020-06-18T17:45:13Z\",\n \"custom_fields\": [\n {\n \"label\": \"Event Reference Number\",\n \"placement\": \"ABOVE_LINE_ITEMS\",\n \"value\": \"Ref. #1234\"\n },\n {\n \"label\": \"Terms of Service\",\n \"placement\": \"BELOW_LINE_ITEMS\",\n \"value\": \"The terms of service are...\"\n }\n ],\n \"delivery_method\": \"EMAIL\",\n \"description\": \"We appreciate your business!\",\n \"id\": \"inv:0-ChCHu2mZEabLeeHahQnXDjZQECY\",\n \"invoice_number\": \"inv-100\",\n \"location_id\": \"ES0RJRZYEC39A\",\n \"order_id\": \"CAISENgvlJ6jLWAzERDzjyHVybY\",\n \"payment_requests\": [\n {\n \"automatic_payment_source\": \"NONE\",\n \"computed_amount_money\": {\n \"amount\": 10000,\n \"currency\": \"USD\"\n },\n \"due_date\": \"2030-01-24\",\n \"reminders\": [\n {\n \"message\": \"Your invoice is due tomorrow\",\n \"relative_scheduled_days\": -1,\n \"status\": \"PENDING\",\n \"uid\": \"beebd363-e47f-4075-8785-c235aaa7df11\"\n }\n ],\n \"request_type\": \"BALANCE\",\n \"tipping_enabled\": true,\n \"total_completed_amount_money\": {\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n \"uid\": \"2da7964f-f3d2-4f43-81e8-5aa220bf3355\"\n }\n ],\n \"primary_recipient\": {\n \"customer_id\": \"JDKYHBWT1D4F8MFH63DBMEN8Y4\",\n \"email_address\": \"Amelia.Earhart@example.com\",\n \"family_name\": \"Earhart\",\n \"given_name\": \"Amelia\",\n \"phone_number\": \"1-212-555-4240\"\n },\n \"scheduled_at\": \"2030-01-13T10:00:00Z\",\n \"status\": \"DRAFT\",\n \"timezone\": \"America/Los_Angeles\",\n \"title\": \"Event Planning Services\",\n \"updated_at\": \"2020-06-18T17:45:13Z\",\n \"version\": 0\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "e79b0b0e-b793-4684-a415-7dd62fc91d6c", "documentation": "SearchInvoices", "method": "post", "endpoint": "v2/invoices/search", "responses": [ { "uuid": "5961c51a-cd3a-4ec8-aaf2-9eb4e38c7847", "body": "{\n \"cursor\": \"ChoIDhIWVm54ZVRhLXhySFBOejBBM2xJb2daUQoFCI4IGAE\",\n \"invoices\": [\n {\n \"accepted_payment_methods\": {\n \"bank_account\": false,\n \"card\": true,\n \"square_gift_card\": false\n },\n \"created_at\": \"2020-06-18T17:45:13Z\",\n \"custom_fields\": [\n {\n \"label\": \"Event Reference Number\",\n \"placement\": \"ABOVE_LINE_ITEMS\",\n \"value\": \"Ref. #1234\"\n },\n {\n \"label\": \"Terms of Service\",\n \"placement\": \"BELOW_LINE_ITEMS\",\n \"value\": \"The terms of service are...\"\n }\n ],\n \"delivery_method\": \"EMAIL\",\n \"description\": \"We appreciate your business!\",\n \"id\": \"inv:0-ChCHu2mZEabLeeHahQnXDjZQECY\",\n \"invoice_number\": \"inv-100\",\n \"location_id\": \"ES0RJRZYEC39A\",\n \"order_id\": \"CAISENgvlJ6jLWAzERDzjyHVybY\",\n \"payment_requests\": [\n {\n \"automatic_payment_source\": \"NONE\",\n \"computed_amount_money\": {\n \"amount\": 10000,\n \"currency\": \"USD\"\n },\n \"due_date\": \"2030-01-24\",\n \"reminders\": [\n {\n \"message\": \"Your invoice is due tomorrow\",\n \"relative_scheduled_days\": -1,\n \"status\": \"PENDING\",\n \"uid\": \"beebd363-e47f-4075-8785-c235aaa7df11\"\n }\n ],\n \"request_type\": \"BALANCE\",\n \"tipping_enabled\": true,\n \"total_completed_amount_money\": {\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n \"uid\": \"2da7964f-f3d2-4f43-81e8-5aa220bf3355\"\n }\n ],\n \"primary_recipient\": {\n \"customer_id\": \"JDKYHBWT1D4F8MFH63DBMEN8Y4\",\n \"email_address\": \"Amelia.Earhart@example.com\",\n \"family_name\": \"Earhart\",\n \"given_name\": \"Amelia\",\n \"phone_number\": \"1-212-555-4240\"\n },\n \"scheduled_at\": \"2030-01-13T10:00:00Z\",\n \"status\": \"DRAFT\",\n \"timezone\": \"America/Los_Angeles\",\n \"title\": \"Event Planning Services\",\n \"updated_at\": \"2020-06-18T17:45:13Z\",\n \"version\": 0\n },\n {\n \"accepted_payment_methods\": {\n \"bank_account\": false,\n \"card\": true,\n \"square_gift_card\": true\n },\n \"created_at\": \"2021-01-23T15:29:12Z\",\n \"delivery_method\": \"EMAIL\",\n \"id\": \"inv:0-ChC366qAfskpGrBI_1bozs9mEA3\",\n \"invoice_number\": \"inv-455\",\n \"location_id\": \"ES0RJRZYEC39A\",\n \"next_payment_amount_money\": {\n \"amount\": 3000,\n \"currency\": \"USD\"\n },\n \"order_id\": \"a65jnS8NXbfprvGJzY9F4fQTuaB\",\n \"payment_requests\": [\n {\n \"automatic_payment_source\": \"CARD_ON_FILE\",\n \"card_id\": \"ccof:IkWfpLj4tNHMyFii3GB\",\n \"computed_amount_money\": {\n \"amount\": 1000,\n \"currency\": \"USD\"\n },\n \"due_date\": \"2021-01-23\",\n \"percentage_requested\": \"25\",\n \"request_type\": \"DEPOSIT\",\n \"tipping_enabled\": false,\n \"total_completed_amount_money\": {\n \"amount\": 1000,\n \"currency\": \"USD\"\n },\n \"uid\": \"66c3bdfd-5090-4ff9-a8a0-c1e1a2ffa176\"\n },\n {\n \"automatic_payment_source\": \"CARD_ON_FILE\",\n \"card_id\": \"ccof:IkWfpLj4tNHMyFii3GB\",\n \"computed_amount_money\": {\n \"amount\": 3000,\n \"currency\": \"USD\"\n },\n \"due_date\": \"2021-06-15\",\n \"request_type\": \"BALANCE\",\n \"tipping_enabled\": false,\n \"total_completed_amount_money\": {\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n \"uid\": \"120c5e18-4f80-4f6b-b159-774cb9bf8f99\"\n }\n ],\n \"primary_recipient\": {\n \"customer_id\": \"JDKYHBWT1D4F8MFH63DBMEN8Y4\",\n \"email_address\": \"Amelia.Earhart@example.com\",\n \"family_name\": \"Earhart\",\n \"given_name\": \"Amelia\",\n \"phone_number\": \"1-212-555-4240\"\n },\n \"public_url\": \"https://squareup.com/pay-invoice/h9sfsfTGTSnYEhISUDBhEQ\",\n \"status\": \"PARTIALLY_PAID\",\n \"timezone\": \"America/Los_Angeles\",\n \"updated_at\": \"2021-01-23T15:29:56Z\",\n \"version\": 3\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "414778cf-7264-48b0-b2e0-7442abd088fd", "documentation": "DeleteInvoice", "method": "delete", "endpoint": "v2/invoices/:invoice_id", "responses": [ { "uuid": "1112158c-34f1-4f73-b38d-c63c99549389", "body": "{}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "e354b724-912c-4a2e-9118-805a586296e1", "documentation": "GetInvoice", "method": "get", "endpoint": "v2/invoices/:invoice_id", "responses": [ { "uuid": "4732a3a1-dd30-46fb-827d-6a89e137139a", "body": "{\n \"invoice\": {\n \"accepted_payment_methods\": {\n \"bank_account\": false,\n \"card\": true,\n \"square_gift_card\": false\n },\n \"created_at\": \"2020-06-18T17:45:13Z\",\n \"custom_fields\": [\n {\n \"label\": \"Event Reference Number\",\n \"placement\": \"ABOVE_LINE_ITEMS\",\n \"value\": \"Ref. #1234\"\n },\n {\n \"label\": \"Terms of Service\",\n \"placement\": \"BELOW_LINE_ITEMS\",\n \"value\": \"The terms of service are...\"\n }\n ],\n \"delivery_method\": \"EMAIL\",\n \"description\": \"We appreciate your business!\",\n \"id\": \"inv:0-ChCHu2mZEabLeeHahQnXDjZQECY\",\n \"invoice_number\": \"inv-100\",\n \"location_id\": \"ES0RJRZYEC39A\",\n \"order_id\": \"CAISENgvlJ6jLWAzERDzjyHVybY\",\n \"payment_requests\": [\n {\n \"automatic_payment_source\": \"NONE\",\n \"computed_amount_money\": {\n \"amount\": 10000,\n \"currency\": \"USD\"\n },\n \"due_date\": \"2030-01-24\",\n \"reminders\": [\n {\n \"message\": \"Your invoice is due tomorrow\",\n \"relative_scheduled_days\": -1,\n \"status\": \"PENDING\",\n \"uid\": \"beebd363-e47f-4075-8785-c235aaa7df11\"\n }\n ],\n \"request_type\": \"BALANCE\",\n \"tipping_enabled\": true,\n \"total_completed_amount_money\": {\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n \"uid\": \"2da7964f-f3d2-4f43-81e8-5aa220bf3355\"\n }\n ],\n \"primary_recipient\": {\n \"customer_id\": \"JDKYHBWT1D4F8MFH63DBMEN8Y4\",\n \"email_address\": \"Amelia.Earhart@example.com\",\n \"family_name\": \"Earhart\",\n \"given_name\": \"Amelia\",\n \"phone_number\": \"1-212-555-4240\"\n },\n \"scheduled_at\": \"2030-01-13T10:00:00Z\",\n \"status\": \"DRAFT\",\n \"timezone\": \"America/Los_Angeles\",\n \"title\": \"Event Planning Services\",\n \"updated_at\": \"2020-06-18T17:45:13Z\",\n \"version\": 0\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "03bce47d-3c1f-4d9d-84b1-d87d58b03ea4", "documentation": "UpdateInvoice", "method": "put", "endpoint": "v2/invoices/:invoice_id", "responses": [ { "uuid": "8260b9d4-f2c1-4c09-8201-feff7621359d", "body": "{\n \"invoice\": {\n \"accepted_payment_methods\": {\n \"bank_account\": false,\n \"card\": true,\n \"square_gift_card\": false\n },\n \"created_at\": \"2020-06-18T17:45:13Z\",\n \"custom_fields\": [\n {\n \"label\": \"Event Reference Number\",\n \"placement\": \"ABOVE_LINE_ITEMS\",\n \"value\": \"Ref. #1234\"\n },\n {\n \"label\": \"Terms of Service\",\n \"placement\": \"BELOW_LINE_ITEMS\",\n \"value\": \"The terms of service are...\"\n }\n ],\n \"delivery_method\": \"EMAIL\",\n \"description\": \"We appreciate your business!\",\n \"id\": \"inv:0-ChCHu2mZEabLeeHahQnXDjZQECY\",\n \"invoice_number\": \"inv-100\",\n \"location_id\": \"ES0RJRZYEC39A\",\n \"next_payment_amount_money\": {\n \"amount\": 10000,\n \"currency\": \"USD\"\n },\n \"order_id\": \"CAISENgvlJ6jLWAzERDzjyHVybY\",\n \"payment_requests\": [\n {\n \"automatic_payment_source\": \"NONE\",\n \"computed_amount_money\": {\n \"amount\": 10000,\n \"currency\": \"USD\"\n },\n \"due_date\": \"2030-01-24\",\n \"request_type\": \"BALANCE\",\n \"tipping_enabled\": false,\n \"total_completed_amount_money\": {\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n \"uid\": \"2da7964f-f3d2-4f43-81e8-5aa220bf3355\"\n }\n ],\n \"primary_recipient\": {\n \"customer_id\": \"JDKYHBWT1D4F8MFH63DBMEN8Y4\",\n \"email_address\": \"Amelia.Earhart@example.com\",\n \"family_name\": \"Earhart\",\n \"given_name\": \"Amelia\",\n \"phone_number\": \"1-212-555-4240\"\n },\n \"scheduled_at\": \"2030-01-13T10:00:00Z\",\n \"status\": \"UNPAID\",\n \"timezone\": \"America/Los_Angeles\",\n \"title\": \"Event Planning Services\",\n \"updated_at\": \"2020-06-18T18:23:11Z\",\n \"version\": 2\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "13d8eea4-81cd-4703-b85b-a9769db3bfa2", "documentation": "CancelInvoice", "method": "post", "endpoint": "v2/invoices/:invoice_id/cancel", "responses": [ { "uuid": "194c6b34-81d7-4a98-af2a-dfe25bc04d31", "body": "{\n \"invoice\": {\n \"accepted_payment_methods\": {\n \"bank_account\": false,\n \"card\": true,\n \"square_gift_card\": false\n },\n \"created_at\": \"2020-06-18T17:45:13Z\",\n \"custom_fields\": [\n {\n \"label\": \"Event Reference Number\",\n \"placement\": \"ABOVE_LINE_ITEMS\",\n \"value\": \"Ref. #1234\"\n },\n {\n \"label\": \"Terms of Service\",\n \"placement\": \"BELOW_LINE_ITEMS\",\n \"value\": \"The terms of service are...\"\n }\n ],\n \"delivery_method\": \"EMAIL\",\n \"description\": \"We appreciate your business!\",\n \"id\": \"inv:0-ChCHu2mZEabLeeHahQnXDjZQECY\",\n \"invoice_number\": \"inv-100\",\n \"location_id\": \"ES0RJRZYEC39A\",\n \"order_id\": \"CAISENgvlJ6jLWAzERDzjyHVybY\",\n \"payment_requests\": [\n {\n \"automatic_payment_source\": \"NONE\",\n \"computed_amount_money\": {\n \"amount\": 10000,\n \"currency\": \"USD\"\n },\n \"due_date\": \"2030-01-24\",\n \"reminders\": [\n {\n \"message\": \"Your invoice is due tomorrow\",\n \"relative_scheduled_days\": -1,\n \"status\": \"PENDING\",\n \"uid\": \"beebd363-e47f-4075-8785-c235aaa7df11\"\n }\n ],\n \"request_type\": \"BALANCE\",\n \"tipping_enabled\": true,\n \"total_completed_amount_money\": {\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n \"uid\": \"2da7964f-f3d2-4f43-81e8-5aa220bf3355\"\n }\n ],\n \"primary_recipient\": {\n \"customer_id\": \"JDKYHBWT1D4F8MFH63DBMEN8Y4\",\n \"email_address\": \"Amelia.Earhart@example.com\",\n \"family_name\": \"Earhart\",\n \"given_name\": \"Amelia\",\n \"phone_number\": \"1-212-555-4240\"\n },\n \"scheduled_at\": \"2030-01-13T10:00:00Z\",\n \"status\": \"CANCELED\",\n \"timezone\": \"America/Los_Angeles\",\n \"title\": \"Event Planning Services\",\n \"updated_at\": \"2020-06-18T18:23:11Z\",\n \"version\": 1\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "0098cc32-0289-4201-9bd2-6c54808b0213", "documentation": "PublishInvoice", "method": "post", "endpoint": "v2/invoices/:invoice_id/publish", "responses": [ { "uuid": "4ac97ae3-3c3f-439e-8c34-023ad0066eb4", "body": "{\n \"invoice\": {\n \"accepted_payment_methods\": {\n \"bank_account\": false,\n \"card\": true,\n \"square_gift_card\": false\n },\n \"created_at\": \"2020-06-18T17:45:13Z\",\n \"custom_fields\": [\n {\n \"label\": \"Event Reference Number\",\n \"placement\": \"ABOVE_LINE_ITEMS\",\n \"value\": \"Ref. #1234\"\n },\n {\n \"label\": \"Terms of Service\",\n \"placement\": \"BELOW_LINE_ITEMS\",\n \"value\": \"The terms of service are...\"\n }\n ],\n \"delivery_method\": \"EMAIL\",\n \"description\": \"We appreciate your business!\",\n \"id\": \"inv:0-ChCHu2mZEabLeeHahQnXDjZQECY\",\n \"invoice_number\": \"inv-100\",\n \"location_id\": \"ES0RJRZYEC39A\",\n \"order_id\": \"CAISENgvlJ6jLWAzERDzjyHVybY\",\n \"payment_requests\": [\n {\n \"automatic_payment_source\": \"NONE\",\n \"computed_amount_money\": {\n \"amount\": 10000,\n \"currency\": \"USD\"\n },\n \"due_date\": \"2030-01-24\",\n \"reminders\": [\n {\n \"message\": \"Your invoice is due tomorrow\",\n \"relative_scheduled_days\": -1,\n \"status\": \"PENDING\",\n \"uid\": \"beebd363-e47f-4075-8785-c235aaa7df11\"\n }\n ],\n \"request_type\": \"BALANCE\",\n \"tipping_enabled\": true,\n \"total_completed_amount_money\": {\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n \"uid\": \"2da7964f-f3d2-4f43-81e8-5aa220bf3355\"\n }\n ],\n \"primary_recipient\": {\n \"customer_id\": \"JDKYHBWT1D4F8MFH63DBMEN8Y4\",\n \"email_address\": \"Amelia.Earhart@example.com\",\n \"family_name\": \"Earhart\",\n \"given_name\": \"Amelia\",\n \"phone_number\": \"1-212-555-4240\"\n },\n \"public_url\": \"https://squareup.com/pay-invoice/inv:0-ChCHu2mZEabLeeHahQnXDjZQECY\",\n \"scheduled_at\": \"2030-01-13T10:00:00Z\",\n \"status\": \"SCHEDULED\",\n \"timezone\": \"America/Los_Angeles\",\n \"title\": \"Event Planning Services\",\n \"updated_at\": \"2020-06-18T18:23:11Z\",\n \"version\": 1\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "23ceca0f-3e92-4fee-90d3-adda2ae1a750", "documentation": "ListBreakTypes", "method": "get", "endpoint": "v2/labor/break-types", "responses": [ { "uuid": "dd76354e-a32f-47ba-886b-6a1c72bdeba5", "body": "{\n \"break_types\": [\n {\n \"break_name\": \"Coffee Break\",\n \"created_at\": \"2019-01-22T20:47:37Z\",\n \"expected_duration\": \"PT5M\",\n \"id\": \"REGS1EQR1TPZ5\",\n \"is_paid\": false,\n \"location_id\": \"PAA1RJZZKXBFG\",\n \"updated_at\": \"2019-01-22T20:47:37Z\",\n \"version\": 1\n },\n {\n \"break_name\": \"Lunch Break\",\n \"created_at\": \"2019-01-25T19:26:30Z\",\n \"expected_duration\": \"PT1H\",\n \"id\": \"92EPDRQKJ5088\",\n \"is_paid\": true,\n \"location_id\": \"PAA1RJZZKXBFG\",\n \"updated_at\": \"2019-01-25T19:26:30Z\",\n \"version\": 3\n }\n ],\n \"cursor\": \"2fofTniCgT0yIPAq26kmk0YyFQJZfbWkh73OOnlTHmTAx13NgED\"\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "70c88320-f6cd-4e43-9048-329cb9f5a6b1", "documentation": "CreateBreakType", "method": "post", "endpoint": "v2/labor/break-types", "responses": [ { "uuid": "8ff6a458-db97-4e12-aeaa-124259a8f97e", "body": "{\n \"break_type\": {\n \"break_name\": \"Lunch Break\",\n \"created_at\": \"2019-02-26T22:42:54Z\",\n \"expected_duration\": \"PT30M\",\n \"id\": \"49SSVDJG76WF3\",\n \"is_paid\": true,\n \"location_id\": \"CGJN03P1D08GF\",\n \"updated_at\": \"2019-02-26T22:42:54Z\",\n \"version\": 1\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "a2c70ade-b4ec-4405-b016-03618a22b02c", "documentation": "DeleteBreakType", "method": "delete", "endpoint": "v2/labor/break-types/:id", "responses": [ { "uuid": "4aa44d56-8e1b-457b-b22e-9e5994a64b78", "body": "{}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "a904c5e0-c469-4305-b898-f4af4f6b15e0", "documentation": "GetBreakType", "method": "get", "endpoint": "v2/labor/break-types/:id", "responses": [ { "uuid": "4a93dec6-1886-431d-a9f1-9807f9e15625", "body": "{\n \"break_type\": {\n \"break_name\": \"Lunch Break\",\n \"created_at\": \"2019-02-21T17:50:00Z\",\n \"expected_duration\": \"PT30M\",\n \"id\": \"lA0mj_RSOprNPwMUXdYp\",\n \"is_paid\": true,\n \"location_id\": \"059SB0E0WCNWS\",\n \"updated_at\": \"2019-02-21T17:50:00Z\",\n \"version\": 1\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "e939a245-c7d6-4eba-962d-574a632ddeed", "documentation": "UpdateBreakType", "method": "put", "endpoint": "v2/labor/break-types/:id", "responses": [ { "uuid": "df99ef20-1db5-4803-8813-398bb3ce6eaf", "body": "{\n \"break_type\": {\n \"break_name\": \"Lunch\",\n \"created_at\": \"2018-06-12T20:19:12Z\",\n \"expected_duration\": \"PT50M\",\n \"id\": \"Q6JSJS6D4DBCH\",\n \"is_paid\": true,\n \"location_id\": \"26M7H24AZ9N6R\",\n \"updated_at\": \"2019-02-26T23:12:59Z\",\n \"version\": 2\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "b18508e6-0464-4bb0-b47b-d11df6d24724", "documentation": "ListEmployeeWages", "method": "get", "endpoint": "v2/labor/employee-wages", "responses": [ { "uuid": "ad61405a-9732-4293-b7bc-a7963bcd2c34", "body": "{\n \"cursor\": \"2fofTniCgT0yIPAq26kmk0YyFQJZfbWkh73OOnlTHmTAx13NgED\",\n \"employee_wages\": [\n {\n \"employee_id\": \"33fJchumvVdJwxV0H6L9\",\n \"hourly_rate\": {\n \"amount\": 3250,\n \"currency\": \"USD\"\n },\n \"id\": \"pXS3qCv7BERPnEGedM4S8mhm\",\n \"title\": \"Manager\"\n },\n {\n \"employee_id\": \"33fJchumvVdJwxV0H6L9\",\n \"hourly_rate\": {\n \"amount\": 2600,\n \"currency\": \"USD\"\n },\n \"id\": \"rZduCkzYDUVL3ovh1sQgbue6\",\n \"title\": \"Cook\"\n },\n {\n \"employee_id\": \"33fJchumvVdJwxV0H6L9\",\n \"hourly_rate\": {\n \"amount\": 1600,\n \"currency\": \"USD\"\n },\n \"id\": \"FxLbs5KpPUHa8wyt5ctjubDX\",\n \"title\": \"Barista\"\n },\n {\n \"employee_id\": \"33fJchumvVdJwxV0H6L9\",\n \"hourly_rate\": {\n \"amount\": 1700,\n \"currency\": \"USD\"\n },\n \"id\": \"vD1wCgijMDR3cX5TPnu7VXto\",\n \"title\": \"Cashier\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "be0b9712-8294-4798-a43b-33fe9f4a092b", "documentation": "GetEmployeeWage", "method": "get", "endpoint": "v2/labor/employee-wages/:id", "responses": [ { "uuid": "371a61a3-e8b0-47a8-88e6-7b914e4d10ff", "body": "{\n \"employee_wage\": {\n \"employee_id\": \"33fJchumvVdJwxV0H6L9\",\n \"hourly_rate\": {\n \"amount\": 2000,\n \"currency\": \"USD\"\n },\n \"id\": \"pXS3qCv7BERPnEGedM4S8mhm\",\n \"title\": \"Manager\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "5162dfc7-c8b0-4766-ade3-4eb908f5eddd", "documentation": "CreateShift", "method": "post", "endpoint": "v2/labor/shifts", "responses": [ { "uuid": "594aa0df-e7d2-4d6d-97c8-f566872f83c4", "body": "{\n \"shift\": {\n \"breaks\": [\n {\n \"break_type_id\": \"REGS1EQR1TPZ5\",\n \"end_at\": \"2019-01-25T06:16:00-05:00\",\n \"expected_duration\": \"PT5M\",\n \"id\": \"X7GAQYVVRRG6P\",\n \"is_paid\": true,\n \"name\": \"Tea Break\",\n \"start_at\": \"2019-01-25T06:11:00-05:00\"\n }\n ],\n \"created_at\": \"2019-02-28T00:39:02Z\",\n \"employee_id\": \"ormj0jJJZ5OZIzxrZYJI\",\n \"end_at\": \"2019-01-25T13:11:00-05:00\",\n \"id\": \"K0YH4CV5462JB\",\n \"location_id\": \"PAA1RJZZKXBFG\",\n \"start_at\": \"2019-01-25T03:11:00-05:00\",\n \"status\": \"CLOSED\",\n \"team_member_id\": \"ormj0jJJZ5OZIzxrZYJI\",\n \"timezone\": \"America/New_York\",\n \"updated_at\": \"2019-02-28T00:39:02Z\",\n \"version\": 1,\n \"wage\": {\n \"hourly_rate\": {\n \"amount\": 1100,\n \"currency\": \"USD\"\n },\n \"title\": \"Barista\"\n }\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "621f30d5-32cd-48b2-ac77-8cd5548d008f", "documentation": "SearchShifts", "method": "post", "endpoint": "v2/labor/shifts/search", "responses": [ { "uuid": "7a33bb1b-44f6-429c-9bcc-31704f493ace", "body": "{\n \"shifts\": [\n {\n \"breaks\": [\n {\n \"break_type_id\": \"REGS1EQR1TPZ5\",\n \"end_at\": \"2019-01-21T06:11:00-05:00\",\n \"expected_duration\": \"PT10M\",\n \"id\": \"SJW7X6AKEJQ65\",\n \"is_paid\": true,\n \"name\": \"Tea Break\",\n \"start_at\": \"2019-01-21T06:11:00-05:00\"\n }\n ],\n \"created_at\": \"2019-01-24T01:12:03Z\",\n \"employee_id\": \"ormj0jJJZ5OZIzxrZYJI\",\n \"end_at\": \"2019-01-21T13:11:00-05:00\",\n \"id\": \"X714F3HA6D1PT\",\n \"location_id\": \"PAA1RJZZKXBFG\",\n \"start_at\": \"2019-01-21T03:11:00-05:00\",\n \"status\": \"CLOSED\",\n \"team_member_id\": \"ormj0jJJZ5OZIzxrZYJI\",\n \"timezone\": \"America/New_York\",\n \"updated_at\": \"2019-02-07T22:21:08Z\",\n \"version\": 6,\n \"wage\": {\n \"hourly_rate\": {\n \"amount\": 1100,\n \"currency\": \"USD\"\n },\n \"title\": \"Barista\"\n }\n },\n {\n \"breaks\": [\n {\n \"break_type_id\": \"WQX00VR99F53J\",\n \"end_at\": \"2019-01-23T14:40:00-05:00\",\n \"expected_duration\": \"PT10M\",\n \"id\": \"BKS6VR7WR748A\",\n \"is_paid\": true,\n \"name\": \"Tea Break\",\n \"start_at\": \"2019-01-23T14:30:00-05:00\"\n },\n {\n \"break_type_id\": \"P6Q468ZFRN1AC\",\n \"end_at\": \"2019-01-22T12:44:00-05:00\",\n \"expected_duration\": \"PT15M\",\n \"id\": \"BQFEZSHFZSC51\",\n \"is_paid\": false,\n \"name\": \"Coffee Break\",\n \"start_at\": \"2019-01-22T12:30:00-05:00\"\n }\n ],\n \"created_at\": \"2019-01-23T23:32:45Z\",\n \"employee_id\": \"33fJchumvVdJwxV0H6L9\",\n \"end_at\": \"2019-01-22T13:02:00-05:00\",\n \"id\": \"GDHYBZYWK0P2V\",\n \"location_id\": \"PAA1RJZZKXBFG\",\n \"start_at\": \"2019-01-22T12:02:00-05:00\",\n \"status\": \"CLOSED\",\n \"team_member_id\": \"33fJchumvVdJwxV0H6L9\",\n \"timezone\": \"America/New_York\",\n \"updated_at\": \"2019-01-24T00:56:25Z\",\n \"version\": 16,\n \"wage\": {\n \"hourly_rate\": {\n \"amount\": 1600,\n \"currency\": \"USD\"\n },\n \"title\": \"Cook\"\n }\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "9156fe99-fa9e-4b9f-933f-c2046df6083f", "documentation": "DeleteShift", "method": "delete", "endpoint": "v2/labor/shifts/:id", "responses": [ { "uuid": "430e652f-cab6-453e-904d-f74079ed1a31", "body": "{}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "3ff053f6-b76e-4355-8044-cbf3385a5ddd", "documentation": "GetShift", "method": "get", "endpoint": "v2/labor/shifts/:id", "responses": [ { "uuid": "54f8ea0a-3623-4836-a197-c59c8d2896b7", "body": "{\n \"shift\": {\n \"breaks\": [\n {\n \"break_type_id\": \"92EPDRQKJ5088\",\n \"end_at\": \"2019-02-23T20:00:00-05:00\",\n \"expected_duration\": \"PT1H\",\n \"id\": \"M9BBKEPQAQD2T\",\n \"is_paid\": true,\n \"name\": \"Lunch Break\",\n \"start_at\": \"2019-02-23T19:00:00-05:00\"\n }\n ],\n \"created_at\": \"2019-02-27T00:12:12Z\",\n \"employee_id\": \"D71KRMQof6cXGUW0aAv7\",\n \"end_at\": \"2019-02-23T21:00:00-05:00\",\n \"id\": \"T35HMQSN89SV4\",\n \"location_id\": \"PAA1RJZZKXBFG\",\n \"start_at\": \"2019-02-23T18:00:00-05:00\",\n \"status\": \"CLOSED\",\n \"team_member_id\": \"D71KRMQof6cXGUW0aAv7\",\n \"timezone\": \"America/New_York\",\n \"updated_at\": \"2019-02-27T00:12:12Z\",\n \"version\": 1,\n \"wage\": {\n \"hourly_rate\": {\n \"amount\": 1457,\n \"currency\": \"USD\"\n },\n \"title\": \"Cashier\"\n }\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "4cd63ebc-8e16-4f05-ac03-42f8aca1d1cd", "documentation": "UpdateShift", "method": "put", "endpoint": "v2/labor/shifts/:id", "responses": [ { "uuid": "bf73df8c-acfe-4b08-af48-d3ce958c5542", "body": "{\n \"shift\": {\n \"breaks\": [\n {\n \"break_type_id\": \"REGS1EQR1TPZ5\",\n \"end_at\": \"2019-01-25T06:16:00-05:00\",\n \"expected_duration\": \"PT5M\",\n \"id\": \"X7GAQYVVRRG6P\",\n \"is_paid\": true,\n \"name\": \"Tea Break\",\n \"start_at\": \"2019-01-25T06:11:00-05:00\"\n }\n ],\n \"created_at\": \"2019-02-28T00:39:02Z\",\n \"employee_id\": \"ormj0jJJZ5OZIzxrZYJI\",\n \"end_at\": \"2019-01-25T13:11:00-05:00\",\n \"id\": \"K0YH4CV5462JB\",\n \"location_id\": \"PAA1RJZZKXBFG\",\n \"start_at\": \"2019-01-25T03:11:00-05:00\",\n \"status\": \"CLOSED\",\n \"team_member_id\": \"ormj0jJJZ5OZIzxrZYJI\",\n \"timezone\": \"America/New_York\",\n \"updated_at\": \"2019-02-28T00:42:41Z\",\n \"version\": 2,\n \"wage\": {\n \"hourly_rate\": {\n \"amount\": 1500,\n \"currency\": \"USD\"\n },\n \"title\": \"Bartender\"\n }\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "77a3e3a2-8591-47ff-a551-fdcf1df493e2", "documentation": "ListTeamMemberWages", "method": "get", "endpoint": "v2/labor/team-member-wages", "responses": [ { "uuid": "fbcc33e5-cbaf-4601-bc76-41d7e0f34e35", "body": "{\n \"cursor\": \"2fofTniCgT0yIPAq26kmk0YyFQJZfbWkh73OOnlTHmTAx13NgED\",\n \"team_member_wages\": [\n {\n \"hourly_rate\": {\n \"amount\": 3250,\n \"currency\": \"USD\"\n },\n \"id\": \"pXS3qCv7BERPnEGedM4S8mhm\",\n \"team_member_id\": \"33fJchumvVdJwxV0H6L9\",\n \"title\": \"Manager\"\n },\n {\n \"hourly_rate\": {\n \"amount\": 2600,\n \"currency\": \"USD\"\n },\n \"id\": \"rZduCkzYDUVL3ovh1sQgbue6\",\n \"team_member_id\": \"33fJchumvVdJwxV0H6L9\",\n \"title\": \"Cook\"\n },\n {\n \"hourly_rate\": {\n \"amount\": 1600,\n \"currency\": \"USD\"\n },\n \"id\": \"FxLbs5KpPUHa8wyt5ctjubDX\",\n \"team_member_id\": \"33fJchumvVdJwxV0H6L9\",\n \"title\": \"Barista\"\n },\n {\n \"hourly_rate\": {\n \"amount\": 1700,\n \"currency\": \"USD\"\n },\n \"id\": \"vD1wCgijMDR3cX5TPnu7VXto\",\n \"team_member_id\": \"33fJchumvVdJwxV0H6L9\",\n \"title\": \"Cashier\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "7b1f7cc3-59bf-4d9b-b716-e16d5bad1c3c", "documentation": "GetTeamMemberWage", "method": "get", "endpoint": "v2/labor/team-member-wages/:id", "responses": [ { "uuid": "e432aa2f-3262-4a61-b86b-84e79367ecfe", "body": "{\n \"team_member_wage\": {\n \"hourly_rate\": {\n \"amount\": 2000,\n \"currency\": \"USD\"\n },\n \"id\": \"pXS3qCv7BERPnEGedM4S8mhm\",\n \"team_member_id\": \"33fJchumvVdJwxV0H6L9\",\n \"title\": \"Manager\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "fc8120f4-7ad8-43b7-8400-cbf9d06e111b", "documentation": "ListWorkweekConfigs", "method": "get", "endpoint": "v2/labor/workweek-configs", "responses": [ { "uuid": "bcc94e65-e5d9-4854-9c62-a0412b9d1ae1", "body": "{\n \"cursor\": \"2fofTniCgT0yIPAq26kmk0YyFQJZfbWkh73OOnlTHmTAx13NgED\",\n \"workweek_configs\": [\n {\n \"created_at\": \"2016-02-04T00:58:24Z\",\n \"id\": \"FY4VCAQN700GM\",\n \"start_of_day_local_time\": \"10:00\",\n \"start_of_week\": \"MON\",\n \"updated_at\": \"2019-02-28T01:04:35Z\",\n \"version\": 11\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "d7a24a3f-b11f-4951-97e0-9decd6a6265c", "documentation": "UpdateWorkweekConfig", "method": "put", "endpoint": "v2/labor/workweek-configs/:id", "responses": [ { "uuid": "f2455791-f7b1-44cd-bcb1-77331dbeba92", "body": "{\n \"workweek_config\": {\n \"created_at\": \"2016-02-04T00:58:24Z\",\n \"id\": \"FY4VCAQN700GM\",\n \"start_of_day_local_time\": \"10:00\",\n \"start_of_week\": \"MON\",\n \"updated_at\": \"2019-02-28T01:04:35Z\",\n \"version\": 11\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "9f9a6419-689d-4a89-ab7c-0dc34e52b5d5", "documentation": "ListLocations", "method": "get", "endpoint": "v2/locations", "responses": [ { "uuid": "70322438-a977-42bb-842d-631a1240a366", "body": "{\n \"locations\": [\n {\n \"address\": {\n \"address_line_1\": \"123 Main St\",\n \"administrative_district_level_1\": \"CA\",\n \"country\": \"US\",\n \"locality\": \"San Francisco\",\n \"postal_code\": \"94114\"\n },\n \"business_name\": \"Pumbaa's business name\",\n \"capabilities\": [\n \"CREDIT_CARD_PROCESSING\"\n ],\n \"country\": \"US\",\n \"created_at\": \"2016-09-19T17:33:12Z\",\n \"currency\": \"USD\",\n \"id\": \"18YC4JDH91E1H\",\n \"language_code\": \"en-US\",\n \"merchant_id\": \"3MYCJG5GVYQ8Q\",\n \"name\": \"your location name\",\n \"phone_number\": \"+1 650-354-7217\",\n \"status\": \"ACTIVE\",\n \"timezone\": \"America/Los_Angeles\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "b2d5aebc-70c5-49db-b550-a91ad2cc76fa", "documentation": "CreateLocation", "method": "post", "endpoint": "v2/locations", "responses": [ { "uuid": "2b2bb2c6-cf9f-4e34-a32c-d3f85b7bbc02", "body": "{\n \"location\": {\n \"address\": {\n \"address_line_1\": \"1234 Peachtree St. NE\",\n \"administrative_district_level_1\": \"GA\",\n \"locality\": \"Atlanta\",\n \"postal_code\": \"30309\"\n },\n \"capabilities\": [\n \"CREDIT_CARD_PROCESSING\"\n ],\n \"coordinates\": {\n \"latitude\": 33.788567,\n \"longitude\": -84.466947\n },\n \"country\": \"US\",\n \"created_at\": \"2019-07-19T17:58:25Z\",\n \"currency\": \"USD\",\n \"description\": \"My new location.\",\n \"id\": \"LOCATION_ID\",\n \"instagram_username\": \"instagram\",\n \"language_code\": \"en-US\",\n \"mcc\": \"1234\",\n \"merchant_id\": \"MERCHANT_ID\",\n \"name\": \"New location name\",\n \"status\": \"ACTIVE\",\n \"twitter_username\": \"twitter\",\n \"type\": \"PHYSICAL\",\n \"website_url\": \"examplewebsite.com\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "30c6e99e-e360-42bd-bd8d-11119d7adaaa", "documentation": "RetrieveLocation", "method": "get", "endpoint": "v2/locations/:location_id", "responses": [ { "uuid": "e76dbdbc-1bbf-4b61-9e09-0794da91d60c", "body": "{\n \"location\": {\n \"address\": {\n \"address_line_1\": \"123 Main St\",\n \"administrative_district_level_1\": \"CA\",\n \"country\": \"US\",\n \"locality\": \"San Francisco\",\n \"postal_code\": \"94114\"\n },\n \"business_name\": \"Jet Fuel Coffee\",\n \"capabilities\": [\n \"CREDIT_CARD_PROCESSING\"\n ],\n \"country\": \"US\",\n \"created_at\": \"2016-09-19T17:33:12Z\",\n \"currency\": \"USD\",\n \"id\": \"18YC4JDH91E1H\",\n \"language_code\": \"en-US\",\n \"merchant_id\": \"3MYCJG5GVYQ8Q\",\n \"name\": \"Jet Fuel Coffee - Grant Park\",\n \"phone_number\": \"+1 650-354-7217\",\n \"status\": \"ACTIVE\",\n \"timezone\": \"America/Los_Angeles\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "c3fd01f7-aab0-4596-923d-71afbd41ca27", "documentation": "UpdateLocation", "method": "put", "endpoint": "v2/locations/:location_id", "responses": [ { "uuid": "65c7c4dd-8924-4294-ac4a-e1a8b641ca0f", "body": "{\n \"location\": {\n \"address\": {\n \"address_line_1\": \"1234 Peachtree St. NE\",\n \"administrative_district_level_1\": \"GA\",\n \"locality\": \"Atlanta\",\n \"postal_code\": \"30309\"\n },\n \"business_email\": \"example@squareup.com\",\n \"business_hours\": {\n \"periods\": [\n {\n \"day_of_week\": \"MON\",\n \"end_local_time\": \"17:00\",\n \"start_local_time\": \"09:00\"\n }\n ]\n },\n \"business_name\": \"Business Name\",\n \"capabilities\": [\n \"CREDIT_CARD_PROCESSING\"\n ],\n \"coordinates\": {\n \"latitude\": 33.788567,\n \"longitude\": -84.466947\n },\n \"country\": \"US\",\n \"created_at\": \"2019-07-19T17:58:25Z\",\n \"currency\": \"USD\",\n \"description\": \"Updated description\",\n \"id\": \"LOCATION_ID\",\n \"instagram_username\": \"instagram\",\n \"language_code\": \"en-US\",\n \"mcc\": \"1234\",\n \"merchant_id\": \"MERCHANT_ID\",\n \"name\": \"Updated nickname\",\n \"phone_number\": \"5559211234\",\n \"status\": \"ACTIVE\",\n \"timezone\": \"America/New_York\",\n \"twitter_username\": \"twitter\",\n \"type\": \"MOBILE\",\n \"website_url\": \"examplewebsite.com\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "ba92d114-5478-48cb-9367-a390c8d9ab23", "documentation": "CreateCheckout", "method": "post", "endpoint": "v2/locations/:location_id/checkouts", "responses": [ { "uuid": "e1f069d3-2933-4174-bc2a-1b4331af708e", "body": "{\n \"checkout\": {\n \"additional_recipients\": [\n {\n \"amount_money\": {\n \"amount\": 60,\n \"currency\": \"USD\"\n },\n \"description\": \"Application fees\",\n \"location_id\": \"057P5VYJ4A5X1\"\n }\n ],\n \"ask_for_shipping_address\": true,\n \"checkout_page_url\": \"https://connect.squareup.com/v2/checkout?c=CAISEHGimXh-C3RIT4og1a6u1qw&l=CYTKRM7R7JMV8\",\n \"created_at\": \"2017-06-16T22:25:35Z\",\n \"id\": \"CAISEHGimXh-C3RIT4og1a6u1qw\",\n \"merchant_support_email\": \"merchant+support@website.com\",\n \"order\": {\n \"customer_id\": \"customer_id\",\n \"discounts\": [\n {\n \"amount_money\": {\n \"amount\": 100,\n \"currency\": \"USD\"\n },\n \"applied_money\": {\n \"amount\": 100,\n \"currency\": \"USD\"\n },\n \"scope\": \"LINE_ITEM\",\n \"type\": \"FIXED_AMOUNT\",\n \"uid\": \"56ae1696-z1e3-9328-af6d-f1e04d947gd4\"\n }\n ],\n \"line_items\": [\n {\n \"applied_discounts\": [\n {\n \"applied_money\": {\n \"amount\": 100,\n \"currency\": \"USD\"\n },\n \"discount_uid\": \"56ae1696-z1e3-9328-af6d-f1e04d947gd4\"\n }\n ],\n \"applied_taxes\": [\n {\n \"applied_money\": {\n \"amount\": 103,\n \"currency\": \"USD\"\n },\n \"tax_uid\": \"38ze1696-z1e3-5628-af6d-f1e04d947fg3\"\n }\n ],\n \"base_price_money\": {\n \"amount\": 1500,\n \"currency\": \"USD\"\n },\n \"name\": \"Printed T Shirt\",\n \"quantity\": \"2\",\n \"total_discount_money\": {\n \"amount\": 100,\n \"currency\": \"USD\"\n },\n \"total_money\": {\n \"amount\": 1503,\n \"currency\": \"USD\"\n },\n \"total_tax_money\": {\n \"amount\": 103,\n \"currency\": \"USD\"\n }\n },\n {\n \"base_price_money\": {\n \"amount\": 2500,\n \"currency\": \"USD\"\n },\n \"name\": \"Slim Jeans\",\n \"quantity\": \"1\",\n \"total_money\": {\n \"amount\": 2500,\n \"currency\": \"USD\"\n }\n },\n {\n \"base_price_money\": {\n \"amount\": 3500,\n \"currency\": \"USD\"\n },\n \"name\": \"Woven Sweater\",\n \"quantity\": \"3\",\n \"total_money\": {\n \"amount\": 10500,\n \"currency\": \"USD\"\n }\n }\n ],\n \"location_id\": \"location_id\",\n \"reference_id\": \"reference_id\",\n \"taxes\": [\n {\n \"percentage\": \"7.75\",\n \"scope\": \"LINE_ITEM\",\n \"type\": \"INCLUSIVE\",\n \"uid\": \"38ze1696-z1e3-5628-af6d-f1e04d947fg3\"\n }\n ],\n \"total_discount_money\": {\n \"amount\": 100,\n \"currency\": \"USD\"\n },\n \"total_money\": {\n \"amount\": 14503,\n \"currency\": \"USD\"\n },\n \"total_tax_money\": {\n \"amount\": 103,\n \"currency\": \"USD\"\n }\n },\n \"pre_populate_buyer_email\": \"example@email.com\",\n \"pre_populate_shipping_address\": {\n \"address_line_1\": \"1455 Market St.\",\n \"address_line_2\": \"Suite 600\",\n \"administrative_district_level_1\": \"CA\",\n \"country\": \"US\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"locality\": \"San Francisco\",\n \"postal_code\": \"94103\"\n },\n \"redirect_url\": \"https://merchant.website.com/order-confirm\",\n \"version\": 1\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "7a715798-1b72-45f8-bda4-b5acf8bbf118", "documentation": "ListRefunds", "method": "get", "endpoint": "v2/locations/:location_id/refunds", "responses": [ { "uuid": "1da16ac5-e6ac-4d1b-96ee-5e69ff277cc6", "body": "{\n \"refunds\": [\n {\n \"additional_recipients\": [\n {\n \"amount_money\": {\n \"amount\": 10,\n \"currency\": \"USD\"\n },\n \"description\": \"Application fees\",\n \"location_id\": \"057P5VYJ4A5X1\"\n }\n ],\n \"amount_money\": {\n \"amount\": 100,\n \"currency\": \"USD\"\n },\n \"created_at\": \"2016-01-20T00:28:18Z\",\n \"id\": \"b27436d1-7f8e-5610-45c6-417ef71434b4-SW\",\n \"location_id\": \"18YC4JDH91E1H\",\n \"reason\": \"some reason\",\n \"status\": \"APPROVED\",\n \"tender_id\": \"MtZRYYdDrYNQbOvV7nbuBvMF\",\n \"transaction_id\": \"KnL67ZIwXCPtzOrqj0HrkxMF\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "213fa164-cc28-4475-b83e-325e9134fa1a", "documentation": "ListTransactions", "method": "get", "endpoint": "v2/locations/:location_id/transactions", "responses": [ { "uuid": "788a9707-4669-437a-b767-b83d69520eeb", "body": "{\n \"transactions\": [\n {\n \"created_at\": \"2016-01-20T22:57:56Z\",\n \"id\": \"KnL67ZIwXCPtzOrqj0HrkxMF\",\n \"location_id\": \"18YC4JDH91E1H\",\n \"product\": \"EXTERNAL_API\",\n \"reference_id\": \"some optional reference id\",\n \"refunds\": [\n {\n \"additional_recipients\": [\n {\n \"amount_money\": {\n \"amount\": 100,\n \"currency\": \"USD\"\n },\n \"description\": \"Application fees\",\n \"location_id\": \"057P5VYJ4A5X1\"\n }\n ],\n \"amount_money\": {\n \"amount\": 5000,\n \"currency\": \"USD\"\n },\n \"created_at\": \"2016-01-20T22:59:20Z\",\n \"id\": \"7a5RcVI0CxbOcJ2wMOkE\",\n \"location_id\": \"18YC4JDH91E1H\",\n \"processing_fee_money\": {\n \"amount\": 138,\n \"currency\": \"USD\"\n },\n \"reason\": \"some reason why\",\n \"status\": \"APPROVED\",\n \"tender_id\": \"MtZRYYdDrYNQbOvV7nbuBvMF\",\n \"transaction_id\": \"KnL67ZIwXCPtzOrqj0HrkxMF\"\n }\n ],\n \"tenders\": [\n {\n \"additional_recipients\": [\n {\n \"amount_money\": {\n \"amount\": 20,\n \"currency\": \"USD\"\n },\n \"description\": \"Application fees\",\n \"location_id\": \"057P5VYJ4A5X1\"\n }\n ],\n \"amount_money\": {\n \"amount\": 5000,\n \"currency\": \"USD\"\n },\n \"card_details\": {\n \"card\": {\n \"card_brand\": \"VISA\",\n \"last_4\": \"1111\"\n },\n \"entry_method\": \"KEYED\",\n \"status\": \"CAPTURED\"\n },\n \"created_at\": \"2016-01-20T22:57:56Z\",\n \"id\": \"MtZRYYdDrYNQbOvV7nbuBvMF\",\n \"location_id\": \"18YC4JDH91E1H\",\n \"note\": \"some optional note\",\n \"processing_fee_money\": {\n \"amount\": 138,\n \"currency\": \"USD\"\n },\n \"transaction_id\": \"KnL67ZIwXCPtzOrqj0HrkxMF\",\n \"type\": \"CARD\"\n }\n ]\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "0916952c-b79e-415f-af05-212c46bba8f5", "documentation": "Charge", "method": "post", "endpoint": "v2/locations/:location_id/transactions", "responses": [ { "uuid": "a8a0f5a6-e6ab-4266-ab2b-295314164c8b", "body": "{\n \"transaction\": {\n \"created_at\": \"2016-03-10T22:57:56Z\",\n \"id\": \"KnL67ZIwXCPtzOrqj0HrkxMF\",\n \"location_id\": \"18YC4JDH91E1H\",\n \"product\": \"EXTERNAL_API\",\n \"reference_id\": \"some optional reference id\",\n \"tenders\": [\n {\n \"additional_recipients\": [\n {\n \"amount_money\": {\n \"amount\": 20,\n \"currency\": \"USD\"\n },\n \"description\": \"Application fees\",\n \"location_id\": \"057P5VYJ4A5X1\",\n \"receivable_id\": \"ISu5xwxJ5v0CMJTQq7RvqyMF\"\n }\n ],\n \"amount_money\": {\n \"amount\": 200,\n \"currency\": \"USD\"\n },\n \"card_details\": {\n \"card\": {\n \"card_brand\": \"VISA\",\n \"last_4\": \"1111\"\n },\n \"entry_method\": \"KEYED\",\n \"status\": \"CAPTURED\"\n },\n \"created_at\": \"2016-03-10T22:57:56Z\",\n \"id\": \"MtZRYYdDrYNQbOvV7nbuBvMF\",\n \"location_id\": \"18YC4JDH91E1H\",\n \"note\": \"some optional note\",\n \"transaction_id\": \"KnL67ZIwXCPtzOrqj0HrkxMF\",\n \"type\": \"CARD\"\n }\n ]\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "2d18bea5-2322-47e9-9868-b710e81d3e72", "documentation": "RetrieveTransaction", "method": "get", "endpoint": "v2/locations/:location_id/transactions/:transaction_id", "responses": [ { "uuid": "2d142f11-449f-40da-b930-459898e03766", "body": "{\n \"transaction\": {\n \"created_at\": \"2016-03-10T22:57:56Z\",\n \"id\": \"KnL67ZIwXCPtzOrqj0HrkxMF\",\n \"location_id\": \"18YC4JDH91E1H\",\n \"product\": \"EXTERNAL_API\",\n \"reference_id\": \"some optional reference id\",\n \"tenders\": [\n {\n \"additional_recipients\": [\n {\n \"amount_money\": {\n \"amount\": 20,\n \"currency\": \"USD\"\n },\n \"description\": \"Application fees\",\n \"location_id\": \"057P5VYJ4A5X1\"\n }\n ],\n \"amount_money\": {\n \"amount\": 5000,\n \"currency\": \"USD\"\n },\n \"card_details\": {\n \"card\": {\n \"card_brand\": \"VISA\",\n \"last_4\": \"1111\"\n },\n \"entry_method\": \"KEYED\",\n \"status\": \"CAPTURED\"\n },\n \"created_at\": \"2016-03-10T22:57:56Z\",\n \"id\": \"MtZRYYdDrYNQbOvV7nbuBvMF\",\n \"location_id\": \"18YC4JDH91E1H\",\n \"note\": \"some optional note\",\n \"processing_fee_money\": {\n \"amount\": 138,\n \"currency\": \"USD\"\n },\n \"transaction_id\": \"KnL67ZIwXCPtzOrqj0HrkxMF\",\n \"type\": \"CARD\"\n }\n ]\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "4c46e4de-70f3-409e-837a-7d4c3268f44f", "documentation": "CaptureTransaction", "method": "post", "endpoint": "v2/locations/:location_id/transactions/:transaction_id/capture", "responses": [ { "uuid": "4c205b09-8f26-4a5f-abfa-bc8aaf484b29", "body": "{}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "ee251219-6110-4445-98ac-19218378fd0b", "documentation": "CreateRefund", "method": "post", "endpoint": "v2/locations/:location_id/transactions/:transaction_id/refund", "responses": [ { "uuid": "d22fff49-8302-491d-bb40-8e8960694262", "body": "{\n \"refund\": {\n \"additional_recipients\": [\n {\n \"amount_money\": {\n \"amount\": 10,\n \"currency\": \"USD\"\n },\n \"description\": \"Application fees\",\n \"location_id\": \"057P5VYJ4A5X1\",\n \"receivable_id\": \"ISu5xwxJ5v0CMJTQq7RvqyMF\"\n }\n ],\n \"amount_money\": {\n \"amount\": 100,\n \"currency\": \"USD\"\n },\n \"created_at\": \"2016-02-12T00:28:18Z\",\n \"id\": \"b27436d1-7f8e-5610-45c6-417ef71434b4-SW\",\n \"location_id\": \"18YC4JDH91E1H\",\n \"reason\": \"some reason\",\n \"status\": \"PENDING\",\n \"tender_id\": \"MtZRYYdDrYNQbOvV7nbuBvMF\",\n \"transaction_id\": \"KnL67ZIwXCPtzOrqj0HrkxMF\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "1402496a-4ca8-44e1-a7bc-70e228a6f361", "documentation": "VoidTransaction", "method": "post", "endpoint": "v2/locations/:location_id/transactions/:transaction_id/void", "responses": [ { "uuid": "ffd028ed-977e-434e-8a1d-bf82f383b56b", "body": "{}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "5747b1d0-d5f6-4bac-b6b9-eddabe4ecae2", "documentation": "CreateLoyaltyAccount", "method": "post", "endpoint": "v2/loyalty/accounts", "responses": [ { "uuid": "fa39c321-375f-40ec-be2e-8638b96ea61c", "body": "{\n \"loyalty_account\": {\n \"balance\": 0,\n \"created_at\": \"2020-05-08T21:44:32Z\",\n \"id\": \"79b807d2-d786-46a9-933b-918028d7a8c5\",\n \"lifetime_points\": 0,\n \"mapping\": {\n \"created_at\": \"2020-05-08T21:44:32Z\",\n \"id\": \"66aaab3f-da99-49ed-8b19-b87f851c844f\",\n \"phone_number\": \"+14155551234\"\n },\n \"program_id\": \"d619f755-2d17-41f3-990d-c04ecedd64dd\",\n \"updated_at\": \"2020-05-08T21:44:32Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "b6cfb686-cae6-4a14-9d39-9cfdb9485749", "documentation": "SearchLoyaltyAccounts", "method": "post", "endpoint": "v2/loyalty/accounts/search", "responses": [ { "uuid": "7678fcd5-ad2b-4279-8440-402cc3749406", "body": "{\n \"loyalty_accounts\": [\n {\n \"balance\": 10,\n \"created_at\": \"2020-05-08T21:44:32Z\",\n \"customer_id\": \"Q8002FAM9V1EZ0ADB2T5609X6NET1H0\",\n \"id\": \"79b807d2-d786-46a9-933b-918028d7a8c5\",\n \"lifetime_points\": 20,\n \"mapping\": {\n \"created_at\": \"2020-05-08T21:44:32Z\",\n \"id\": \"66aaab3f-da99-49ed-8b19-b87f851c844f\",\n \"phone_number\": \"+14155551234\"\n },\n \"program_id\": \"d619f755-2d17-41f3-990d-c04ecedd64dd\",\n \"updated_at\": \"2020-05-08T21:44:32Z\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "b00ea34e-6052-4aae-9465-bea83737738b", "documentation": "RetrieveLoyaltyAccount", "method": "get", "endpoint": "v2/loyalty/accounts/:account_id", "responses": [ { "uuid": "6110d12c-a0a9-496b-8882-32e4e990e42b", "body": "{\n \"loyalty_account\": {\n \"balance\": 10,\n \"created_at\": \"2020-05-08T21:44:32Z\",\n \"customer_id\": \"Q8002FAM9V1EZ0ADB2T5609X6NET1H0\",\n \"id\": \"79b807d2-d786-46a9-933b-918028d7a8c5\",\n \"lifetime_points\": 20,\n \"mapping\": {\n \"created_at\": \"2020-05-08T21:44:32Z\",\n \"id\": \"66aaab3f-da99-49ed-8b19-b87f851c844f\",\n \"phone_number\": \"+14155551234\"\n },\n \"program_id\": \"d619f755-2d17-41f3-990d-c04ecedd64dd\",\n \"updated_at\": \"2020-05-08T21:44:32Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "b6c3a98f-3640-40fe-a020-64d78e59fc5b", "documentation": "AccumulateLoyaltyPoints", "method": "post", "endpoint": "v2/loyalty/accounts/:account_id/accumulate", "responses": [ { "uuid": "049f6438-79fb-478f-8fe0-37be91e21576", "body": "{\n \"event\": {\n \"accumulate_points\": {\n \"loyalty_program_id\": \"d619f755-2d17-41f3-990d-c04ecedd64dd\",\n \"order_id\": \"RFZfrdtm3mhO1oGzf5Cx7fEMsmGZY\",\n \"points\": 6\n },\n \"created_at\": \"2020-05-08T21:41:12Z\",\n \"id\": \"ee46aafd-1af6-3695-a385-276e2ef0be26\",\n \"location_id\": \"P034NEENMD09F\",\n \"loyalty_account_id\": \"5adcb100-07f1-4ee7-b8c6-6bb9ebc474bd\",\n \"source\": \"LOYALTY_API\",\n \"type\": \"ACCUMULATE_POINTS\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "1e0bdbd7-284d-4cb9-a855-e195306f951a", "documentation": "AdjustLoyaltyPoints", "method": "post", "endpoint": "v2/loyalty/accounts/:account_id/adjust", "responses": [ { "uuid": "051e73aa-fed9-4045-87ff-6e4203c27690", "body": "{\n \"event\": {\n \"adjust_points\": {\n \"loyalty_program_id\": \"d619f755-2d17-41f3-990d-c04ecedd64dd\",\n \"points\": 10,\n \"reason\": \"Complimentary points\"\n },\n \"created_at\": \"2020-05-08T21:42:32Z\",\n \"id\": \"613a6fca-8d67-39d0-bad2-3b4bc45c8637\",\n \"loyalty_account_id\": \"5adcb100-07f1-4ee7-b8c6-6bb9ebc474bd\",\n \"source\": \"LOYALTY_API\",\n \"type\": \"ADJUST_POINTS\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "28b6f482-e0d9-4358-9847-f9d8bee1c86b", "documentation": "SearchLoyaltyEvents", "method": "post", "endpoint": "v2/loyalty/events/search", "responses": [ { "uuid": "17211399-1a6f-4168-9085-02355c2024b3", "body": "{\n \"events\": [\n {\n \"accumulate_points\": {\n \"loyalty_program_id\": \"d619f755-2d17-41f3-990d-c04ecedd64dd\",\n \"order_id\": \"PyATxhYLfsMqpVkcKJITPydgEYfZY\",\n \"points\": 5\n },\n \"created_at\": \"2020-05-08T22:01:30Z\",\n \"id\": \"c27c8465-806e-36f2-b4b3-71f5887b5ba8\",\n \"location_id\": \"P034NEENMD09F\",\n \"loyalty_account_id\": \"5adcb100-07f1-4ee7-b8c6-6bb9ebc474bd\",\n \"source\": \"LOYALTY_API\",\n \"type\": \"ACCUMULATE_POINTS\"\n },\n {\n \"created_at\": \"2020-05-08T22:01:15Z\",\n \"id\": \"e4a5cbc3-a4d0-3779-98e9-e578885d9430\",\n \"location_id\": \"P034NEENMD09F\",\n \"loyalty_account_id\": \"5adcb100-07f1-4ee7-b8c6-6bb9ebc474bd\",\n \"redeem_reward\": {\n \"loyalty_program_id\": \"d619f755-2d17-41f3-990d-c04ecedd64dd\",\n \"order_id\": \"PyATxhYLfsMqpVkcKJITPydgEYfZY\",\n \"reward_id\": \"d03f79f4-815f-3500-b851-cc1e68a457f9\"\n },\n \"source\": \"LOYALTY_API\",\n \"type\": \"REDEEM_REWARD\"\n },\n {\n \"create_reward\": {\n \"loyalty_program_id\": \"d619f755-2d17-41f3-990d-c04ecedd64dd\",\n \"points\": -10,\n \"reward_id\": \"d03f79f4-815f-3500-b851-cc1e68a457f9\"\n },\n \"created_at\": \"2020-05-08T22:00:44Z\",\n \"id\": \"5e127479-0b03-3671-ab1e-15faea8b7188\",\n \"loyalty_account_id\": \"5adcb100-07f1-4ee7-b8c6-6bb9ebc474bd\",\n \"source\": \"LOYALTY_API\",\n \"type\": \"CREATE_REWARD\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "eb811ace-8d96-4506-b0f9-50aab6d90b27", "documentation": "ListLoyaltyPrograms", "method": "get", "endpoint": "v2/loyalty/programs", "responses": [ { "uuid": "4a86de19-1e34-49fb-b999-76a8cc7ef5bf", "body": "{\n \"programs\": [\n {\n \"accrual_rules\": [\n {\n \"accrual_type\": \"SPEND\",\n \"excluded_category_ids\": [\n \"7ZERJKO5PVYXCVUHV2JCZ2UG\",\n \"FQKAOJE5C4FIMF5A2URMLW6V\"\n ],\n \"excluded_item_variation_ids\": [\n \"CBZXBUVVTYUBZGQO44RHMR6B\",\n \"EDILT24Z2NISEXDKGY6HP7XV\"\n ],\n \"points\": 1,\n \"spend_amount_money\": {\n \"amount\": 100\n }\n }\n ],\n \"created_at\": \"2020-04-20T16:55:11Z\",\n \"id\": \"d619f755-2d17-41f3-990d-c04ecedd64dd\",\n \"location_ids\": [\n \"P034NEENMD09F\"\n ],\n \"reward_tiers\": [\n {\n \"created_at\": \"2020-04-20T16:55:11Z\",\n \"definition\": {\n \"discount_type\": \"FIXED_PERCENTAGE\",\n \"percentage_discount\": \"10\",\n \"scope\": \"ORDER\"\n },\n \"id\": \"e1b39225-9da5-43d1-a5db-782cdd8ad94f\",\n \"name\": \"10% off entire sale\",\n \"points\": 10,\n \"pricing_rule_reference\": {\n \"catalog_version\": \"1605486402527\",\n \"object_id\": \"74C4JSHESNLTB2A7ITO5HO6F\"\n }\n }\n ],\n \"status\": \"ACTIVE\",\n \"terminology\": {\n \"one\": \"Point\",\n \"other\": \"Points\"\n },\n \"updated_at\": \"2020-05-01T02:00:02Z\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "7e4090dd-49a0-4794-b642-c7da90e5477d", "documentation": "RetrieveLoyaltyProgram", "method": "get", "endpoint": "v2/loyalty/programs/:program_id", "responses": [ { "uuid": "0a410592-a0be-49c6-b97e-11f34209d651", "body": "{\n \"program\": {\n \"accrual_rules\": [\n {\n \"accrual_type\": \"SPEND\",\n \"excluded_category_ids\": [\n \"7ZERJKO5PVYXCVUHV2JCZ2UG\",\n \"FQKAOJE5C4FIMF5A2URMLW6V\"\n ],\n \"excluded_item_variation_ids\": [\n \"CBZXBUVVTYUBZGQO44RHMR6B\",\n \"EDILT24Z2NISEXDKGY6HP7XV\"\n ],\n \"points\": 1,\n \"spend_amount_money\": {\n \"amount\": 100\n }\n }\n ],\n \"created_at\": \"2020-04-20T16:55:11Z\",\n \"id\": \"d619f755-2d17-41f3-990d-c04ecedd64dd\",\n \"location_ids\": [\n \"P034NEENMD09F\"\n ],\n \"reward_tiers\": [\n {\n \"created_at\": \"2020-04-20T16:55:11Z\",\n \"definition\": {\n \"discount_type\": \"FIXED_PERCENTAGE\",\n \"percentage_discount\": \"10\",\n \"scope\": \"ORDER\"\n },\n \"id\": \"e1b39225-9da5-43d1-a5db-782cdd8ad94f\",\n \"name\": \"10% off entire sale\",\n \"points\": 10,\n \"pricing_rule_reference\": {\n \"catalog_version\": \"1605486402527\",\n \"object_id\": \"74C4JSHESNLTB2A7ITO5HO6F\"\n }\n }\n ],\n \"status\": \"ACTIVE\",\n \"terminology\": {\n \"one\": \"Point\",\n \"other\": \"Points\"\n },\n \"updated_at\": \"2020-05-01T02:00:02Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "ad7f9681-416e-4eed-8cc9-7216c64c86b2", "documentation": "CalculateLoyaltyPoints", "method": "post", "endpoint": "v2/loyalty/programs/:program_id/calculate", "responses": [ { "uuid": "fd6f9c4b-f129-4a3e-ae60-1a36c943374f", "body": "{\n \"points\": 6\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "d0f64f52-69b1-49a0-a3a9-fd8dabbfbb9a", "documentation": "CreateLoyaltyReward", "method": "post", "endpoint": "v2/loyalty/rewards", "responses": [ { "uuid": "a631e437-c36d-4969-8152-ded3e0b657eb", "body": "{\n \"reward\": {\n \"created_at\": \"2020-05-01T21:49:54Z\",\n \"id\": \"a8f43ebe-2ad6-3001-bdd5-7d7c2da08943\",\n \"loyalty_account_id\": \"5adcb100-07f1-4ee7-b8c6-6bb9ebc474bd\",\n \"order_id\": \"RFZfrdtm3mhO1oGzf5Cx7fEMsmGZY\",\n \"points\": 10,\n \"reward_tier_id\": \"e1b39225-9da5-43d1-a5db-782cdd8ad94f\",\n \"status\": \"ISSUED\",\n \"updated_at\": \"2020-05-01T21:49:54Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "0a8de7e3-f202-4cf3-8bb9-6557e031be01", "documentation": "SearchLoyaltyRewards", "method": "post", "endpoint": "v2/loyalty/rewards/search", "responses": [ { "uuid": "16a6cc1b-c091-46d2-ad6f-6a75e05ee14d", "body": "{\n \"rewards\": [\n {\n \"created_at\": \"2020-05-08T22:00:44Z\",\n \"id\": \"d03f79f4-815f-3500-b851-cc1e68a457f9\",\n \"loyalty_account_id\": \"5adcb100-07f1-4ee7-b8c6-6bb9ebc474bd\",\n \"order_id\": \"PyATxhYLfsMqpVkcKJITPydgEYfZY\",\n \"points\": 10,\n \"redeemed_at\": \"2020-05-08T22:01:17Z\",\n \"reward_tier_id\": \"e1b39225-9da5-43d1-a5db-782cdd8ad94f\",\n \"status\": \"REDEEMED\",\n \"updated_at\": \"2020-05-08T22:01:17Z\"\n },\n {\n \"created_at\": \"2020-05-08T21:55:42Z\",\n \"id\": \"9f18ac21-233a-31c3-be77-b45840f5a810\",\n \"loyalty_account_id\": \"5adcb100-07f1-4ee7-b8c6-6bb9ebc474bd\",\n \"points\": 10,\n \"redeemed_at\": \"2020-05-08T21:56:00Z\",\n \"reward_tier_id\": \"e1b39225-9da5-43d1-a5db-782cdd8ad94f\",\n \"status\": \"REDEEMED\",\n \"updated_at\": \"2020-05-08T21:56:00Z\"\n },\n {\n \"created_at\": \"2020-05-01T21:49:54Z\",\n \"id\": \"a8f43ebe-2ad6-3001-bdd5-7d7c2da08943\",\n \"loyalty_account_id\": \"5adcb100-07f1-4ee7-b8c6-6bb9ebc474bd\",\n \"order_id\": \"5NB69ZNh3FbsOs1ox43bh1xrli6YY\",\n \"points\": 10,\n \"reward_tier_id\": \"e1b39225-9da5-43d1-a5db-782cdd8ad94f\",\n \"status\": \"DELETED\",\n \"updated_at\": \"2020-05-08T21:55:10Z\"\n },\n {\n \"created_at\": \"2020-05-01T20:20:37Z\",\n \"id\": \"a051254c-f840-3b45-8cf1-50bcd38ff92a\",\n \"loyalty_account_id\": \"5adcb100-07f1-4ee7-b8c6-6bb9ebc474bd\",\n \"order_id\": \"LQQ16znvi2VIUKPVhUfJefzr1eEZY\",\n \"points\": 10,\n \"reward_tier_id\": \"e1b39225-9da5-43d1-a5db-782cdd8ad94f\",\n \"status\": \"ISSUED\",\n \"updated_at\": \"2020-05-01T20:20:40Z\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "b2dedead-ffff-470e-b68e-1e4dedd01aa0", "documentation": "DeleteLoyaltyReward", "method": "delete", "endpoint": "v2/loyalty/rewards/:reward_id", "responses": [ { "uuid": "a9dbc6ff-d78a-4298-9f37-5f60d348dc5f", "body": "{}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "d9c8ef64-4ac7-4ba3-b35b-828641c89455", "documentation": "RetrieveLoyaltyReward", "method": "get", "endpoint": "v2/loyalty/rewards/:reward_id", "responses": [ { "uuid": "30b61f40-fe19-4c06-9ece-cbf6dc6559f5", "body": "{\n \"reward\": {\n \"created_at\": \"2020-05-08T21:55:42Z\",\n \"id\": \"9f18ac21-233a-31c3-be77-b45840f5a810\",\n \"loyalty_account_id\": \"5adcb100-07f1-4ee7-b8c6-6bb9ebc474bd\",\n \"points\": 10,\n \"redeemed_at\": \"2020-05-08T21:56:00Z\",\n \"reward_tier_id\": \"e1b39225-9da5-43d1-a5db-782cdd8ad94f\",\n \"status\": \"REDEEMED\",\n \"updated_at\": \"2020-05-08T21:56:00Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "45e5110c-4281-4bd9-9933-e74cc2b0cb4d", "documentation": "RedeemLoyaltyReward", "method": "post", "endpoint": "v2/loyalty/rewards/:reward_id/redeem", "responses": [ { "uuid": "5283d4f8-47f9-43ba-bb85-009894efbbd6", "body": "{\n \"event\": {\n \"created_at\": \"2020-05-08T21:56:00Z\",\n \"id\": \"67377a6e-dbdc-369d-aa16-2e7ed422e71f\",\n \"location_id\": \"P034NEENMD09F\",\n \"loyalty_account_id\": \"5adcb100-07f1-4ee7-b8c6-6bb9ebc474bd\",\n \"redeem_reward\": {\n \"loyalty_program_id\": \"d619f755-2d17-41f3-990d-c04ecedd64dd\",\n \"reward_id\": \"9f18ac21-233a-31c3-be77-b45840f5a810\"\n },\n \"source\": \"LOYALTY_API\",\n \"type\": \"REDEEM_REWARD\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "db4c8466-a2e2-4417-a7e0-530f5bd1bde3", "documentation": "ListMerchants", "method": "get", "endpoint": "v2/merchants", "responses": [ { "uuid": "a6b5a206-5e99-426f-a71f-c36a7f400cca", "body": "{\n \"merchant\": [\n {\n \"business_name\": \"Apple A Day\",\n \"country\": \"US\",\n \"currency\": \"USD\",\n \"id\": \"DM7VKY8Q63GNP\",\n \"language_code\": \"en-US\",\n \"main_location_id\": \"9A65CGC72ZQG1\",\n \"status\": \"ACTIVE\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "dfce0b65-0e13-4935-8909-f6b7390d40c6", "documentation": "RetrieveMerchant", "method": "get", "endpoint": "v2/merchants/:merchant_id", "responses": [ { "uuid": "4c8d2070-70c4-4fb7-9022-19353d3ddd1a", "body": "{\n \"merchant\": {\n \"business_name\": \"Apple A Day\",\n \"country\": \"US\",\n \"currency\": \"USD\",\n \"id\": \"DM7VKY8Q63GNP\",\n \"language_code\": \"en-US\",\n \"main_location_id\": \"9A65CGC72ZQG1\",\n \"status\": \"ACTIVE\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "5841d66f-6ba2-423b-941b-2ececcfacbbb", "documentation": "CreateOrder", "method": "post", "endpoint": "v2/orders", "responses": [ { "uuid": "67daf5d0-439c-43f3-9627-1368e4869ebc", "body": "{\n \"order\": {\n \"created_at\": \"2020-01-17T20:47:53.293Z\",\n \"discounts\": [\n {\n \"applied_money\": {\n \"amount\": 30,\n \"currency\": \"USD\"\n },\n \"catalog_object_id\": \"DB7L55ZH2BGWI4H23ULIWOQ7\",\n \"name\": \"Membership Discount\",\n \"percentage\": \"0.5\",\n \"scope\": \"ORDER\",\n \"type\": \"FIXED_PERCENTAGE\",\n \"uid\": \"membership-discount\"\n },\n {\n \"applied_money\": {\n \"amount\": 303,\n \"currency\": \"USD\"\n },\n \"name\": \"Labor Day Sale\",\n \"percentage\": \"5\",\n \"scope\": \"ORDER\",\n \"type\": \"FIXED_PERCENTAGE\",\n \"uid\": \"labor-day-sale\"\n },\n {\n \"amount_money\": {\n \"amount\": 100,\n \"currency\": \"USD\"\n },\n \"applied_money\": {\n \"amount\": 100,\n \"currency\": \"USD\"\n },\n \"name\": \"Sale - $1.00 off\",\n \"scope\": \"LINE_ITEM\",\n \"type\": \"FIXED_AMOUNT\",\n \"uid\": \"one-dollar-off\"\n }\n ],\n \"id\": \"CAISENgvlJ6jLWAzERDzjyHVybY\",\n \"line_items\": [\n {\n \"applied_discounts\": [\n {\n \"applied_money\": {\n \"amount\": 8,\n \"currency\": \"USD\"\n },\n \"discount_uid\": \"membership-discount\",\n \"uid\": \"jWdgP1TpHPFBuVrz81mXVC\"\n },\n {\n \"applied_money\": {\n \"amount\": 79,\n \"currency\": \"USD\"\n },\n \"discount_uid\": \"labor-day-sale\",\n \"uid\": \"jnZOjjVY57eRcQAVgEwFuC\"\n }\n ],\n \"applied_taxes\": [\n {\n \"applied_money\": {\n \"amount\": 136,\n \"currency\": \"USD\"\n },\n \"tax_uid\": \"state-sales-tax\",\n \"uid\": \"aKG87ArnDpvMLSZJHxWUl\"\n }\n ],\n \"base_price_money\": {\n \"amount\": 1599,\n \"currency\": \"USD\"\n },\n \"gross_sales_money\": {\n \"amount\": 1599,\n \"currency\": \"USD\"\n },\n \"name\": \"New York Strip Steak\",\n \"quantity\": \"1\",\n \"total_discount_money\": {\n \"amount\": 87,\n \"currency\": \"USD\"\n },\n \"total_money\": {\n \"amount\": 1648,\n \"currency\": \"USD\"\n },\n \"total_tax_money\": {\n \"amount\": 136,\n \"currency\": \"USD\"\n },\n \"uid\": \"8uSwfzvUImn3IRrvciqlXC\",\n \"variation_total_price_money\": {\n \"amount\": 1599,\n \"currency\": \"USD\"\n }\n },\n {\n \"applied_discounts\": [\n {\n \"applied_money\": {\n \"amount\": 22,\n \"currency\": \"USD\"\n },\n \"discount_uid\": \"membership-discount\",\n \"uid\": \"nUXvdsIItfKko0dbYtY58C\"\n },\n {\n \"applied_money\": {\n \"amount\": 224,\n \"currency\": \"USD\"\n },\n \"discount_uid\": \"labor-day-sale\",\n \"uid\": \"qSdkOOOernlVQqsJ94SPjB\"\n },\n {\n \"applied_money\": {\n \"amount\": 100,\n \"currency\": \"USD\"\n },\n \"discount_uid\": \"one-dollar-off\",\n \"uid\": \"y7bVl4njrWAnfDwmz19izB\"\n }\n ],\n \"applied_taxes\": [\n {\n \"applied_money\": {\n \"amount\": 374,\n \"currency\": \"USD\"\n },\n \"tax_uid\": \"state-sales-tax\",\n \"uid\": \"v1dAgrfUVUPTnVTf9sRPz\"\n }\n ],\n \"base_price_money\": {\n \"amount\": 2200,\n \"currency\": \"USD\"\n },\n \"catalog_object_id\": \"BEMYCSMIJL46OCDV4KYIKXIB\",\n \"gross_sales_money\": {\n \"amount\": 4500,\n \"currency\": \"USD\"\n },\n \"modifiers\": [\n {\n \"base_price_money\": {\n \"amount\": 50,\n \"currency\": \"USD\"\n },\n \"catalog_object_id\": \"CHQX7Y4KY6N5KINJKZCFURPZ\",\n \"name\": \"Well\",\n \"total_price_money\": {\n \"amount\": 100,\n \"currency\": \"USD\"\n },\n \"uid\": \"Lo3qMMckDluu9Qsb58d4CC\"\n }\n ],\n \"name\": \"New York Steak\",\n \"quantity\": \"2\",\n \"total_discount_money\": {\n \"amount\": 346,\n \"currency\": \"USD\"\n },\n \"total_money\": {\n \"amount\": 4528,\n \"currency\": \"USD\"\n },\n \"total_tax_money\": {\n \"amount\": 374,\n \"currency\": \"USD\"\n },\n \"uid\": \"v8ZuEXpOJpb0bazLuvrLDB\",\n \"variation_name\": \"Larger\",\n \"variation_total_price_money\": {\n \"amount\": 4400,\n \"currency\": \"USD\"\n }\n }\n ],\n \"location_id\": \"057P5VYJ4A5X1\",\n \"net_amounts\": {\n \"discount_money\": {\n \"amount\": 433,\n \"currency\": \"USD\"\n },\n \"service_charge_money\": {\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n \"tax_money\": {\n \"amount\": 510,\n \"currency\": \"USD\"\n },\n \"tip_money\": {\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n \"total_money\": {\n \"amount\": 6176,\n \"currency\": \"USD\"\n }\n },\n \"reference_id\": \"my-order-001\",\n \"source\": {\n \"name\": \"My App\"\n },\n \"state\": \"OPEN\",\n \"taxes\": [\n {\n \"applied_money\": {\n \"amount\": 510,\n \"currency\": \"USD\"\n },\n \"name\": \"State Sales Tax\",\n \"percentage\": \"9\",\n \"scope\": \"ORDER\",\n \"type\": \"ADDITIVE\",\n \"uid\": \"state-sales-tax\"\n }\n ],\n \"total_discount_money\": {\n \"amount\": 433,\n \"currency\": \"USD\"\n },\n \"total_money\": {\n \"amount\": 6176,\n \"currency\": \"USD\"\n },\n \"total_service_charge_money\": {\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n \"total_tax_money\": {\n \"amount\": 510,\n \"currency\": \"USD\"\n },\n \"total_tip_money\": {\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n \"updated_at\": \"2020-01-17T20:47:53.293Z\",\n \"version\": 1\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "7dd880c1-c296-4c70-9058-1a02b2bee7f5", "documentation": "BatchRetrieveOrders", "method": "post", "endpoint": "v2/orders/batch-retrieve", "responses": [ { "uuid": "5667b75a-9f11-4fcb-8461-622e34965c51", "body": "{\n \"orders\": [\n {\n \"id\": \"CAISEM82RcpmcFBM0TfOyiHV3es\",\n \"line_items\": [\n {\n \"base_price_money\": {\n \"amount\": 1599,\n \"currency\": \"USD\"\n },\n \"name\": \"Awesome product\",\n \"quantity\": \"1\",\n \"total_money\": {\n \"amount\": 1599,\n \"currency\": \"USD\"\n },\n \"uid\": \"945986d1-9586-11e6-ad5a-28cfe92138cf\"\n },\n {\n \"base_price_money\": {\n \"amount\": 2000,\n \"currency\": \"USD\"\n },\n \"name\": \"Another awesome product\",\n \"quantity\": \"3\",\n \"total_money\": {\n \"amount\": 6000,\n \"currency\": \"USD\"\n },\n \"uid\": \"a8f4168c-9586-11e6-bdf0-28cfe92138cf\"\n }\n ],\n \"location_id\": \"057P5VYJ4A5X1\",\n \"reference_id\": \"my-order-001\",\n \"total_money\": {\n \"amount\": 7599,\n \"currency\": \"USD\"\n }\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "327add72-ae50-4cc6-ad8c-fe0bd8bdb9f5", "documentation": "CalculateOrder", "method": "post", "endpoint": "v2/orders/calculate", "responses": [ { "uuid": "2dd09776-9ebb-43f9-9a5a-5f0889bdfd7b", "body": "{\n \"order\": {\n \"created_at\": \"2020-05-18T16:30:49.614Z\",\n \"discounts\": [\n {\n \"applied_money\": {\n \"amount\": 550,\n \"currency\": \"USD\"\n },\n \"name\": \"50% Off\",\n \"percentage\": \"50\",\n \"scope\": \"ORDER\",\n \"type\": \"FIXED_PERCENTAGE\",\n \"uid\": \"zGsRZP69aqSSR9lq9euSPB\"\n }\n ],\n \"line_items\": [\n {\n \"applied_discounts\": [\n {\n \"applied_money\": {\n \"amount\": 250,\n \"currency\": \"USD\"\n },\n \"discount_uid\": \"zGsRZP69aqSSR9lq9euSPB\",\n \"uid\": \"9zr9S4dxvPAixvn0lpa1VC\"\n }\n ],\n \"base_price_money\": {\n \"amount\": 500,\n \"currency\": \"USD\"\n },\n \"gross_sales_money\": {\n \"amount\": 500,\n \"currency\": \"USD\"\n },\n \"name\": \"Item 1\",\n \"quantity\": \"1\",\n \"total_discount_money\": {\n \"amount\": 250,\n \"currency\": \"USD\"\n },\n \"total_money\": {\n \"amount\": 250,\n \"currency\": \"USD\"\n },\n \"total_tax_money\": {\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n \"uid\": \"ULkg0tQTRK2bkU9fNv3IJD\",\n \"variation_total_price_money\": {\n \"amount\": 500,\n \"currency\": \"USD\"\n }\n },\n {\n \"applied_discounts\": [\n {\n \"applied_money\": {\n \"amount\": 300,\n \"currency\": \"USD\"\n },\n \"discount_uid\": \"zGsRZP69aqSSR9lq9euSPB\",\n \"uid\": \"qa8LwwZK82FgSEkQc2HYVC\"\n }\n ],\n \"base_price_money\": {\n \"amount\": 300,\n \"currency\": \"USD\"\n },\n \"gross_sales_money\": {\n \"amount\": 600,\n \"currency\": \"USD\"\n },\n \"name\": \"Item 2\",\n \"quantity\": \"2\",\n \"total_discount_money\": {\n \"amount\": 300,\n \"currency\": \"USD\"\n },\n \"total_money\": {\n \"amount\": 300,\n \"currency\": \"USD\"\n },\n \"total_tax_money\": {\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n \"uid\": \"mumY8Nun4BC5aKe2yyx5a\",\n \"variation_total_price_money\": {\n \"amount\": 600,\n \"currency\": \"USD\"\n }\n }\n ],\n \"location_id\": \"D7AVYMEAPJ3A3\",\n \"net_amounts\": {\n \"discount_money\": {\n \"amount\": 550,\n \"currency\": \"USD\"\n },\n \"service_charge_money\": {\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n \"tax_money\": {\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n \"tip_money\": {\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n \"total_money\": {\n \"amount\": 550,\n \"currency\": \"USD\"\n }\n },\n \"state\": \"OPEN\",\n \"total_discount_money\": {\n \"amount\": 550,\n \"currency\": \"USD\"\n },\n \"total_money\": {\n \"amount\": 550,\n \"currency\": \"USD\"\n },\n \"total_service_charge_money\": {\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n \"total_tax_money\": {\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n \"total_tip_money\": {\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n \"updated_at\": \"2020-05-18T16:30:49.614Z\",\n \"version\": 1\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "51e47542-e500-4919-bc5e-c3cc2574f101", "documentation": "SearchOrders", "method": "post", "endpoint": "v2/orders/search", "responses": [ { "uuid": "e1d85598-b871-4ae4-88d3-21672da3414e", "body": "{\n \"cursor\": \"123\",\n \"order_entries\": [\n {\n \"location_id\": \"057P5VYJ4A5X1\",\n \"order_id\": \"CAISEM82RcpmcFBM0TfOyiHV3es\",\n \"version\": 1\n },\n {\n \"location_id\": \"18YC4JDH91E1H\",\n \"order_id\": \"CAISENgvlJ6jLWAzERDzjyHVybY\"\n },\n {\n \"location_id\": \"057P5VYJ4A5X1\",\n \"order_id\": \"CAISEM52YcpmcWAzERDOyiWS3ty\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "64b62c73-eb82-4448-abbf-e2195c25b551", "documentation": "RetrieveOrder", "method": "get", "endpoint": "v2/orders/:order_id", "responses": [ { "uuid": "07b49e70-4664-43c7-9adb-a7e1de004681", "body": "{\n \"order\": {\n \"created_at\": \"2020-05-18T16:30:49.614Z\",\n \"discounts\": [\n {\n \"applied_money\": {\n \"amount\": 550,\n \"currency\": \"USD\"\n },\n \"name\": \"50% Off\",\n \"percentage\": \"50\",\n \"scope\": \"ORDER\",\n \"type\": \"FIXED_PERCENTAGE\",\n \"uid\": \"zGsRZP69aqSSR9lq9euSPB\"\n }\n ],\n \"id\": \"CAISENgvlJ6jLWAzERDzjyHVybY\",\n \"line_items\": [\n {\n \"applied_discounts\": [\n {\n \"applied_money\": {\n \"amount\": 250,\n \"currency\": \"USD\"\n },\n \"discount_uid\": \"zGsRZP69aqSSR9lq9euSPB\",\n \"uid\": \"9zr9S4dxvPAixvn0lpa1VC\"\n }\n ],\n \"base_price_money\": {\n \"amount\": 500,\n \"currency\": \"USD\"\n },\n \"gross_sales_money\": {\n \"amount\": 500,\n \"currency\": \"USD\"\n },\n \"name\": \"Item 1\",\n \"quantity\": \"1\",\n \"total_discount_money\": {\n \"amount\": 250,\n \"currency\": \"USD\"\n },\n \"total_money\": {\n \"amount\": 250,\n \"currency\": \"USD\"\n },\n \"total_tax_money\": {\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n \"uid\": \"ULkg0tQTRK2bkU9fNv3IJD\",\n \"variation_total_price_money\": {\n \"amount\": 500,\n \"currency\": \"USD\"\n }\n },\n {\n \"applied_discounts\": [\n {\n \"applied_money\": {\n \"amount\": 300,\n \"currency\": \"USD\"\n },\n \"discount_uid\": \"zGsRZP69aqSSR9lq9euSPB\",\n \"uid\": \"qa8LwwZK82FgSEkQc2HYVC\"\n }\n ],\n \"base_price_money\": {\n \"amount\": 300,\n \"currency\": \"USD\"\n },\n \"gross_sales_money\": {\n \"amount\": 600,\n \"currency\": \"USD\"\n },\n \"name\": \"Item 2\",\n \"quantity\": \"2\",\n \"total_discount_money\": {\n \"amount\": 300,\n \"currency\": \"USD\"\n },\n \"total_money\": {\n \"amount\": 300,\n \"currency\": \"USD\"\n },\n \"total_tax_money\": {\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n \"uid\": \"mumY8Nun4BC5aKe2yyx5a\",\n \"variation_total_price_money\": {\n \"amount\": 600,\n \"currency\": \"USD\"\n }\n }\n ],\n \"location_id\": \"D7AVYMEAPJ3A3\",\n \"net_amounts\": {\n \"discount_money\": {\n \"amount\": 550,\n \"currency\": \"USD\"\n },\n \"service_charge_money\": {\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n \"tax_money\": {\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n \"tip_money\": {\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n \"total_money\": {\n \"amount\": 550,\n \"currency\": \"USD\"\n }\n },\n \"state\": \"OPEN\",\n \"total_discount_money\": {\n \"amount\": 550,\n \"currency\": \"USD\"\n },\n \"total_money\": {\n \"amount\": 550,\n \"currency\": \"USD\"\n },\n \"total_service_charge_money\": {\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n \"total_tax_money\": {\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n \"total_tip_money\": {\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n \"updated_at\": \"2020-05-18T16:30:49.614Z\",\n \"version\": 1\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "7f13195a-6a99-4bde-82cb-97ffba3252db", "documentation": "UpdateOrder", "method": "put", "endpoint": "v2/orders/:order_id", "responses": [ { "uuid": "52f8f547-9bba-4a20-95c7-265ea36b5414", "body": "{\n \"order\": {\n \"created_at\": \"2019-08-23T18:26:18.243Z\",\n \"id\": \"DREk7wJcyXNHqULq8JJ2iPAsluJZY\",\n \"line_items\": [\n {\n \"base_price_money\": {\n \"amount\": 500,\n \"currency\": \"USD\"\n },\n \"gross_sales_money\": {\n \"amount\": 500,\n \"currency\": \"USD\"\n },\n \"name\": \"Small Coffee\",\n \"quantity\": \"1\",\n \"total_discount_money\": {\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n \"total_money\": {\n \"amount\": 500,\n \"currency\": \"USD\"\n },\n \"total_tax_money\": {\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n \"uid\": \"EuYkakhmu3ksHIds5Hiot\",\n \"variation_total_price_money\": {\n \"amount\": 500,\n \"currency\": \"USD\"\n }\n },\n {\n \"base_price_money\": {\n \"amount\": 200,\n \"currency\": \"USD\"\n },\n \"gross_sales_money\": {\n \"amount\": 400,\n \"currency\": \"USD\"\n },\n \"name\": \"COOKIE\",\n \"quantity\": \"2\",\n \"total_discount_money\": {\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n \"total_money\": {\n \"amount\": 400,\n \"currency\": \"USD\"\n },\n \"total_tax_money\": {\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n \"uid\": \"cookie_uid\",\n \"variation_total_price_money\": {\n \"amount\": 400,\n \"currency\": \"USD\"\n }\n }\n ],\n \"location_id\": \"MXVQSVNDGN3C8\",\n \"net_amounts\": {\n \"discount_money\": {\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n \"service_charge_money\": {\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n \"tax_money\": {\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n \"total_money\": {\n \"amount\": 900,\n \"currency\": \"USD\"\n }\n },\n \"source\": {\n \"name\": \"Cookies\"\n },\n \"state\": \"OPEN\",\n \"total_discount_money\": {\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n \"total_money\": {\n \"amount\": 900,\n \"currency\": \"USD\"\n },\n \"total_service_charge_money\": {\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n \"total_tax_money\": {\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n \"updated_at\": \"2019-08-23T18:33:47.523Z\",\n \"version\": 2\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "a291f121-dcef-4e40-b374-9d4a90939c20", "documentation": "PayOrder", "method": "post", "endpoint": "v2/orders/:order_id/pay", "responses": [ { "uuid": "05a70ed0-0d05-4acc-83d6-7236c58df3cb", "body": "{\n \"order\": {\n \"closed_at\": \"2019-08-06T02:47:37.140Z\",\n \"created_at\": \"2019-08-06T02:47:35.693Z\",\n \"id\": \"lgwOlEityYPJtcuvKTVKT1pA986YY\",\n \"line_items\": [\n {\n \"base_price_money\": {\n \"amount\": 500,\n \"currency\": \"USD\"\n },\n \"gross_sales_money\": {\n \"amount\": 500,\n \"currency\": \"USD\"\n },\n \"name\": \"Item 1\",\n \"quantity\": \"1\",\n \"total_discount_money\": {\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n \"total_money\": {\n \"amount\": 500,\n \"currency\": \"USD\"\n },\n \"total_tax_money\": {\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n \"uid\": \"QW6kofLHJK7JEKMjlSVP5C\"\n },\n {\n \"base_price_money\": {\n \"amount\": 750,\n \"currency\": \"USD\"\n },\n \"gross_sales_money\": {\n \"amount\": 1500,\n \"currency\": \"USD\"\n },\n \"name\": \"Item 2\",\n \"quantity\": \"2\",\n \"total_discount_money\": {\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n \"total_money\": {\n \"amount\": 1500,\n \"currency\": \"USD\"\n },\n \"total_tax_money\": {\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n \"uid\": \"zhw8MNfRGdFQMI2WE1UBJD\"\n }\n ],\n \"location_id\": \"P3CCK6HSNDAS7\",\n \"net_amounts\": {\n \"discount_money\": {\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n \"service_charge_money\": {\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n \"tax_money\": {\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n \"tip_money\": {\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n \"total_money\": {\n \"amount\": 2000,\n \"currency\": \"USD\"\n }\n },\n \"source\": {\n \"name\": \"Source Name\"\n },\n \"state\": \"COMPLETED\",\n \"tenders\": [\n {\n \"amount_money\": {\n \"amount\": 1000,\n \"currency\": \"USD\"\n },\n \"card_details\": {\n \"card\": {\n \"card_brand\": \"VISA\",\n \"exp_month\": 2,\n \"exp_year\": 2022,\n \"fingerprint\": \"sq-1-n_BL15KP87ClDa4-h2nXOI0fp5VnxNH6hfhzqhptTfAgxgLuGFcg6jIPngDz4IkkTQ\",\n \"last_4\": \"1111\"\n },\n \"entry_method\": \"KEYED\",\n \"status\": \"CAPTURED\"\n },\n \"created_at\": \"2019-08-06T02:47:36.293Z\",\n \"id\": \"EnZdNAlWCmfh6Mt5FMNST1o7taB\",\n \"location_id\": \"P3CCK6HSNDAS7\",\n \"payment_id\": \"EnZdNAlWCmfh6Mt5FMNST1o7taB\",\n \"transaction_id\": \"lgwOlEityYPJtcuvKTVKT1pA986YY\",\n \"type\": \"CARD\"\n },\n {\n \"amount_money\": {\n \"amount\": 1000,\n \"currency\": \"USD\"\n },\n \"card_details\": {\n \"card\": {\n \"card_brand\": \"VISA\",\n \"exp_month\": 2,\n \"exp_year\": 2022,\n \"fingerprint\": \"sq-1-n_BL15KP87ClDa4-h2nXOI0fp5VnxNH6hfhzqhptTfAgxgLuGFcg6jIPngDz4IkkTQ\",\n \"last_4\": \"1111\"\n },\n \"entry_method\": \"KEYED\",\n \"status\": \"CAPTURED\"\n },\n \"created_at\": \"2019-08-06T02:47:36.809Z\",\n \"id\": \"0LRiVlbXVwe8ozu4KbZxd12mvaB\",\n \"location_id\": \"P3CCK6HSNDAS7\",\n \"payment_id\": \"0LRiVlbXVwe8ozu4KbZxd12mvaB\",\n \"transaction_id\": \"lgwOlEityYPJtcuvKTVKT1pA986YY\",\n \"type\": \"CARD\"\n }\n ],\n \"total_discount_money\": {\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n \"total_money\": {\n \"amount\": 2000,\n \"currency\": \"USD\"\n },\n \"total_service_charge_money\": {\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n \"total_tax_money\": {\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n \"updated_at\": \"2019-08-06T02:47:37.140Z\",\n \"version\": 4\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "a1b49d8a-cca0-4011-b65c-f207602724ca", "documentation": "ListPayments", "method": "get", "endpoint": "v2/payments", "responses": [ { "uuid": "91ab69be-5774-4e63-86a0-978c0c81f931", "body": "{\n \"cursor\": \"2TTnuq0yRYDdBRSFF2XuFkgO1Bclt4ZHNI7YrFNeyZ6rL1WZXkdnLn10H8fBIwFKdKW1Af6ifRa\",\n \"payments\": [\n {\n \"amount_money\": {\n \"amount\": 1000,\n \"currency\": \"USD\"\n },\n \"approved_money\": {\n \"amount\": 1000,\n \"currency\": \"USD\"\n },\n \"capabilities\": [\n \"EDIT_AMOUNT_UP\",\n \"EDIT_AMOUNT_DOWN\",\n \"EDIT_TIP_AMOUNT_UP\",\n \"EDIT_TIP_AMOUNT_DOWN\"\n ],\n \"card_details\": {\n \"auth_result_code\": \"NQbV3A\",\n \"avs_status\": \"AVS_ACCEPTED\",\n \"card\": {\n \"card_brand\": \"VISA\",\n \"exp_month\": 2,\n \"exp_year\": 2022,\n \"fingerprint\": \"sq-1-lHpUJIUyqOPQmH89b6GuQEljmc-mZmu4kSTaMlkLDkJI7NVjAl4Zirn2sk3OeyVKVA\",\n \"last_4\": \"1111\"\n },\n \"card_payment_timeline\": {\n \"authorized_at\": \"2019-07-09T14:36:13.798Z\"\n },\n \"cvv_status\": \"CVV_ACCEPTED\",\n \"entry_method\": \"KEYED\",\n \"status\": \"AUTHORIZED\"\n },\n \"created_at\": \"2019-07-09T14:36:13.745Z\",\n \"id\": \"ifrBnAil7rRfDtd27cdf9g9WO8paB\",\n \"location_id\": \"QLIJX16Q3UZ0A\",\n \"order_id\": \"MvfIilKnIYKBium4rauH67wFzRxv\",\n \"source_type\": \"CARD\",\n \"status\": \"APPROVED\",\n \"total_money\": {\n \"amount\": 1000,\n \"currency\": \"USD\"\n },\n \"updated_at\": \"2019-07-09T14:36:13.883Z\",\n \"version_token\": \"v6orqdHcW2TwuzCQRdF6a4ktbG8T8nbDcBx8eyrkoZl6o\"\n },\n {\n \"amount_money\": {\n \"amount\": 1000,\n \"currency\": \"USD\"\n },\n \"approved_money\": {\n \"amount\": 1000,\n \"currency\": \"USD\"\n },\n \"card_details\": {\n \"auth_result_code\": \"vPIr0K\",\n \"avs_status\": \"AVS_ACCEPTED\",\n \"card\": {\n \"card_brand\": \"VISA\",\n \"exp_month\": 7,\n \"exp_year\": 2026,\n \"fingerprint\": \"sq-1-TpmjbNBMFdibiIjpQI5LiRgNUBC7u1689i0TgHjnlyHEWYB7tnn-K4QbW4ttvtaqXw\",\n \"last_4\": \"2796\"\n },\n \"card_payment_timeline\": {\n \"authorized_at\": \"2019-07-08T01:00:51.617Z\",\n \"captured_at\": \"2019-07-08T01:13:58.508Z\"\n },\n \"cvv_status\": \"CVV_ACCEPTED\",\n \"entry_method\": \"ON_FILE\",\n \"status\": \"CAPTURED\"\n },\n \"created_at\": \"2019-07-08T01:00:51.607Z\",\n \"customer_id\": \"RDX9Z4XTIZR7MRZJUXNY9HUK6I\",\n \"id\": \"GQTFp1ZlXdpoW4o6eGiZhbjosiDFf\",\n \"location_id\": \"XTI0H92143A39\",\n \"order_id\": \"m2Hr8Hk8A3CTyQQ1k4ynExg92tO3\",\n \"processing_fee\": [\n {\n \"amount_money\": {\n \"amount\": 59,\n \"currency\": \"USD\"\n },\n \"effective_at\": \"2019-07-08T03:00:53.000Z\",\n \"type\": \"INITIAL\"\n }\n ],\n \"source_type\": \"CARD\",\n \"status\": \"COMPLETED\",\n \"total_money\": {\n \"amount\": 1000,\n \"currency\": \"USD\"\n },\n \"updated_at\": \"2019-07-08T01:13:58.508Z\",\n \"version_token\": \"pE0wanQBErcnO4ubL49pHCV1yAs4BUScWXb8fVvkRqa6o\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "d9661622-1982-4b8b-b92a-926c42bcca2d", "documentation": "CreatePayment", "method": "post", "endpoint": "v2/payments", "responses": [ { "uuid": "bfab3fbb-cd54-4bf5-82ab-c1472c025aee", "body": "{\n \"payment\": {\n \"amount_money\": {\n \"amount\": 200,\n \"currency\": \"USD\"\n },\n \"app_fee_money\": {\n \"amount\": 10,\n \"currency\": \"USD\"\n },\n \"approved_money\": {\n \"amount\": 200,\n \"currency\": \"USD\"\n },\n \"card_details\": {\n \"auth_result_code\": \"nsAyY2\",\n \"avs_status\": \"AVS_ACCEPTED\",\n \"card\": {\n \"bin\": \"411111\",\n \"card_brand\": \"VISA\",\n \"card_type\": \"DEBIT\",\n \"exp_month\": 7,\n \"exp_year\": 2026,\n \"fingerprint\": \"sq-1-TpmjbNBMFdibiIjpQI5LiRgNUBC7u1689i0TgHjnlyHEWYB7tnn-K4QbW4ttvtaqXw\",\n \"last_4\": \"1111\",\n \"prepaid_type\": \"PREPAID\"\n },\n \"card_payment_timeline\": {\n \"authorized_at\": \"2019-07-10T13:23:49.234Z\",\n \"captured_at\": \"2019-07-10T13:23:49.446Z\"\n },\n \"cvv_status\": \"CVV_ACCEPTED\",\n \"entry_method\": \"ON_FILE\",\n \"statement_description\": \"SQ *MY MERCHANT\",\n \"status\": \"CAPTURED\"\n },\n \"created_at\": \"2019-07-10T13:23:49.154Z\",\n \"customer_id\": \"RDX9Z4XTIZR7MRZJUXNY9HUK6I\",\n \"id\": \"GQTFp1ZlXdpoW4o6eGiZhbjosiDFf\",\n \"location_id\": \"XTI0H92143A39\",\n \"note\": \"Brief description\",\n \"order_id\": \"m2Hr8Hk8A3CTyQQ1k4ynExg92tO3\",\n \"receipt_number\": \"GQTF\",\n \"receipt_url\": \"https://squareup.com/receipt/preview/GQTFp1ZlXdpoW4o6eGiZhbjosiDFf\",\n \"reference_id\": \"123456\",\n \"source_type\": \"CARD\",\n \"status\": \"COMPLETED\",\n \"total_money\": {\n \"amount\": 200,\n \"currency\": \"USD\"\n },\n \"updated_at\": \"2019-07-10T13:23:49.446Z\",\n \"version_token\": \"H8Vnk5Z11SKcueuRti79jGpszSEsSVdhKRrSKCOzILG6o\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "8567dd9d-2d92-440f-8895-c2143ace5e5f", "documentation": "CancelPaymentByIdempotencyKey", "method": "post", "endpoint": "v2/payments/cancel", "responses": [ { "uuid": "f3a02e12-5bb6-4ce4-a48c-f40c683e3d4f", "body": "{}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "cf7d43d4-4c4d-4349-99f6-6291f25b56c4", "documentation": "GetPayment", "method": "get", "endpoint": "v2/payments/:payment_id", "responses": [ { "uuid": "5ce1b2c9-81cd-4e2a-a15d-e7eb3c79b08f", "body": "{\n \"payment\": {\n \"amount_money\": {\n \"amount\": 200,\n \"currency\": \"USD\"\n },\n \"app_fee_money\": {\n \"amount\": 10,\n \"currency\": \"USD\"\n },\n \"approved_money\": {\n \"amount\": 200,\n \"currency\": \"USD\"\n },\n \"card_details\": {\n \"auth_result_code\": \"nsAyY2\",\n \"avs_status\": \"AVS_ACCEPTED\",\n \"card\": {\n \"bin\": \"411111\",\n \"card_brand\": \"VISA\",\n \"card_type\": \"DEBIT\",\n \"exp_month\": 7,\n \"exp_year\": 2026,\n \"fingerprint\": \"sq-1-TpmjbNBMFdibiIjpQI5LiRgNUBC7u1689i0TgHjnlyHEWYB7tnn-K4QbW4ttvtaqXw\",\n \"last_4\": \"1111\",\n \"prepaid_type\": \"PREPAID\"\n },\n \"card_payment_timeline\": {\n \"authorized_at\": \"2019-07-10T13:23:49.234Z\",\n \"captured_at\": \"2019-07-10T13:23:49.446Z\"\n },\n \"cvv_status\": \"CVV_ACCEPTED\",\n \"entry_method\": \"ON_FILE\",\n \"statement_description\": \"SQ *MY MERCHANT\",\n \"status\": \"CAPTURED\"\n },\n \"created_at\": \"2019-07-10T13:23:49.154Z\",\n \"customer_id\": \"RDX9Z4XTIZR7MRZJUXNY9HUK6I\",\n \"id\": \"GQTFp1ZlXdpoW4o6eGiZhbjosiDFf\",\n \"location_id\": \"XTI0H92143A39\",\n \"note\": \"Brief description\",\n \"order_id\": \"m2Hr8Hk8A3CTyQQ1k4ynExg92tO3\",\n \"processing_fee\": [\n {\n \"amount_money\": {\n \"amount\": 36,\n \"currency\": \"USD\"\n },\n \"effective_at\": \"2019-07-10T15:23:49.000Z\",\n \"type\": \"INITIAL\"\n }\n ],\n \"receipt_number\": \"GQTF\",\n \"receipt_url\": \"https://squareup.com/receipt/preview/GQTFp1ZlXdpoW4o6eGiZhbjosiDFf\",\n \"reference_id\": \"123456\",\n \"source_type\": \"CARD\",\n \"status\": \"COMPLETED\",\n \"total_money\": {\n \"amount\": 200,\n \"currency\": \"USD\"\n },\n \"updated_at\": \"2019-07-10T13:23:49.446Z\",\n \"version_token\": \"hj8JqHWu9R1Kkfu63UuIUmYc7zm6YFOt92g8d2fb9fz6o\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "849a73ef-bbc1-423d-b11d-b30b0a43dc5e", "documentation": "UpdatePayment", "method": "put", "endpoint": "v2/payments/:payment_id", "responses": [ { "uuid": "191353ab-d82a-4b70-a47e-76addb1beb29", "body": "{\n \"payment\": {\n \"amount_money\": {\n \"amount\": 1000,\n \"currency\": \"USD\"\n },\n \"approved_money\": {\n \"amount\": 1000,\n \"currency\": \"USD\"\n },\n \"capabilities\": [\n \"EDIT_AMOUNT_UP\",\n \"EDIT_AMOUNT_DOWN\",\n \"EDIT_TIP_AMOUNT_UP\",\n \"EDIT_TIP_AMOUNT_DOWN\"\n ],\n \"card_details\": {\n \"auth_result_code\": \"ajM2ZF\",\n \"avs_status\": \"AVS_ACCEPTED\",\n \"card\": {\n \"bin\": \"411111\",\n \"card_brand\": \"VISA\",\n \"card_type\": \"CREDIT\",\n \"exp_month\": 2,\n \"exp_year\": 2022,\n \"fingerprint\": \"sq-1-n_BL15KP87ClDa4-h2nXOI0fp5VnxNH6hfhzqhptTfAgxgLuGFcg6jIPngDz4IkkTQ\",\n \"last_4\": \"1111\"\n },\n \"card_payment_timeline\": {\n \"authorized_at\": \"2021-02-24T03:33:43.681Z\"\n },\n \"cvv_status\": \"CVV_ACCEPTED\",\n \"entry_method\": \"KEYED\",\n \"statement_description\": \"SQ *MY BUSINESS GOSQ.COM\",\n \"status\": \"AUTHORIZED\"\n },\n \"created_at\": \"2021-03-02T19:53:31.055Z\",\n \"delay_action\": \"CANCEL\",\n \"delay_duration\": \"PT168H\",\n \"delayed_until\": \"2021-03-09T19:53:31.055Z\",\n \"id\": \"XllelosAAfmkf9mOa0YB4PqSZACZY\",\n \"location_id\": \"XTI0H92143A39\",\n \"order_id\": \"B6qiKWus1d3TBoN2Qn5kfDiWZlfZY\",\n \"receipt_number\": \"Xlle\",\n \"source_type\": \"CARD\",\n \"status\": \"APPROVED\",\n \"tip_money\": {\n \"amount\": 300,\n \"currency\": \"USD\"\n },\n \"total_money\": {\n \"amount\": 1300,\n \"currency\": \"USD\"\n },\n \"updated_at\": \"2021-03-02T19:53:31.164Z\",\n \"version_token\": \"9TKsTawsWZvdZZD5uhAZFWfd3chxFXB49cgFpD2Kujf6o\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "11f16df9-947b-4eb5-ab92-8f3917a6152c", "documentation": "CancelPayment", "method": "post", "endpoint": "v2/payments/:payment_id/cancel", "responses": [ { "uuid": "4f29e8e9-5081-45a0-86a2-209da1a12708", "body": "{\n \"payment\": {\n \"amount_money\": {\n \"amount\": 200,\n \"currency\": \"USD\"\n },\n \"app_fee_money\": {\n \"amount\": 10,\n \"currency\": \"USD\"\n },\n \"approved_money\": {\n \"amount\": 200,\n \"currency\": \"USD\"\n },\n \"card_details\": {\n \"auth_result_code\": \"eWZBDh\",\n \"avs_status\": \"AVS_ACCEPTED\",\n \"card\": {\n \"bin\": \"411111\",\n \"card_brand\": \"VISA\",\n \"card_type\": \"DEBIT\",\n \"exp_month\": 2,\n \"exp_year\": 2024,\n \"fingerprint\": \"sq-1-9PP0tWfcM6vIsYmfsesdjfhduHSDFNdJFNDfDNFjdfjpseirDErsaP\",\n \"last_4\": \"1234\",\n \"prepaid_type\": \"PREPAID\"\n },\n \"card_payment_timeline\": {\n \"authorized_at\": \"2018-10-17T20:38:46.753Z\",\n \"voided_at\": \"2018-10-17T20:38:57.793Z\"\n },\n \"cvv_status\": \"CVV_ACCEPTED\",\n \"entry_method\": \"KEYED\",\n \"statement_description\": \"SQ *MY MERCHANT\",\n \"status\": \"VOIDED\"\n },\n \"created_at\": \"2018-10-17T20:38:46.743Z\",\n \"customer_id\": \"RDX9Z4XTIZR7MRZJUXNY9HUK6I\",\n \"id\": \"GQTFp1ZlXdpoW4o6eGiZhbjosiDFf\",\n \"location_id\": \"XTI0H92143A39\",\n \"note\": \"Brief description\",\n \"order_id\": \"m2Hr8Hk8A3CTyQQ1k4ynExg92tO3\",\n \"reference_id\": \"123456\",\n \"source_type\": \"CARD\",\n \"status\": \"CANCELED\",\n \"total_money\": {\n \"amount\": 200,\n \"currency\": \"USD\"\n },\n \"updated_at\": \"2018-10-17T20:38:57.693Z\",\n \"version_token\": \"lAITJ6l8I8tFu62mCf2W4sxJQxN9FOaH5zwfsdPf7Dm6o\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "a71bbc5a-79f0-4ee9-86e8-a8a80ce5e4a3", "documentation": "CompletePayment", "method": "post", "endpoint": "v2/payments/:payment_id/complete", "responses": [ { "uuid": "dee3ab46-08d6-4ac6-9df3-d8165eff78d6", "body": "{\n \"payment\": {\n \"amount_money\": {\n \"amount\": 200,\n \"currency\": \"USD\"\n },\n \"app_fee_money\": {\n \"amount\": 10,\n \"currency\": \"USD\"\n },\n \"approved_money\": {\n \"amount\": 200,\n \"currency\": \"USD\"\n },\n \"card_details\": {\n \"auth_result_code\": \"MhIjEN\",\n \"avs_status\": \"AVS_ACCEPTED\",\n \"card\": {\n \"bin\": \"411111\",\n \"card_brand\": \"VISA\",\n \"card_type\": \"DEBIT\",\n \"exp_month\": 7,\n \"exp_year\": 2026,\n \"fingerprint\": \"sq-1-TpmjbNBMFdibiIjpQI5LiRgNUBC7u1689i0TgHjnlyHEWYB7tnn-K4QbW4ttvtaqXw\",\n \"last_4\": \"2796\",\n \"prepaid_type\": \"PREPAID\"\n },\n \"card_payment_timeline\": {\n \"authorized_at\": \"2019-07-10T13:23:49.234Z\",\n \"captured_at\": \"2019-07-10T13:23:49.446Z\"\n },\n \"cvv_status\": \"CVV_ACCEPTED\",\n \"entry_method\": \"ON_FILE\",\n \"statement_description\": \"SQ *MY MERCHANT\",\n \"status\": \"CAPTURED\"\n },\n \"created_at\": \"2019-07-10T13:39:55.317Z\",\n \"customer_id\": \"RDX9Z4XTIZR7MRZJUXNY9HUK6I\",\n \"id\": \"GQTFp1ZlXdpoW4o6eGiZhbjosiDFf\",\n \"location_id\": \"XTI0H92143A39\",\n \"note\": \"Brief description\",\n \"order_id\": \"m2Hr8Hk8A3CTyQQ1k4ynExg92tO3\",\n \"receipt_number\": \"GQTF\",\n \"receipt_url\": \"https://squareup.com/receipt/preview/GQTFp1ZlXdpoW4o6eGiZhbjosiDFf\",\n \"reference_id\": \"123456\",\n \"source_type\": \"CARD\",\n \"status\": \"COMPLETED\",\n \"total_money\": {\n \"amount\": 200,\n \"currency\": \"USD\"\n },\n \"updated_at\": \"2019-07-10T13:40:05.982Z\",\n \"version_token\": \"7knzZI16u3QBh2xXD7FH4GFwESqgam7Z9w2Ya0aSD9i6o\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "944bb255-9c87-4265-a063-0cf6582c9d7d", "documentation": "ListPaymentRefunds", "method": "get", "endpoint": "v2/refunds", "responses": [ { "uuid": "dd48ec70-2b78-4da7-a126-ef22cfa1208e", "body": "{\n \"cursor\": \"5evquW1YswHoT4EoyUhzMmTsCnsSXBU9U0WJ4FU4623nrMQcocH0RGU6Up1YkwfiMcF59ood58EBTEGgzMTGHQJpocic7ExOL0NtrTXCeWcv0UJIJNk8eXb\",\n \"refunds\": [\n {\n \"amount_money\": {\n \"amount\": 1000,\n \"currency\": \"USD\"\n },\n \"created_at\": \"2019-07-06T18:01:22.335Z\",\n \"id\": \"O2QAAhTYs7rUfzlxT38GMO7LvaB_q7JwCHtxmgXrh8fAhV468WQ44VxDtL7CU4yVRlsbXmI\",\n \"location_id\": \"XK3DBG77NJBFX\",\n \"order_id\": \"2duiyoqbfeXY0DBi15GEyk5Epa4F\",\n \"payment_id\": \"O2QAAhTYs7rUfzlxT38GMO7LvaB\",\n \"processing_fee\": [\n {\n \"amount_money\": {\n \"amount\": -59,\n \"currency\": \"USD\"\n },\n \"effective_at\": \"2019-07-06T20:01:12.000Z\",\n \"type\": \"INITIAL\"\n }\n ],\n \"status\": \"COMPLETED\",\n \"updated_at\": \"2019-07-06T18:06:04.653Z\"\n },\n {\n \"amount_money\": {\n \"amount\": 1000,\n \"currency\": \"USD\"\n },\n \"created_at\": \"2019-07-06T17:01:54.232Z\",\n \"id\": \"8TDIQvFw8PeDIxhSfd5yyX7GuaB_13px5Vrz01qzzuoGzmjsZIxDjfHhbkm2XppBUX1dW7I\",\n \"location_id\": \"XK3DBG77NJBFX\",\n \"order_id\": \"w6EXfEwS03oTQsnZTCqfE6f67e4F\",\n \"payment_id\": \"8TDIQvFw8PeDIxhSfd5yyX7GuaB\",\n \"processing_fee\": [\n {\n \"amount_money\": {\n \"amount\": -59,\n \"currency\": \"USD\"\n },\n \"effective_at\": \"2019-07-06T19:01:45.000Z\",\n \"type\": \"INITIAL\"\n }\n ],\n \"status\": \"COMPLETED\",\n \"updated_at\": \"2019-07-06T17:21:04.684Z\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "b6566ea7-abdc-4af1-8089-5cdff1976986", "documentation": "RefundPayment", "method": "post", "endpoint": "v2/refunds", "responses": [ { "uuid": "82159bdb-b22e-427e-891f-0fe364faa605", "body": "{\n \"refund\": {\n \"amount_money\": {\n \"amount\": 100,\n \"currency\": \"USD\"\n },\n \"created_at\": \"2018-10-17T20:41:55.520Z\",\n \"id\": \"UNOE3kv2BZwqHlJ830RCt5YCuaB_xVteEWVFkXDvKN1ddidfJWipt8p9whmElKT5mZtJ7wZ\",\n \"payment_id\": \"UNOE3kv2BZwqHlJ830RCt5YCuaB\",\n \"status\": \"PENDING\",\n \"updated_at\": \"2018-10-17T20:41:55.520Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "f402367f-1dde-4570-b9f7-a6f56b2e16e3", "documentation": "GetPaymentRefund", "method": "get", "endpoint": "v2/refunds/:refund_id", "responses": [ { "uuid": "389ec17e-50ee-4ed2-a2dd-a59b30a5139b", "body": "{\n \"refund\": {\n \"amount_money\": {\n \"amount\": 1000,\n \"currency\": \"USD\"\n },\n \"created_at\": \"2019-07-06T18:01:22.123Z\",\n \"id\": \"O2QAAhTYs7rUfzlxT38GMO7LvaB_q7JwCHtxmgXrh8fAhV468WQ44VxDtL7CU4yVRlsbXmI\",\n \"location_id\": \"XK3DBG77NJBFX\",\n \"order_id\": \"2duiyoqbfeXY0DBi15GEyk5Epa4F\",\n \"payment_id\": \"O2QAAhTYs7rUfzlxT38GMO7LvaB\",\n \"processing_fee\": [\n {\n \"amount_money\": {\n \"amount\": -59,\n \"currency\": \"USD\"\n },\n \"effective_at\": \"2019-07-06T20:01:12.000Z\",\n \"type\": \"INITIAL\"\n }\n ],\n \"status\": \"COMPLETED\",\n \"updated_at\": \"2019-07-06T18:06:03.874Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "d19cdab2-3eca-4531-a52a-519a6c809819", "documentation": "ListSites", "method": "get", "endpoint": "v2/sites", "responses": [ { "uuid": "b91d3558-278e-4810-91aa-9d136ed580dd", "body": "{\n \"sites\": [\n {\n \"created_at\": \"2020-02-28T13:22:51Z\",\n \"domain\": \"mysite1.square.site\",\n \"id\": \"site_278075276488921835\",\n \"is_published\": true,\n \"site_title\": \"My First Site\",\n \"updated_at\": \"2021-01-13T09:58:32Z\"\n },\n {\n \"created_at\": \"2020-06-18T17:45:13Z\",\n \"domain\": \"mysite2.square.site\",\n \"id\": \"site_102725345836253849\",\n \"is_published\": true,\n \"site_title\": \"My Second Site\",\n \"updated_at\": \"2020-11-23T02:19:10Z\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "4dda0357-496a-478e-bac7-a3cc30c7189b", "documentation": "DeleteSnippet", "method": "delete", "endpoint": "v2/sites/:site_id/snippet", "responses": [ { "uuid": "00f6c9f1-dad0-4e61-bb2b-dd2353c56434", "body": "{}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "bc158354-d413-4c31-893d-c0f4fcac299f", "documentation": "RetrieveSnippet", "method": "get", "endpoint": "v2/sites/:site_id/snippet", "responses": [ { "uuid": "fe03b98a-7e3f-4ccf-9e3a-38ae4a3d34f3", "body": "{\n \"snippet\": {\n \"content\": \"\",\n \"created_at\": \"2021-03-11T25:40:09Z\",\n \"id\": \"snippet_5d178150-a6c0-11eb-a9f1-437e6a2881e7\",\n \"site_id\": \"site_278075276488921835\",\n \"updated_at\": \"2021-03-11T25:40:09Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "78a8b894-3601-4ecc-ad5f-118da9eec12c", "documentation": "UpsertSnippet", "method": "post", "endpoint": "v2/sites/:site_id/snippet", "responses": [ { "uuid": "e0f1919f-7b63-491d-a240-16540860a562", "body": "{\n \"snippet\": {\n \"content\": \"\",\n \"created_at\": \"2021-03-11T25:40:09Z\",\n \"id\": \"snippet_5d178150-a6c0-11eb-a9f1-437e6a2881e7\",\n \"site_id\": \"site_278075276488921835\",\n \"updated_at\": \"2021-03-11T25:40:09Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "455f032a-8b06-448c-9099-96409b1d1899", "documentation": "CreateSubscription", "method": "post", "endpoint": "v2/subscriptions", "responses": [ { "uuid": "1c9a1ab1-bd8d-4bd3-a063-9d9818455bfa", "body": "{\n \"subscription\": {\n \"card_id\": \"ccof:qy5x8hHGYsgLrp4Q4GB\",\n \"created_at\": \"2020-08-03T21:53:10Z\",\n \"customer_id\": \"CHFGVKYY8RSV93M5KCYTG4PN0G\",\n \"id\": \"56214fb2-cc85-47a1-93bc-44f3766bb56f\",\n \"location_id\": \"S8GWD5R9QB376\",\n \"plan_id\": \"6JHXF3B2CW3YKHDV4XEM674H\",\n \"price_override_money\": {\n \"amount\": 100,\n \"currency\": \"USD\"\n },\n \"start_date\": \"2020-08-01\",\n \"status\": \"PENDING\",\n \"tax_percentage\": \"5\",\n \"timezone\": \"America/Los_Angeles\",\n \"version\": 1594155459464\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "594dd851-6d86-4b0d-95da-2f799343cec6", "documentation": "SearchSubscriptions", "method": "post", "endpoint": "v2/subscriptions/search", "responses": [ { "uuid": "a7623ac4-6a1b-4e95-afc4-9a5c79ccd9bb", "body": "{\n \"subscriptions\": [\n {\n \"canceled_date\": \"2020-04-14\",\n \"card_id\": \"ccof:mueUsvgajChmjEbp4GB\",\n \"charged_through_date\": \"2020-05-14\",\n \"created_at\": \"2020-08-03T21:53:10Z\",\n \"customer_id\": \"CHFGVKYY8RSV93M5KCYTG4PN0G\",\n \"id\": \"de86fc96-8664-474b-af1a-abbe59cacf0e\",\n \"location_id\": \"S8GWD5R9QB376\",\n \"paid_until_date\": \"2020-05-14\",\n \"plan_id\": \"L3TJVDHVBEQEGQDEZL2JJM7R\",\n \"start_date\": \"2020-04-14\",\n \"status\": \"CANCELED\",\n \"timezone\": \"UTC\"\n },\n {\n \"created_at\": \"2020-08-03T21:53:10Z\",\n \"customer_id\": \"CHFGVKYY8RSV93M5KCYTG4PN0G\",\n \"id\": \"56214fb2-cc85-47a1-93bc-44f3766bb56f\",\n \"location_id\": \"S8GWD5R9QB376\",\n \"plan_id\": \"6JHXF3B2CW3YKHDV4XEM674H\",\n \"price_override_money\": {\n \"amount\": 100,\n \"currency\": \"USD\"\n },\n \"start_date\": \"2020-08-01\",\n \"status\": \"PENDING\",\n \"tax_percentage\": \"5\",\n \"timezone\": \"America/Los_Angeles\",\n \"version\": 1594155459464\n },\n {\n \"charged_through_date\": \"2020-06-11\",\n \"created_at\": \"2020-08-03T21:53:10Z\",\n \"customer_id\": \"CHFGVKYY8RSV93M5KCYTG4PN0G\",\n \"id\": \"8151fc89-da15-4eb9-a685-1a70883cebfc\",\n \"invoice_ids\": [\n \"grebK0Q_l8H4fqoMMVvt-Q\",\n \"rcX_i3sNmHTGKhI4W2mceA\"\n ],\n \"location_id\": \"S8GWD5R9QB376\",\n \"paid_until_date\": \"2020-06-11\",\n \"plan_id\": \"6JHXF3B2CW3YKHDV4XEM674H\",\n \"price_override_money\": {\n \"amount\": 1000,\n \"currency\": \"USD\"\n },\n \"start_date\": \"2020-05-11\",\n \"status\": \"ACTIVE\",\n \"timezone\": \"America/Los_Angeles\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "93a2caef-235d-4b1e-b77f-0b7af1f428cc", "documentation": "RetrieveSubscription", "method": "get", "endpoint": "v2/subscriptions/:subscription_id", "responses": [ { "uuid": "cfc3bf03-740e-4282-b353-5e3f764e60a3", "body": "{\n \"subscription\": {\n \"charged_through_date\": \"2020-06-11\",\n \"created_at\": \"2020-08-03T21:53:10Z\",\n \"customer_id\": \"CHFGVKYY8RSV93M5KCYTG4PN0G\",\n \"id\": \"8151fc89-da15-4eb9-a685-1a70883cebfc\",\n \"invoice_ids\": [\n \"grebK0Q_l8H4fqoMMVvt-Q\",\n \"rcX_i3sNmHTGKhI4W2mceA\"\n ],\n \"location_id\": \"S8GWD5R9QB376\",\n \"paid_until_date\": \"2020-06-11\",\n \"plan_id\": \"6JHXF3B2CW3YKHDV4XEM674H\",\n \"price_override_money\": {\n \"amount\": 1000,\n \"currency\": \"USD\"\n },\n \"start_date\": \"2020-05-11\",\n \"status\": \"ACTIVE\",\n \"timezone\": \"America/Los_Angeles\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "fb44f167-93ab-4341-931b-08de34628b04", "documentation": "UpdateSubscription", "method": "put", "endpoint": "v2/subscriptions/:subscription_id", "responses": [ { "uuid": "7941c0de-d17f-4723-93fd-b76e29644af2", "body": "{\n \"subscription\": {\n \"created_at\": \"2020-08-03T21:53:10Z\",\n \"customer_id\": \"CHFGVKYY8RSV93M5KCYTG4PN0G\",\n \"id\": \"9ba40961-995a-4a3d-8c53-048c40cafc13\",\n \"location_id\": \"S8GWD5R9QB376\",\n \"plan_id\": \"6JHXF3B2CW3YKHDV4XEM674H\",\n \"price_override_money\": {\n \"amount\": 2000,\n \"currency\": \"USD\"\n },\n \"status\": \"ACTIVE\",\n \"timezone\": \"America/Los_Angeles\",\n \"version\": 1594311617331\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "125b7ff4-1fb5-496f-97d0-42555322dc21", "documentation": "CancelSubscription", "method": "post", "endpoint": "v2/subscriptions/:subscription_id/cancel", "responses": [ { "uuid": "b0352c89-3bc2-48dc-aaf6-09002b6d5279", "body": "{\n \"subscription\": {\n \"canceled_date\": \"2020-05-01\",\n \"card_id\": \"ccof:qy5x8hHGYsgLrp4Q4GB\",\n \"created_at\": \"2020-08-03T21:53:10Z\",\n \"customer_id\": \"CHFGVKYY8RSV93M5KCYTG4PN0G\",\n \"id\": \"910afd30-464a-4e00-a8d8-2296eEXAMPLE\",\n \"location_id\": \"S8GWD5R9QB376\",\n \"paid_until_date\": \"2020-05-01\",\n \"plan_id\": \"6JHXF3B2CW3YKHDV4XEM674H\",\n \"start_date\": \"2020-04-24\",\n \"status\": \"ACTIVE\",\n \"timezone\": \"America/Los_Angeles\",\n \"version\": 1594311617331\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "6e72a525-1bc8-4d4f-8b12-5b3e1e42fe21", "documentation": "ListSubscriptionEvents", "method": "get", "endpoint": "v2/subscriptions/:subscription_id/events", "responses": [ { "uuid": "6e09ccbe-e511-4ac4-8f4a-3f90c14024ec", "body": "{\n \"subscription_events\": [\n {\n \"effective_date\": \"2020-04-24\",\n \"id\": \"06809161-3867-4598-8269-8aea5be4f9de\",\n \"plan_id\": \"6JHXF3B2CW3YKHDV4XEM674H\",\n \"subscription_event_type\": \"START_SUBSCRIPTION\"\n },\n {\n \"effective_date\": \"2020-05-06\",\n \"id\": \"a0c08083-5db0-4800-85c7-d398de4fbb6e\",\n \"plan_id\": \"6JHXF3B2CW3YKHDV4XEM674H\",\n \"subscription_event_type\": \"STOP_SUBSCRIPTION\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "9fa97c35-da69-4150-a1d9-09b64a564899", "documentation": "ResumeSubscription", "method": "post", "endpoint": "v2/subscriptions/:subscription_id/resume", "responses": [ { "uuid": "26cc3b2a-5957-4e56-bb27-20e8a28e51ed", "body": "{\n \"subscription\": {\n \"created_at\": \"2020-08-03T21:53:10Z\",\n \"customer_id\": \"CHFGVKYY8RSV93M5KCYTG4PN0G\",\n \"id\": \"9ba40961-995a-4a3d-8c53-048c40cafc13\",\n \"location_id\": \"S8GWD5R9QB376\",\n \"plan_id\": \"6JHXF3B2CW3YKHDV4XEM674H\",\n \"price_override_money\": {\n \"amount\": 2000,\n \"currency\": \"USD\"\n },\n \"status\": \"ACTIVE\",\n \"timezone\": \"America/Los_Angeles\",\n \"version\": 1594311617331\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "343141b2-24cf-43be-b2de-27cf6ac6932f", "documentation": "CreateTeamMember", "method": "post", "endpoint": "v2/team-members", "responses": [ { "uuid": "3646618e-f971-45d5-af6d-31a878b980c2", "body": "{\n \"team_member\": {\n \"assigned_locations\": {\n \"assignment_type\": \"EXPLICIT_LOCATIONS\",\n \"location_ids\": [\n \"GA2Y9HSJ8KRYT\",\n \"YSGH2WBKG94QZ\"\n ]\n },\n \"email_address\": \"joe_doe@gmail.com\",\n \"family_name\": \"Doe\",\n \"given_name\": \"Joe\",\n \"id\": \"1yJlHapkseYnNPETIU1B\",\n \"is_owner\": false,\n \"phone_number\": \"+14159283333\",\n \"reference_id\": \"reference_id_1\",\n \"status\": \"ACTIVE\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "4d594f0c-ca39-45f6-92c9-76aa18a6f9ff", "documentation": "BulkCreateTeamMembers", "method": "post", "endpoint": "v2/team-members/bulk-create", "responses": [ { "uuid": "507f7b12-5aea-43c3-9fda-2a9e24f6cbc2", "body": "{\n \"team_members\": {\n \"idempotency-key-1\": {\n \"team_member\": {\n \"assigned_locations\": {\n \"assignment_type\": \"EXPLICIT_LOCATIONS\",\n \"location_ids\": [\n \"GA2Y9HSJ8KRYT\",\n \"YSGH2WBKG94QZ\"\n ]\n },\n \"email_address\": \"joe_doe@gmail.com\",\n \"family_name\": \"Doe\",\n \"given_name\": \"Joe\",\n \"id\": \"ywhG1qfIOoqsHfVRubFV\",\n \"is_owner\": false,\n \"phone_number\": \"+14159283333\",\n \"reference_id\": \"reference_id_1\",\n \"status\": \"ACTIVE\"\n }\n },\n \"idempotency-key-2\": {\n \"team_member\": {\n \"assigned_locations\": {\n \"assignment_type\": \"ALL_CURRENT_AND_FUTURE_LOCATIONS\"\n },\n \"email_address\": \"jane_smith@gmail.com\",\n \"family_name\": \"Smith\",\n \"given_name\": \"Jane\",\n \"id\": \"IF_Ncrg7fHhCqxVI9T6R\",\n \"is_owner\": false,\n \"phone_number\": \"+14159223334\",\n \"reference_id\": \"reference_id_2\",\n \"status\": \"ACTIVE\"\n }\n }\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "495ca9d2-a739-4839-b424-cd7aee0bc93f", "documentation": "BulkUpdateTeamMembers", "method": "post", "endpoint": "v2/team-members/bulk-update", "responses": [ { "uuid": "5369138a-8db7-426a-9cb9-b8be56a9de99", "body": "{\n \"team_members\": {\n \"AFMwA08kR-MIF-3Vs0OE\": {\n \"team_member\": {\n \"assigned_locations\": {\n \"assignment_type\": \"ALL_CURRENT_AND_FUTURE_LOCATIONS\"\n },\n \"created_at\": \"2020-06-11T22:46:57.001Z\",\n \"email_address\": \"jane_smith@gmail.com\",\n \"family_name\": \"Smith\",\n \"given_name\": \"Jane\",\n \"id\": \"AFMwA08kR-MIF-3Vs0OE\",\n \"is_owner\": false,\n \"phone_number\": \"+14159223334\",\n \"reference_id\": \"reference_id_2\",\n \"status\": \"ACTIVE\"\n }\n },\n \"fpgteZNMaf0qOK-a4t6P\": {\n \"team_member\": {\n \"assigned_locations\": {\n \"assignment_type\": \"EXPLICIT_LOCATIONS\",\n \"location_ids\": [\n \"GA2Y9HSJ8KRYT\",\n \"YSGH2WBKG94QZ\"\n ]\n },\n \"created_at\": \"2020-06-11T22:46:57.095Z\",\n \"email_address\": \"joe_doe@gmail.com\",\n \"family_name\": \"Doe\",\n \"given_name\": \"Joe\",\n \"id\": \"fpgteZNMaf0qOK-a4t6P\",\n \"is_owner\": false,\n \"phone_number\": \"+14159283333\",\n \"reference_id\": \"reference_id_1\",\n \"status\": \"ACTIVE\"\n }\n }\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "0f84bbf0-d298-44a6-acb8-3133f52119ff", "documentation": "SearchTeamMembers", "method": "post", "endpoint": "v2/team-members/search", "responses": [ { "uuid": "bbcab219-152d-4c71-8005-f4f3592f19a3", "body": "{\n \"cursor\": \"N:9UglUjOXQ13-hMFypCft\",\n \"team_members\": [\n {\n \"assigned_locations\": {\n \"assignment_type\": \"ALL_CURRENT_AND_FUTURE_LOCATIONS\"\n },\n \"created_at\": \"2019-07-10T17:26:48Z\",\n \"email_address\": \"johnny_cash@squareup.com\",\n \"family_name\": \"Cash\",\n \"given_name\": \"Johnny\",\n \"id\": \"-3oZQKPKVk6gUXU_V5Qa\",\n \"is_owner\": false,\n \"reference_id\": \"12345678\",\n \"status\": \"ACTIVE\",\n \"updated_at\": \"2020-04-28T21:49:28.957Z\"\n },\n {\n \"assigned_locations\": {\n \"assignment_type\": \"ALL_CURRENT_AND_FUTURE_LOCATIONS\"\n },\n \"created_at\": \"2020-03-24T18:14:01.127Z\",\n \"family_name\": \"Smith\",\n \"given_name\": \"Lombard\",\n \"id\": \"1AVJj0DjkzbmbJw5r4KK\",\n \"is_owner\": false,\n \"phone_number\": \"+14155552671\",\n \"reference_id\": \"abcded\",\n \"status\": \"ACTIVE\",\n \"updated_at\": \"2020-06-09T17:38:05.423Z\"\n },\n {\n \"assigned_locations\": {\n \"assignment_type\": \"ALL_CURRENT_AND_FUTURE_LOCATIONS\"\n },\n \"created_at\": \"2020-03-24T01:09:25.010Z\",\n \"family_name\": \"Sway\",\n \"given_name\": \"Monica\",\n \"id\": \"2JCmiJol_KKFs9z2Evim\",\n \"is_owner\": false,\n \"status\": \"ACTIVE\",\n \"updated_at\": \"2020-03-24T01:09:25.010Z\"\n },\n {\n \"assigned_locations\": {\n \"assignment_type\": \"ALL_CURRENT_AND_FUTURE_LOCATIONS\"\n },\n \"created_at\": \"2020-03-24T01:09:23.464Z\",\n \"family_name\": \"Ipsum\",\n \"given_name\": \"Elton\",\n \"id\": \"4uXcJQSLtbk3F0UQHFNQ\",\n \"is_owner\": false,\n \"status\": \"ACTIVE\",\n \"updated_at\": \"2020-03-24T01:09:23.464Z\"\n },\n {\n \"assigned_locations\": {\n \"assignment_type\": \"ALL_CURRENT_AND_FUTURE_LOCATIONS\"\n },\n \"created_at\": \"2020-03-24T01:09:23.074Z\",\n \"family_name\": \"Lo\",\n \"given_name\": \"Steven\",\n \"id\": \"5CoUpyrw1YwGWcRd-eDL\",\n \"is_owner\": false,\n \"status\": \"ACTIVE\",\n \"updated_at\": \"2020-03-24T01:09:23.074Z\"\n },\n {\n \"assigned_locations\": {\n \"assignment_type\": \"ALL_CURRENT_AND_FUTURE_LOCATIONS\"\n },\n \"created_at\": \"2020-03-24T18:14:03.865Z\",\n \"email_address\": \"patrick_steward@gmail.com\",\n \"family_name\": \"Steward\",\n \"given_name\": \"Patrick\",\n \"id\": \"5MRPTTp8MMBLVSmzrGha\",\n \"is_owner\": false,\n \"phone_number\": \"+14155552671\",\n \"status\": \"ACTIVE\",\n \"updated_at\": \"2020-03-24T18:14:03.865Z\"\n },\n {\n \"assigned_locations\": {\n \"assignment_type\": \"ALL_CURRENT_AND_FUTURE_LOCATIONS\"\n },\n \"created_at\": \"2020-03-24T01:09:25.180Z\",\n \"family_name\": \"Manny\",\n \"given_name\": \"Ivy\",\n \"id\": \"7F5ZxsfRnkexhu1PTbfh\",\n \"is_owner\": false,\n \"status\": \"ACTIVE\",\n \"updated_at\": \"2020-03-24T01:09:25.180Z\"\n },\n {\n \"assigned_locations\": {\n \"assignment_type\": \"ALL_CURRENT_AND_FUTURE_LOCATIONS\"\n },\n \"created_at\": \"2020-03-24T18:14:02.797Z\",\n \"email_address\": \"john_smith@gmail.com\",\n \"family_name\": \"Smith\",\n \"given_name\": \"John\",\n \"id\": \"808X9HR72yKvVaigQXf4\",\n \"is_owner\": false,\n \"phone_number\": \"+14155552671\",\n \"status\": \"ACTIVE\",\n \"updated_at\": \"2020-03-24T18:14:02.797Z\"\n },\n {\n \"assigned_locations\": {\n \"assignment_type\": \"ALL_CURRENT_AND_FUTURE_LOCATIONS\"\n },\n \"created_at\": \"2020-03-24T18:14:00.399Z\",\n \"email_address\": \"r_wen@gmail.com\",\n \"family_name\": \"Wen\",\n \"given_name\": \"Robert\",\n \"id\": \"9MVDVoY4hazkWKGo_OuZ\",\n \"is_owner\": false,\n \"phone_number\": \"+14155552671\",\n \"status\": \"ACTIVE\",\n \"updated_at\": \"2020-03-24T18:14:00.399Z\"\n },\n {\n \"assigned_locations\": {\n \"assignment_type\": \"ALL_CURRENT_AND_FUTURE_LOCATIONS\"\n },\n \"created_at\": \"2020-03-24T18:14:00.445Z\",\n \"email_address\": \"asimpson@gmail.com\",\n \"family_name\": \"Simpson\",\n \"given_name\": \"Ashley\",\n \"id\": \"9UglUjOXQ13-hMFypCft\",\n \"is_owner\": false,\n \"phone_number\": \"+14155552671\",\n \"status\": \"ACTIVE\",\n \"updated_at\": \"2020-03-24T18:14:00.445Z\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "945baee9-8a3d-40a5-bc8e-f925a2786755", "documentation": "RetrieveTeamMember", "method": "get", "endpoint": "v2/team-members/:team_member_id", "responses": [ { "uuid": "e8f0d887-efcc-46c8-8c35-0ff7c49e6c2c", "body": "{\n \"team_member\": {\n \"assigned_locations\": {\n \"assignment_type\": \"EXPLICIT_LOCATIONS\",\n \"location_ids\": [\n \"GA2Y9HSJ8KRYT\",\n \"YSGH2WBKG94QZ\"\n ]\n },\n \"created_at\": \"2020-06-11T22:55:45.867Z\",\n \"email_address\": \"joe_doe@gmail.com\",\n \"family_name\": \"Doe\",\n \"given_name\": \"Joe\",\n \"id\": \"1yJlHapkseYnNPETIU1B\",\n \"is_owner\": false,\n \"phone_number\": \"+14159283333\",\n \"reference_id\": \"reference_id_1\",\n \"status\": \"ACTIVE\",\n \"updated_at\": \"2020-06-11T22:55:45.867Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "1505abbf-1fa2-4e4c-a1fb-6fabb8a08c77", "documentation": "UpdateTeamMember", "method": "put", "endpoint": "v2/team-members/:team_member_id", "responses": [ { "uuid": "4320a7ec-d711-45d5-8dfd-42210955e1a9", "body": "{\n \"team_member\": {\n \"assigned_locations\": {\n \"assignment_type\": \"EXPLICIT_LOCATIONS\",\n \"location_ids\": [\n \"GA2Y9HSJ8KRYT\",\n \"YSGH2WBKG94QZ\"\n ]\n },\n \"created_at\": \"2020-06-11T22:55:45.867Z\",\n \"email_address\": \"joe_doe@gmail.com\",\n \"family_name\": \"Doe\",\n \"given_name\": \"Joe\",\n \"id\": \"1yJlHapkseYnNPETIU1B\",\n \"is_owner\": false,\n \"phone_number\": \"+14159283333\",\n \"reference_id\": \"reference_id_1\",\n \"status\": \"ACTIVE\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "cf6cd295-edab-4190-af9f-2ed09a3fdb0f", "documentation": "RetrieveWageSetting", "method": "get", "endpoint": "v2/team-members/:team_member_id/wage-setting", "responses": [ { "uuid": "aef940fc-8898-476e-aa32-f8f2b353e40a", "body": "{\n \"wage_setting\": {\n \"created_at\": \"2020-06-11T23:01:21+00:00\",\n \"is_overtime_exempt\": false,\n \"job_assignments\": [\n {\n \"annual_rate\": {\n \"amount\": 4500000,\n \"currency\": \"USD\"\n },\n \"hourly_rate\": {\n \"amount\": 2164,\n \"currency\": \"USD\"\n },\n \"job_title\": \"Manager\",\n \"pay_type\": \"SALARY\",\n \"weekly_hours\": 40\n }\n ],\n \"team_member_id\": \"1yJlHapkseYnNPETIU1B\",\n \"updated_at\": \"2020-06-11T23:01:21+00:00\",\n \"version\": 1\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "e573194e-f74d-4bb4-a45f-77a4a15a160b", "documentation": "UpdateWageSetting", "method": "put", "endpoint": "v2/team-members/:team_member_id/wage-setting", "responses": [ { "uuid": "3639dd3c-5f73-4000-9513-7b2e406f900a", "body": "{\n \"wage_setting\": {\n \"created_at\": \"2019-07-10T17:26:48+00:00\",\n \"is_overtime_exempt\": true,\n \"job_assignments\": [\n {\n \"annual_rate\": {\n \"amount\": 3000000,\n \"currency\": \"USD\"\n },\n \"hourly_rate\": {\n \"amount\": 1443,\n \"currency\": \"USD\"\n },\n \"job_title\": \"Manager\",\n \"pay_type\": \"SALARY\",\n \"weekly_hours\": 40\n },\n {\n \"hourly_rate\": {\n \"amount\": 1200,\n \"currency\": \"USD\"\n },\n \"job_title\": \"Cashier\",\n \"pay_type\": \"HOURLY\"\n }\n ],\n \"team_member_id\": \"-3oZQKPKVk6gUXU_V5Qa\",\n \"updated_at\": \"2020-06-11T23:12:04+00:00\",\n \"version\": 1\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "545ebd1e-7338-4ee7-896f-8b007411b3fc", "documentation": "CreateTerminalCheckout", "method": "post", "endpoint": "v2/terminals/checkouts", "responses": [ { "uuid": "b7d7d0a1-190a-4405-9a3a-b39efcc46ec5", "body": "{\n \"checkout\": {\n \"amount_money\": {\n \"amount\": 2610,\n \"currency\": \"USD\"\n },\n \"app_id\": \"APP_ID\",\n \"created_at\": \"2020-04-06T16:39:32.545Z\",\n \"deadline_duration\": \"PT10M\",\n \"device_options\": {\n \"device_id\": \"dbb5d83a-7838-11ea-bc55-0242ac130003\",\n \"skip_receipt_screen\": false,\n \"tip_settings\": {\n \"allow_tipping\": false\n }\n },\n \"id\": \"08YceKh7B3ZqO\",\n \"note\": \"A brief note\",\n \"payment_type\": \"CARD_PRESENT\",\n \"reference_id\": \"id11572\",\n \"status\": \"PENDING\",\n \"updated_at\": \"2020-04-06T16:39:32.545Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "b13d5881-453d-407a-a570-d83769ed688f", "documentation": "SearchTerminalCheckouts", "method": "post", "endpoint": "v2/terminals/checkouts/search", "responses": [ { "uuid": "f2ad212c-f875-4681-b7ff-42b64722f84d", "body": "{\n \"checkouts\": [\n {\n \"amount_money\": {\n \"amount\": 2610,\n \"currency\": \"USD\"\n },\n \"app_id\": \"APP_ID\",\n \"created_at\": \"2020-03-31T18:13:15.921Z\",\n \"deadline_duration\": \"PT10M\",\n \"device_options\": {\n \"device_id\": \"dbb5d83a-7838-11ea-bc55-0242ac130003\",\n \"skip_receipt_screen\": false,\n \"tip_settings\": {\n \"allow_tipping\": false\n }\n },\n \"id\": \"tsQPvzwBpMqqO\",\n \"note\": \"A brief note\",\n \"payment_ids\": [\n \"rXnhZzywrEk4vR6pw76fPZfgvaB\"\n ],\n \"reference_id\": \"id14467\",\n \"status\": \"COMPLETED\",\n \"updated_at\": \"2020-03-31T18:13:52.725Z\"\n },\n {\n \"amount_money\": {\n \"amount\": 2610,\n \"currency\": \"USD\"\n },\n \"app_id\": \"APP_ID\",\n \"created_at\": \"2020-03-31T18:08:31.882Z\",\n \"deadline_duration\": \"PT10M\",\n \"device_options\": {\n \"device_id\": \"dbb5d83a-7838-11ea-bc55-0242ac130003\",\n \"skip_receipt_screen\": true,\n \"tip_settings\": {\n \"allow_tipping\": false\n }\n },\n \"id\": \"XlOPTgcEhrbqO\",\n \"note\": \"A brief note\",\n \"payment_ids\": [\n \"VYBF861PaoKPP7Pih0TlbZiNvaB\"\n ],\n \"reference_id\": \"id41623\",\n \"status\": \"COMPLETED\",\n \"updated_at\": \"2020-03-31T18:08:41.635Z\"\n }\n ],\n \"cursor\": \"RiTJqBoTuXlbLmmrPvEkX9iG7XnQ4W4RjGnH\"\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "ed8f33f5-e314-467f-9696-caea2871bfa0", "documentation": "GetTerminalCheckout", "method": "get", "endpoint": "v2/terminals/checkouts/:checkout_id", "responses": [ { "uuid": "e81b1d4b-441f-4e66-a54f-9cf65e6c6279", "body": "{\n \"checkout\": {\n \"amount_money\": {\n \"amount\": 2610,\n \"currency\": \"USD\"\n },\n \"app_id\": \"APP_ID\",\n \"created_at\": \"2020-04-06T16:39:32.545Z\",\n \"deadline_duration\": \"PT10M\",\n \"device_options\": {\n \"device_id\": \"dbb5d83a-7838-11ea-bc55-0242ac130003\",\n \"skip_receipt_screen\": false,\n \"tip_settings\": {\n \"allow_tipping\": false\n }\n },\n \"id\": \"08YceKh7B3ZqO\",\n \"note\": \"A brief note\",\n \"reference_id\": \"id11572\",\n \"status\": \"IN_PROGRESS\",\n \"updated_at\": \"2020-04-06T16:39:323.001Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "06f12d20-3e91-42c9-90f9-3836ab2c0c91", "documentation": "CancelTerminalCheckout", "method": "post", "endpoint": "v2/terminals/checkouts/:checkout_id/cancel", "responses": [ { "uuid": "c64c472b-8985-4cfc-80ca-3f48f6c0b31d", "body": "{\n \"checkout\": {\n \"amount_money\": {\n \"amount\": 123,\n \"currency\": \"USD\"\n },\n \"app_id\": \"APP_ID\",\n \"cancel_reason\": \"SELLER_CANCELED\",\n \"created_at\": \"2020-03-16T15:31:19.934Z\",\n \"deadline_duration\": \"PT10M\",\n \"device_options\": {\n \"device_id\": \"dbb5d83a-7838-11ea-bc55-0242ac130003\",\n \"skip_receipt_screen\": true,\n \"tip_settings\": {\n \"allow_tipping\": true\n }\n },\n \"id\": \"S1yDlPQx7slqO\",\n \"reference_id\": \"id36815\",\n \"status\": \"CANCELED\",\n \"updated_at\": \"2020-03-16T15:31:45.787Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "cf0ea045-0a63-4949-8c7e-780575afd6c4", "documentation": "CreateTerminalRefund", "method": "post", "endpoint": "v2/terminals/refunds", "responses": [ { "uuid": "36482927-d2a6-4bbe-a9a5-67df39e90b98", "body": "{\n \"refund\": {\n \"amount_money\": {\n \"amount\": 111,\n \"currency\": \"CAD\"\n },\n \"app_id\": \"sandbox-sq0idb-c2OuYt13YaCAeJq_2cd8OQ\",\n \"card\": {\n \"bin\": \"411111\",\n \"card_brand\": \"INTERAC\",\n \"card_type\": \"CREDIT\",\n \"exp_month\": 1,\n \"exp_year\": 2022,\n \"fingerprint\": \"sq-1-B1fP9MNNmZgVVaPKRND6oDKYbz25S2cTvg9Mzwg3RMTK1zT1PiGRT-AE3nTA8vSmmw\",\n \"last_4\": \"1111\"\n },\n \"created_at\": \"2020-09-29T15:21:46.771Z\",\n \"deadline_duration\": \"PT5M\",\n \"device_id\": \"f72dfb8e-4d65-4e56-aade-ec3fb8d33291\",\n \"id\": \"009DP5HD-5O5OvgkcNUhl7JBuINflcjKqUzXZY\",\n \"location_id\": \"76C9W6K8CNNQ5\",\n \"order_id\": \"kcuKDKreRaI4gF4TjmEgZjHk8Z7YY\",\n \"payment_id\": \"5O5OvgkcNUhl7JBuINflcjKqUzXZY\",\n \"reason\": \"Returning items\",\n \"status\": \"PENDING\",\n \"updated_at\": \"2020-09-29T15:21:46.771Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "5866369a-ce74-4bb5-a173-881c53248681", "documentation": "SearchTerminalRefunds", "method": "post", "endpoint": "v2/terminals/refunds/search", "responses": [ { "uuid": "8e90727c-893b-47da-9641-4bb1dd056ae9", "body": "{\n \"refunds\": [\n {\n \"amount_money\": {\n \"amount\": 111,\n \"currency\": \"CAD\"\n },\n \"app_id\": \"sandbox-sq0idb-c2OuYt13YaCAeJq_2cd8OQ\",\n \"card\": {\n \"bin\": \"411111\",\n \"card_brand\": \"INTERAC\",\n \"card_type\": \"CREDIT\",\n \"exp_month\": 1,\n \"exp_year\": 2022,\n \"fingerprint\": \"sq-1-B1fP9MNNmZgVVaPKRND6oDKYbz25S2cTvg9Mzwg3RMTK1zT1PiGRT-AE3nTA8vSmmw\",\n \"last_4\": \"1111\"\n },\n \"created_at\": \"2020-09-29T15:21:46.771Z\",\n \"deadline_duration\": \"PT5M\",\n \"device_id\": \"f72dfb8e-4d65-4e56-aade-ec3fb8d33291\",\n \"id\": \"009DP5HD-5O5OvgkcNUhl7JBuINflcjKqUzXZY\",\n \"location_id\": \"76C9W6K8CNNQ5\",\n \"order_id\": \"kcuKDKreRaI4gF4TjmEgZjHk8Z7YY\",\n \"payment_id\": \"5O5OvgkcNUhl7JBuINflcjKqUzXZY\",\n \"reason\": \"Returning item\",\n \"refund_id\": \"5O5OvgkcNUhl7JBuINflcjKqUzXZY_43Q4iGp7sNeATiWrUruA1EYeMRUXaddXXlDDJ1EQLvb\",\n \"status\": \"COMPLETED\",\n \"updated_at\": \"2020-09-29T15:21:48.675Z\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "0a5a9cb3-c7dd-4225-a609-4daa78c967dc", "documentation": "GetTerminalRefund", "method": "get", "endpoint": "v2/terminals/refunds/:terminal_refund_id", "responses": [ { "uuid": "870cabdc-2d67-4ab6-af86-5eae7bd76c5d", "body": "{\n \"refund\": {\n \"amount_money\": {\n \"amount\": 111,\n \"currency\": \"CAD\"\n },\n \"app_id\": \"sandbox-sq0idb-c2OuYt13YaCAeJq_2cd8OQ\",\n \"card\": {\n \"bin\": \"411111\",\n \"card_brand\": \"INTERAC\",\n \"card_type\": \"CREDIT\",\n \"exp_month\": 1,\n \"exp_year\": 2022,\n \"fingerprint\": \"sq-1-B1fP9MNNmZgVVaPKRND6oDKYbz25S2cTvg9Mzwg3RMTK1zT1PiGRT-AE3nTA8vSmmw\",\n \"last_4\": \"1111\"\n },\n \"created_at\": \"2020-09-29T15:21:46.771Z\",\n \"deadline_duration\": \"PT5M\",\n \"device_id\": \"f72dfb8e-4d65-4e56-aade-ec3fb8d33291\",\n \"id\": \"009DP5HD-5O5OvgkcNUhl7JBuINflcjKqUzXZY\",\n \"location_id\": \"76C9W6K8CNNQ5\",\n \"order_id\": \"kcuKDKreRaI4gF4TjmEgZjHk8Z7YY\",\n \"payment_id\": \"5O5OvgkcNUhl7JBuINflcjKqUzXZY\",\n \"reason\": \"Returning item\",\n \"refund_id\": \"5O5OvgkcNUhl7JBuINflcjKqUzXZY_43Q4iGp7sNeATiWrUruA1EYeMRUXaddXXlDDJ1EQLvb\",\n \"status\": \"COMPLETED\",\n \"updated_at\": \"2020-09-29T15:21:48.675Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "98b6ec81-cf9b-41d2-a219-65051312c30b", "documentation": "CancelTerminalRefund", "method": "post", "endpoint": "v2/terminals/refunds/:terminal_refund_id/cancel", "responses": [ { "uuid": "9e68a59c-e3cb-4b31-b444-facfe52a7b0e", "body": "{\n \"refund\": {\n \"amount_money\": {\n \"amount\": 100,\n \"currency\": \"CAD\"\n },\n \"app_id\": \"sandbox-sq0idb-c2OuYt13YaCAeJq_2cd8OQ\",\n \"cancel_reason\": \"SELLER_CANCELED\",\n \"card\": {\n \"bin\": \"411111\",\n \"card_brand\": \"INTERAC\",\n \"card_type\": \"CREDIT\",\n \"exp_month\": 1,\n \"exp_year\": 2022,\n \"fingerprint\": \"sq-1-B1fP9MNNmZgVVaPKRND6oDKYbz25S2cTvg9Mzwg3RMTK1zT1PiGRT-AE3nTA8vSmmw\",\n \"last_4\": \"1111\"\n },\n \"created_at\": \"2020-10-21T22:47:23.241Z\",\n \"deadline_duration\": \"PT5M\",\n \"device_id\": \"42690809-faa2-4701-a24b-19d3d34c9aaa\",\n \"id\": \"g6ycb6HD-5O5OvgkcNUhl7JBuINflcjKqUzXZY\",\n \"location_id\": \"76C9W6K8CNNQ5\",\n \"order_id\": \"kcuKDKreRaI4gF4TjmEgZjHk8Z7YY\",\n \"payment_id\": \"5O5OvgkcNUhl7JBuINflcjKqUzXZY\",\n \"reason\": \"reason\",\n \"status\": \"CANCELED\",\n \"updated_at\": \"2020-10-21T22:47:30.096Z\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false } ], "proxyMode": false, "proxyHost": "", "proxyRemovePrefix": false, "tlsOptions": { "enabled": false, "type": "CERT", "pfxPath": "", "certPath": "", "keyPath": "", "caPath": "", "passphrase": "" }, "cors": true, "headers": [], "proxyReqHeaders": [ { "key": "", "value": "" } ], "proxyResHeaders": [ { "key": "", "value": "" } ] }