{ "item": [ { "name": "api", "description": "", "item": [ { "name": "v1", "description": "", "item": [ { "name": "auth", "description": "", "item": [ { "name": "login", "description": "", "item": [ { "id": "5148e694-d787-4b92-9632-3f2b4194d4c3", "name": "Login", "request": { "name": "Login", "description": { "content": "Authenticate a user with email/phone and password.\nReturns a JWT token to use in subsequent authenticated requests.\n\n**Auth pipeline**: `jwt_optional_authenticated` (no token required)\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "auth", "login" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/auth/login" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"users\",\n \"attributes\": {\n \"email\": \"\",\n \"phone_number\": \"\",\n \"password\": \"\",\n \"access_token\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "b5cd7702-7575-40e7-b6a7-c6719679ac3d", "name": "Login successful \u2014 returns JWT token and user data", "originalRequest": { "url": { "path": [ "api", "v1", "auth", "login" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/auth/login" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"users\",\n \"attributes\": {\n \"email\": \"\",\n \"phone_number\": \"\",\n \"password\": \"\",\n \"access_token\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"users\",\n \"attributes\": {\n \"token\": \"\",\n \"email\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c13e1fb6-5705-40e8-976c-fb20f1a03d1d", "name": "Authentication failed. Possible error codes:\n- `bad_login` \u2014 Wrong email/phone or password\n- `inactive_user` \u2014 User account is inactive", "originalRequest": { "url": { "path": [ "api", "v1", "auth", "login" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/auth/login" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"users\",\n \"attributes\": {\n \"email\": \"\",\n \"phone_number\": \"\",\n \"password\": \"\",\n \"access_token\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "register", "description": "", "item": [ { "id": "b30cdc42-95bc-4062-a34b-1463726228a2", "name": "Register a new user", "request": { "name": "Register a new user", "description": { "content": "Create a new user account.\nDepending on store settings, phone verification may be required before the account is active.\n\n**Auth pipeline**: `jwt_optional_authenticated`\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "auth", "register" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/auth/register" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"users\",\n \"attributes\": {\n \"password\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"password_confirmation\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"date_of_birth\": \"\",\n \"zip_code\": \"\",\n \"marketing_source\": \"\",\n \"marketing_email_opt_in\": \"\",\n \"marketing_sms_opt_in\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "3bcb9088-554e-498a-a3ce-ec07771ca205", "name": "User created successfully", "originalRequest": { "url": { "path": [ "api", "v1", "auth", "register" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/auth/register" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"users\",\n \"attributes\": {\n \"password\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"password_confirmation\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"date_of_birth\": \"\",\n \"zip_code\": \"\",\n \"marketing_source\": \"\",\n \"marketing_email_opt_in\": \"\",\n \"marketing_sms_opt_in\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"users\",\n \"attributes\": {\n \"token\": \"\",\n \"email\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8b38ed3e-bdd2-40b4-b8f4-c49413d1d309", "name": "Bad Request. Possible error codes:\n- `email_already_exists` \u2014 Email is already in use\n- `phone_already_exists` \u2014 Phone number is already in use\n- `phone_number_requires_confirmation` \u2014 Phone number requires verification", "originalRequest": { "url": { "path": [ "api", "v1", "auth", "register" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/auth/register" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"users\",\n \"attributes\": {\n \"password\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"password_confirmation\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"date_of_birth\": \"\",\n \"zip_code\": \"\",\n \"marketing_source\": \"\",\n \"marketing_email_opt_in\": \"\",\n \"marketing_sms_opt_in\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "verification", "description": "", "item": [ { "id": "05e78c7d-8500-4465-bd14-c8b7ad87a5c9", "name": "Request phone/email verification code", "request": { "name": "Request phone/email verification code", "description": { "content": "Send a verification code to the user's phone number or email address.\nUsed during registration when the store requires phone verification.\n\n**Auth pipeline**: `jwt_optional_authenticated`\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "auth", "verification" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/auth/verification" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"users\",\n \"attributes\": {\n \"phone_number\": \"\",\n \"email\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "0a4913da-9ee5-4d99-ba04-ec63a1c6be57", "name": "Verification code sent successfully", "originalRequest": { "url": { "path": [ "api", "v1", "auth", "verification" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/auth/verification" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"users\",\n \"attributes\": {\n \"phone_number\": \"\",\n \"email\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"notifications\",\n \"attributes\": {\n \"message\": \"\",\n \"level\": \"warning\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8c77e475-3fe7-4f4b-9c9b-4ba93fb7b703", "name": "Bad Request. Possible error codes:\n- `failed_to_request_verification_code` \u2014 Failed to send verification code\n- `verification_code_blocked` \u2014 Too many attempts", "originalRequest": { "url": { "path": [ "api", "v1", "auth", "verification" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/auth/verification" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"users\",\n \"attributes\": {\n \"phone_number\": \"\",\n \"email\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "verification-check", "description": "", "item": [ { "id": "032588d9-07ea-498e-8441-4367139abdf8", "name": "Submit verification code", "request": { "name": "Submit verification code", "description": { "content": "Submit the verification code received via SMS or email.\nOn success, creates or confirms the user account and returns a JWT token.\nCan also complete registration by including user profile fields.\n\n**Auth pipeline**: `jwt_optional_authenticated`\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "auth", "verification-check" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/auth/verification-check" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"users\",\n \"attributes\": {\n \"code\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"verification_mode\": \"\",\n \"password\": \"\",\n \"password_confirmation\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"date_of_birth\": \"\",\n \"marketing_source\": \"\",\n \"marketing_email_opt_in\": \"\",\n \"marketing_sms_opt_in\": \"\",\n \"state_residency\": \"\",\n \"identity_verification_id\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "7483285a-1bb4-4fa4-bc24-cd75ec618158", "name": "Verification successful \u2014 returns JWT token", "originalRequest": { "url": { "path": [ "api", "v1", "auth", "verification-check" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/auth/verification-check" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"users\",\n \"attributes\": {\n \"code\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"verification_mode\": \"\",\n \"password\": \"\",\n \"password_confirmation\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"date_of_birth\": \"\",\n \"marketing_source\": \"\",\n \"marketing_email_opt_in\": \"\",\n \"marketing_sms_opt_in\": \"\",\n \"state_residency\": \"\",\n \"identity_verification_id\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"\",\n \"attributes\": {\n \"token\": \"\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1640a49e-56c2-49c6-a26e-cd5429628799", "name": "Bad Request. Possible error codes:\n- `invalid_verification_code` \u2014 Code is incorrect or expired\n- `verification_not_available` \u2014 Verification session expired", "originalRequest": { "url": { "path": [ "api", "v1", "auth", "verification-check" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/auth/verification-check" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"users\",\n \"attributes\": {\n \"code\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"verification_mode\": \"\",\n \"password\": \"\",\n \"password_confirmation\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"date_of_birth\": \"\",\n \"marketing_source\": \"\",\n \"marketing_email_opt_in\": \"\",\n \"marketing_sms_opt_in\": \"\",\n \"state_residency\": \"\",\n \"identity_verification_id\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "recover_password", "description": "", "item": [ { "id": "f256fe51-4840-4daa-83c9-c5aa14a3917b", "name": "Request password recovery", "request": { "name": "Request password recovery", "description": { "content": "Request a password reset email or SMS. Sends a reset link/code to the\nprovided email or phone number.\n\n**Auth pipeline**: `jwt_optional_authenticated`\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "auth", "recover_password" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/auth/recover_password" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"users\",\n \"attributes\": {\n \"email\": \"\",\n \"phone_number\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "e09c78a9-2ca0-4453-a134-c6e86d9ba506", "name": "Recovery email/SMS sent", "originalRequest": { "url": { "path": [ "api", "v1", "auth", "recover_password" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/auth/recover_password" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"users\",\n \"attributes\": {\n \"email\": \"\",\n \"phone_number\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"notifications\",\n \"attributes\": {\n \"message\": \"\",\n \"level\": \"warning\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "842a7a90-06f2-4a00-9384-e2fa357d0bd1", "name": "Invalid request parameters", "originalRequest": { "url": { "path": [ "api", "v1", "auth", "recover_password" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/auth/recover_password" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"users\",\n \"attributes\": {\n \"email\": \"\",\n \"phone_number\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "reset_password", "description": "", "item": [ { "name": "{token}", "description": "", "item": [ { "id": "e6954f11-75eb-45f4-8832-80f187e83f3d", "name": "Reset password with token", "request": { "name": "Reset password with token", "description": { "content": "Reset the user's password using the token received from the recovery email.\nCan also be called without the path token if a verification code is provided\nin the request body (for phone-based recovery).\n\n**Auth pipeline**: `jwt_optional_authenticated`\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "auth", "reset_password", ":token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "token", "disabled": false, "description": { "content": "(Required) Password reset token from the recovery email", "type": "text/plain" } } ], "raw": "{{baseUrl}}/api/v1/auth/reset_password/:token" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"users\",\n \"attributes\": {\n \"password\": \"\",\n \"password_confirmation\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"code\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "7fe09b3d-3dd7-4bfb-a08a-36028d37ecb4", "name": "Password reset successful", "originalRequest": { "url": { "path": [ "api", "v1", "auth", "reset_password", ":token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Password reset token from the recovery email", "type": "text/plain" }, "type": "any", "value": "", "key": "token" } ], "raw": "{{baseUrl}}/api/v1/auth/reset_password/:token" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"users\",\n \"attributes\": {\n \"password\": \"\",\n \"password_confirmation\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"code\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"\",\n \"attributes\": {\n \"token\": \"\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e02c8905-1fc4-40cd-9658-0fbe90d05900", "name": "Bad Request. Possible error codes:\n- `invalid_token` \u2014 Token is expired or invalid", "originalRequest": { "url": { "path": [ "api", "v1", "auth", "reset_password", ":token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Password reset token from the recovery email", "type": "text/plain" }, "type": "any", "value": "", "key": "token" } ], "raw": "{{baseUrl}}/api/v1/auth/reset_password/:token" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"users\",\n \"attributes\": {\n \"password\": \"\",\n \"password_confirmation\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"code\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "logout", "description": "", "item": [ { "id": "0f7d8008-6a7d-43ee-8bf5-6a2074dfe88a", "name": "Logout", "request": { "name": "Logout", "description": { "content": "Invalidate the current user session and JWT token.\n\n**Auth pipeline**: `jwt_optional_authenticated`\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "auth", "logout" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/auth/logout" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "DELETE", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "761c51a7-d452-4076-bd53-749cfde417f9", "name": "Logout successful", "originalRequest": { "url": { "path": [ "api", "v1", "auth", "logout" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/auth/logout" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"data\": {\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7356ca4f-c227-465c-9e73-317146a40525", "name": "Missing or invalid authentication token", "originalRequest": { "url": { "path": [ "api", "v1", "auth", "logout" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/auth/logout" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "store", "description": "", "item": [ { "id": "3558cf29-fc86-4906-82d8-5c18efb3bbe5", "name": "Get store details", "request": { "name": "Get store details", "description": { "content": "Retrieve the details of the store identified by the `X-Store` header.\nThis is typically the first call a frontend makes to initialize the storefront.\n\n**Auth pipeline**: `jwt_optional_authenticated` (no token required)\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "store" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/store" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "fe1e5b40-0799-45b3-9daf-135e1c07fcdd", "name": "Store details", "originalRequest": { "url": { "path": [ "api", "v1", "store" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/store" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"stores\",\n \"attributes\": {\n \"name\": \"\",\n \"slug\": \"\",\n \"address\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\",\n \"country\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"phone\": \"\",\n \"email\": \"\",\n \"is_active\": \"\",\n \"point_of_sales\": \"\",\n \"delivery_enabled\": \"\",\n \"pickup_enabled\": \"\",\n \"timezone\": \"\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f402a0af-c106-4847-89a9-30665427385f", "name": "Resource not found", "originalRequest": { "url": { "path": [ "api", "v1", "store" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/store" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "settings", "description": "", "item": [ { "id": "cfc445f0-4b67-4335-8c1c-db5f986c5907", "name": "Get store settings", "request": { "name": "Get store settings", "description": { "content": "Retrieve the store's settings including feature flags, UI configuration,\nand operational parameters.\n\n**Auth pipeline**: `jwt_optional_authenticated`\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "store", "settings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/store/settings" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "a56813e4-ba99-4dfe-8823-9a4bb74dd489", "name": "Store settings", "originalRequest": { "url": { "path": [ "api", "v1", "store", "settings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/store/settings" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"store_settings\",\n \"attributes\": {\n \"key_0\": 6585,\n \"key_1\": 1453.0358826244494\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d3f4b3e9-9d2f-41cb-89a3-77289e98b30f", "name": "Resource not found", "originalRequest": { "url": { "path": [ "api", "v1", "store", "settings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/store/settings" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "configuration", "description": "", "item": [ { "id": "3c1eb1ee-b632-4acb-b6ec-a3847b45ae1a", "name": "Get store configuration", "request": { "name": "Get store configuration", "description": { "content": "Retrieve the store's full configuration including group and site associations.\nTypically used by admin/management interfaces.\n\n**Auth pipeline**: `jwt_optional_authenticated`\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "store", "configuration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/store/configuration" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "4a57a198-30c8-4049-9beb-db6ccd75eef0", "name": "Store configuration", "originalRequest": { "url": { "path": [ "api", "v1", "store", "configuration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/store/configuration" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"store_configurations\",\n \"attributes\": {\n \"key_0\": false,\n \"key_1\": false,\n \"key_2\": \"string\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "44ce66d2-b0f9-479d-b2c7-446ca9c7c2c0", "name": "Resource not found", "originalRequest": { "url": { "path": [ "api", "v1", "store", "configuration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/store/configuration" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "schedules", "description": "", "item": [ { "name": "{schedule_type}", "description": "", "item": [ { "id": "b20c4193-163b-4b13-a040-f26cd314d404", "name": "Get store schedules", "request": { "name": "Get store schedules", "description": { "content": "Retrieve the weekly schedule for a given schedule type (e.g. pickup, delivery).\nReturns an entry for each day of the week with open/close intervals.\n\n**Auth pipeline**: `jwt_optional_authenticated`\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "store", "schedules", ":schedule_type" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "operating", "key": "schedule_type", "disabled": false, "description": { "content": "(Required) Type of schedule to retrieve.\nCommon values: `pickup`, `delivery`, `operating`.\n (This can only be one of pickup,delivery,operating)", "type": "text/plain" } } ], "raw": "{{baseUrl}}/api/v1/store/schedules/:schedule_type" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "d098504e-bd9b-4f07-8409-5465d30b62c9", "name": "Weekly schedule entries", "originalRequest": { "url": { "path": [ "api", "v1", "store", "schedules", ":schedule_type" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Type of schedule to retrieve.\nCommon values: `pickup`, `delivery`, `operating`.\n (This can only be one of pickup,delivery,operating)", "type": "text/plain" }, "type": "any", "value": "operating", "key": "schedule_type" } ], "raw": "{{baseUrl}}/api/v1/store/schedules/:schedule_type" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"schedules\",\n \"attributes\": {\n \"weekday\": \"\",\n \"is_closed\": \"\",\n \"intervals\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ]\n }\n },\n {\n \"id\": \"\",\n \"type\": \"schedules\",\n \"attributes\": {\n \"weekday\": \"\",\n \"is_closed\": \"\",\n \"intervals\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ]\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5fdb8e24-cc53-4224-894e-63cfe4b7682c", "name": "Resource not found", "originalRequest": { "url": { "path": [ "api", "v1", "store", "schedules", ":schedule_type" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Type of schedule to retrieve.\nCommon values: `pickup`, `delivery`, `operating`.\n (This can only be one of pickup,delivery,operating)", "type": "text/plain" }, "type": "any", "value": "operating", "key": "schedule_type" } ], "raw": "{{baseUrl}}/api/v1/store/schedules/:schedule_type" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "payment-options", "description": "", "item": [ { "id": "6085716f-49b0-4141-8c17-e0c646e9ce47", "name": "List store payment options", "request": { "name": "List store payment options", "description": { "content": "Retrieve the available payment methods for the store.\nResults vary based on user role (customer vs admin) and delivery type.\n\n**Auth pipeline**: `jwt_optional_authenticated`\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "store", "payment-options" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter payment options by delivery type (This can only be one of pickup,delivery)", "type": "text/plain" }, "key": "delivery_type", "value": "delivery" } ], "variable": [], "raw": "{{baseUrl}}/api/v1/store/payment-options?delivery_type=delivery" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "06219b03-5ea8-47c3-8443-9ba1af5b8efc", "name": "List of payment options", "originalRequest": { "url": { "path": [ "api", "v1", "store", "payment-options" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter payment options by delivery type (This can only be one of pickup,delivery)", "type": "text/plain" }, "key": "delivery_type", "value": "delivery" } ], "variable": [], "raw": "{{baseUrl}}/api/v1/store/payment-options?delivery_type=delivery" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"payment_options\",\n \"attributes\": {\n \"id\": \"\",\n \"name\": \"\",\n \"service\": \"\",\n \"is_active\": \"\",\n \"is_default\": \"\",\n \"payment_type\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"type\": \"payment_options\",\n \"attributes\": {\n \"id\": \"\",\n \"name\": \"\",\n \"service\": \"\",\n \"is_active\": \"\",\n \"is_default\": \"\",\n \"payment_type\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0d7fa667-b46f-4324-8284-4ebab9e64a45", "name": "Resource not found", "originalRequest": { "url": { "path": [ "api", "v1", "store", "payment-options" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter payment options by delivery type (This can only be one of pickup,delivery)", "type": "text/plain" }, "key": "delivery_type", "value": "delivery" } ], "variable": [], "raw": "{{baseUrl}}/api/v1/store/payment-options?delivery_type=delivery" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "site", "description": "", "item": [ { "id": "eb65e4d8-5ad6-45c2-8451-0bbe72dd4e6c", "name": "Get store site", "request": { "name": "Get store site", "description": { "content": "Retrieve the storefront site for the store identified by the `X-Store` header.\n\nThe `url` attribute is the public storefront base URL, always returned with a\ntrailing slash. Use it to build links into the Blaze-hosted storefront \u2014 most\nnotably the checkout handoff URL, `{url}checkout/{cart_uuid}/`. See the\n[Checkout Handoff guide](/guides/checkout-handoff).\n\nReturns `null` for `url` when the store has no published site.\n\n**Auth pipeline**: `jwt_optional_authenticated` (no token required)\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "store", "site" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/store/site" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "73523ade-4534-4946-bffe-d25ddc7fb7d7", "name": "Store site details", "originalRequest": { "url": { "path": [ "api", "v1", "store", "site" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/store/site" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"store_sites\",\n \"attributes\": {\n \"url\": \"\",\n \"basepath\": \"\",\n \"pathname\": \"\",\n \"logo_url\": \"\",\n \"favicon_url\": \"\",\n \"home_link_url\": \"\",\n \"html_head\": \"\",\n \"html_title\": \"\",\n \"meta_description\": \"\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4dc45391-7449-4c4d-8a7e-8fc5ad8d75d9", "name": "Resource not found", "originalRequest": { "url": { "path": [ "api", "v1", "store", "site" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/store/site" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "promotional-banners", "description": "", "item": [ { "id": "b2d60498-2fa1-4118-ac0d-ff41d6f57db0", "name": "List promotional banners", "request": { "name": "List promotional banners", "description": { "content": "Retrieve all active promotional banners for the store's storefront.\nUse these to render hero banners, carousels, or promotional sections.\n\n**Auth pipeline**: `jwt_optional_authenticated`\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "store", "site", "promotional-banners" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/store/site/promotional-banners" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "5f1dfa20-ac21-450d-8b5f-014317cd7629", "name": "List of promotional banners", "originalRequest": { "url": { "path": [ "api", "v1", "store", "site", "promotional-banners" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/store/site/promotional-banners" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"promotional_banners\",\n \"attributes\": {\n \"id\": \"\",\n \"title\": \"\",\n \"subtitle\": \"\",\n \"image_url\": \"\",\n \"link_url\": \"\",\n \"position\": \"\",\n \"is_active\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"type\": \"promotional_banners\",\n \"attributes\": {\n \"id\": \"\",\n \"title\": \"\",\n \"subtitle\": \"\",\n \"image_url\": \"\",\n \"link_url\": \"\",\n \"position\": \"\",\n \"is_active\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1766a48b-d5bb-4661-a5b6-ae312e4e7f8e", "name": "Resource not found", "originalRequest": { "url": { "path": [ "api", "v1", "store", "site", "promotional-banners" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/store/site/promotional-banners" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "socials", "description": "", "item": [ { "id": "0b445ee6-cb54-48ca-aeb4-9f6af6fd2211", "name": "List store social networks", "request": { "name": "List store social networks", "description": { "content": "Retrieve the store's social network links (Instagram, Facebook, Twitter, etc.).\n\n**Auth pipeline**: `jwt_optional_authenticated`\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "store", "socials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/store/socials" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "c2c8c3d1-adfb-42d1-8a28-da902592e0fe", "name": "List of social network links", "originalRequest": { "url": { "path": [ "api", "v1", "store", "socials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/store/socials" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"social_networks\",\n \"attributes\": {\n \"name\": \"\",\n \"url\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"type\": \"social_networks\",\n \"attributes\": {\n \"name\": \"\",\n \"url\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "566e91a8-50fc-4820-89ea-ac03a00470b5", "name": "Resource not found", "originalRequest": { "url": { "path": [ "api", "v1", "store", "socials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/store/socials" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "pages", "description": "", "item": [ { "id": "f84e35b3-1234-452d-8b55-7dda5e4a20bf", "name": "List store pages", "request": { "name": "List store pages", "description": { "content": "Retrieve all custom pages for the store (e.g. About Us, FAQ, Terms).\n\n**Auth pipeline**: `jwt_optional_authenticated`\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "store", "pages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/store/pages" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "92d0f7fb-751a-4125-bff3-613deb9d5a37", "name": "List of custom pages", "originalRequest": { "url": { "path": [ "api", "v1", "store", "pages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/store/pages" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"store_pages\",\n \"attributes\": {\n \"id\": \"\",\n \"title\": \"\",\n \"slug\": \"\",\n \"content\": \"\",\n \"is_active\": \"\",\n \"position\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"type\": \"store_pages\",\n \"attributes\": {\n \"id\": \"\",\n \"title\": \"\",\n \"slug\": \"\",\n \"content\": \"\",\n \"is_active\": \"\",\n \"position\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1d96b50b-7264-4b46-ba67-702b06df6b49", "name": "Resource not found", "originalRequest": { "url": { "path": [ "api", "v1", "store", "pages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/store/pages" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "availabilities", "description": "", "item": [ { "name": "{schedule_type}", "description": "", "item": [ { "id": "4b1f03b6-5088-4d5a-a186-6a21fce0ea74", "name": "Get store availabilities", "request": { "name": "Get store availabilities", "description": { "content": "Retrieve available time slots for a given schedule type.\nReturns upcoming dates with their available booking/delivery slots.\n\n**Auth pipeline**: `jwt_optional_authenticated`\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "store", "availabilities", ":schedule_type" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "delivery", "key": "schedule_type", "disabled": false, "description": { "content": "(Required) Type of availability to check.\nCommon values: `pickup`, `delivery`.\n (This can only be one of pickup,delivery)", "type": "text/plain" } } ], "raw": "{{baseUrl}}/api/v1/store/availabilities/:schedule_type" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "9f52f3d9-6d9a-464f-8e91-e2e86849227e", "name": "Available time slots", "originalRequest": { "url": { "path": [ "api", "v1", "store", "availabilities", ":schedule_type" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Type of availability to check.\nCommon values: `pickup`, `delivery`.\n (This can only be one of pickup,delivery)", "type": "text/plain" }, "type": "any", "value": "delivery", "key": "schedule_type" } ], "raw": "{{baseUrl}}/api/v1/store/availabilities/:schedule_type" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"availabilities\",\n \"attributes\": {\n \"date\": \"\",\n \"slots\": [\n {\n \"start\": \"\",\n \"end\": \"\",\n \"available\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\",\n \"available\": \"\"\n }\n ]\n }\n },\n {\n \"id\": \"\",\n \"type\": \"availabilities\",\n \"attributes\": {\n \"date\": \"\",\n \"slots\": [\n {\n \"start\": \"\",\n \"end\": \"\",\n \"available\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\",\n \"available\": \"\"\n }\n ]\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7c4719dd-3dd2-4043-a9d1-791aae5f42d9", "name": "Resource not found", "originalRequest": { "url": { "path": [ "api", "v1", "store", "availabilities", ":schedule_type" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Type of availability to check.\nCommon values: `pickup`, `delivery`.\n (This can only be one of pickup,delivery)", "type": "text/plain" }, "type": "any", "value": "delivery", "key": "schedule_type" } ], "raw": "{{baseUrl}}/api/v1/store/availabilities/:schedule_type" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "deals", "description": "", "item": [ { "name": "promotions", "description": "", "item": [ { "id": "09270c9b-1fc2-4396-bc12-22fd3e91e1da", "name": "List promotions", "request": { "name": "List promotions", "description": { "content": "Retrieve all available promotions/deals for the store.\n\n**Auth pipeline**: `jwt_optional_authenticated`\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "store", "deals", "promotions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Maximum number of results to return. Defaults to 20.", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Number of results to skip for pagination. Defaults to 0.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [], "raw": "{{baseUrl}}/api/v1/store/deals/promotions?limit=20&offset=0" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "db478cd5-bdf5-40bd-9341-022578f29732", "name": "List of promotions", "originalRequest": { "url": { "path": [ "api", "v1", "store", "deals", "promotions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Maximum number of results to return. Defaults to 20.", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Number of results to skip for pagination. Defaults to 0.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [], "raw": "{{baseUrl}}/api/v1/store/deals/promotions?limit=20&offset=0" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"promotions\",\n \"attributes\": {\n \"name\": \"\",\n \"slug\": \"\",\n \"description\": \"\",\n \"image_url\": \"\",\n \"discount_type\": \"\",\n \"discount_value\": \"\",\n \"is_active\": \"\",\n \"start_date\": \"\",\n \"end_date\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"type\": \"promotions\",\n \"attributes\": {\n \"name\": \"\",\n \"slug\": \"\",\n \"description\": \"\",\n \"image_url\": \"\",\n \"discount_type\": \"\",\n \"discount_value\": \"\",\n \"is_active\": \"\",\n \"start_date\": \"\",\n \"end_date\": \"\"\n }\n }\n ],\n \"included\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n },\n \"key_1\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n },\n \"key_2\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n },\n \"key_3\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n }\n }\n }\n ],\n \"meta\": {\n \"total\": \"\",\n \"limit\": \"\",\n \"offset\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{slug_or_id}", "description": "", "item": [ { "id": "1a58426f-171a-4227-8061-82e2f9e86493", "name": "Get promotion detail", "request": { "name": "Get promotion detail", "description": { "content": "Retrieve details for a single promotion by slug or ID.\n\n**Auth pipeline**: `jwt_optional_authenticated`\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "store", "deals", "promotions", ":slug_or_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "slug_or_id", "disabled": false, "description": { "content": "(Required) Promotion slug or UUID", "type": "text/plain" } } ], "raw": "{{baseUrl}}/api/v1/store/deals/promotions/:slug_or_id" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "d15ba58e-3739-4da3-9997-ae920a61af82", "name": "Promotion details", "originalRequest": { "url": { "path": [ "api", "v1", "store", "deals", "promotions", ":slug_or_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Promotion slug or UUID", "type": "text/plain" }, "type": "any", "value": "", "key": "slug_or_id" } ], "raw": "{{baseUrl}}/api/v1/store/deals/promotions/:slug_or_id" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"promotions\",\n \"attributes\": {\n \"name\": \"\",\n \"slug\": \"\",\n \"description\": \"\",\n \"image_url\": \"\",\n \"discount_type\": \"\",\n \"discount_value\": \"\",\n \"is_active\": \"\",\n \"start_date\": \"\",\n \"end_date\": \"\"\n }\n },\n \"included\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n },\n \"key_1\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4ebecd11-707b-4bd9-ba60-a53fcb6bf011", "name": "Resource not found", "originalRequest": { "url": { "path": [ "api", "v1", "store", "deals", "promotions", ":slug_or_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Promotion slug or UUID", "type": "text/plain" }, "type": "any", "value": "", "key": "slug_or_id" } ], "raw": "{{baseUrl}}/api/v1/store/deals/promotions/:slug_or_id" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "rewards", "description": "", "item": [ { "id": "85d369e0-15cf-4686-b5d4-bc140037461b", "name": "List rewards", "request": { "name": "List rewards", "description": { "content": "Retrieve all available rewards for the store.\nRewards are redeemable via the loyalty points system.\n\n**Auth pipeline**: `jwt_optional_authenticated`\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "store", "deals", "rewards" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Maximum number of results to return. Defaults to 20.", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Number of results to skip for pagination. Defaults to 0.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [], "raw": "{{baseUrl}}/api/v1/store/deals/rewards?limit=20&offset=0" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "6e7d30de-7ece-47be-bec6-d98f13786c3a", "name": "List of rewards", "originalRequest": { "url": { "path": [ "api", "v1", "store", "deals", "rewards" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Maximum number of results to return. Defaults to 20.", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Number of results to skip for pagination. Defaults to 0.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [], "raw": "{{baseUrl}}/api/v1/store/deals/rewards?limit=20&offset=0" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"rewards\",\n \"attributes\": {\n \"name\": \"\",\n \"slug\": \"\",\n \"description\": \"\",\n \"image_url\": \"\",\n \"points_required\": \"\",\n \"discount_type\": \"\",\n \"discount_value\": \"\",\n \"is_active\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"type\": \"rewards\",\n \"attributes\": {\n \"name\": \"\",\n \"slug\": \"\",\n \"description\": \"\",\n \"image_url\": \"\",\n \"points_required\": \"\",\n \"discount_type\": \"\",\n \"discount_value\": \"\",\n \"is_active\": \"\"\n }\n }\n ],\n \"included\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n },\n \"key_1\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n },\n \"key_1\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n },\n \"key_2\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n },\n \"key_3\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n }\n }\n }\n ],\n \"meta\": {\n \"total\": \"\",\n \"limit\": \"\",\n \"offset\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{slug_or_id}", "description": "", "item": [ { "id": "cfb72bbb-cd92-49d5-9bd3-c74e492dfeea", "name": "Get reward detail", "request": { "name": "Get reward detail", "description": { "content": "Retrieve details for a single reward by slug or ID.\n\n**Auth pipeline**: `jwt_optional_authenticated`\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "store", "deals", "rewards", ":slug_or_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "slug_or_id", "disabled": false, "description": { "content": "(Required) Reward slug or UUID", "type": "text/plain" } } ], "raw": "{{baseUrl}}/api/v1/store/deals/rewards/:slug_or_id" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "d74def50-0aca-4cb6-b792-525e54238075", "name": "Reward details", "originalRequest": { "url": { "path": [ "api", "v1", "store", "deals", "rewards", ":slug_or_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Reward slug or UUID", "type": "text/plain" }, "type": "any", "value": "", "key": "slug_or_id" } ], "raw": "{{baseUrl}}/api/v1/store/deals/rewards/:slug_or_id" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"rewards\",\n \"attributes\": {\n \"name\": \"\",\n \"slug\": \"\",\n \"description\": \"\",\n \"image_url\": \"\",\n \"points_required\": \"\",\n \"discount_type\": \"\",\n \"discount_value\": \"\",\n \"is_active\": \"\"\n }\n },\n \"included\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "51d44c4e-8f3c-49bb-8457-4037f871477c", "name": "Resource not found", "originalRequest": { "url": { "path": [ "api", "v1", "store", "deals", "rewards", ":slug_or_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Reward slug or UUID", "type": "text/plain" }, "type": "any", "value": "", "key": "slug_or_id" } ], "raw": "{{baseUrl}}/api/v1/store/deals/rewards/:slug_or_id" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] }, { "name": "payments", "description": "", "item": [ { "name": "{service}", "description": "", "item": [ { "name": "token", "description": "", "item": [ { "id": "f687f96f-80cd-45a4-9841-cb0ca556a15f", "name": "Get payment customer token", "request": { "name": "Get payment customer token", "description": { "content": "Retrieve a client-side token for the payment provider SDK.\nUsed to initialize payment forms (e.g. Braintree drop-in, Stripe Elements).\n\n**Auth pipeline**: `jwt_authenticated`\n\n**Error codes**:\n- `payment_option_not_found` \u2014 Payment option not found for the service\n- `payment_customer_not_found` \u2014 Payment customer not found\n- `not_found_payment_config` \u2014 Payment configuration not found\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "store", "payments", ":service", "token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "service", "disabled": false, "description": { "content": "(Required) Payment service name (e.g. \"stronghold\", \"moneris\", \"adyen\")", "type": "text/plain" } } ], "raw": "{{baseUrl}}/api/v1/store/payments/:service/token" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "f384d28f-552d-445b-9fb2-22669cc197c2", "name": "Payment customer token", "originalRequest": { "url": { "path": [ "api", "v1", "store", "payments", ":service", "token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Payment service name (e.g. \"stronghold\", \"moneris\", \"adyen\")", "type": "text/plain" }, "type": "any", "value": "", "key": "service" } ], "raw": "{{baseUrl}}/api/v1/store/payments/:service/token" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a6eaa42e-f94c-4dca-8b0e-286aaa564a05", "name": "Possible error codes:\n- `payment_option_not_found` \u2014 Payment option not found\n- `payment_customer_not_found` \u2014 Payment customer not found\n- `not_found_payment_config` \u2014 Payment config not found", "originalRequest": { "url": { "path": [ "api", "v1", "store", "payments", ":service", "token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Payment service name (e.g. \"stronghold\", \"moneris\", \"adyen\")", "type": "text/plain" }, "type": "any", "value": "", "key": "service" } ], "raw": "{{baseUrl}}/api/v1/store/payments/:service/token" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1f727d87-6e8f-4237-b1c0-c989b71d2734", "name": "Missing or invalid authentication token", "originalRequest": { "url": { "path": [ "api", "v1", "store", "payments", ":service", "token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Payment service name (e.g. \"stronghold\", \"moneris\", \"adyen\")", "type": "text/plain" }, "type": "any", "value": "", "key": "service" } ], "raw": "{{baseUrl}}/api/v1/store/payments/:service/token" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "sources", "description": "", "item": [ { "id": "1ad67355-e966-4839-8368-fccdf4a9c34b", "name": "List payment sources (v1)", "request": { "name": "List payment sources (v1)", "description": { "content": "List saved payment sources (cards, bank accounts) for the authenticated user\nunder the specified payment service.\n\n**Auth pipeline**: `jwt_authenticated`\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "store", "payments", ":service", "sources" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "service", "disabled": false, "description": { "content": "(Required) Payment service name", "type": "text/plain" } } ], "raw": "{{baseUrl}}/api/v1/store/payments/:service/sources" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "3792e26d-49a2-4e0c-9cf6-79ce88bf844f", "name": "List of payment sources", "originalRequest": { "url": { "path": [ "api", "v1", "store", "payments", ":service", "sources" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Payment service name", "type": "text/plain" }, "type": "any", "value": "", "key": "service" } ], "raw": "{{baseUrl}}/api/v1/store/payments/:service/sources" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "488185c7-ae3f-4ed3-8b00-8bfb0e60edc3", "name": "Missing or invalid authentication token", "originalRequest": { "url": { "path": [ "api", "v1", "store", "payments", ":service", "sources" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Payment service name", "type": "text/plain" }, "type": "any", "value": "", "key": "service" } ], "raw": "{{baseUrl}}/api/v1/store/payments/:service/sources" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7e4bf7aa-7cf5-4261-bdd8-04481b6c99ec", "name": "Add payment source", "request": { "name": "Add payment source", "description": { "content": "**Access**: restricted to certified partners. Uncertified integrations should use the\n[Checkout Handoff](/guides/checkout-handoff) instead.\n\nAdd a new payment source (card, bank account) for the authenticated user.\n\n**Auth pipeline**: `jwt_authenticated`\n\n**Error codes**:\n- `invalid_payment_source` \u2014 Missing required payment source fields\n- `guest_cannot_add_source` \u2014 Cannot add sources during guest checkout\n- `payment_option_not_found` \u2014 Payment option not found\n- `missing_payment_source` \u2014 Payment source data missing\n- `invalid_payment_token` \u2014 Payment card is invalid\n- `expired_payment_token` \u2014 Payment card has expired\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "store", "payments", ":service", "sources" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "service", "disabled": false, "description": { "content": "(Required) Payment service name", "type": "text/plain" } } ], "raw": "{{baseUrl}}/api/v1/store/payments/:service/sources" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"payment_sources\",\n \"attributes\": {\n \"key_0\": \"string\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "fd0d1cec-5b7a-4ab8-8eff-4c089a0f4bba", "name": "Payment source added", "originalRequest": { "url": { "path": [ "api", "v1", "store", "payments", ":service", "sources" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Payment service name", "type": "text/plain" }, "type": "any", "value": "", "key": "service" } ], "raw": "{{baseUrl}}/api/v1/store/payments/:service/sources" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"payment_sources\",\n \"attributes\": {\n \"key_0\": \"string\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5db7bbe7-f1e3-47b1-9a7b-13068b9644ce", "name": "Possible error codes:\n- `invalid_payment_source` \u2014 Missing required fields\n- `guest_cannot_add_source` \u2014 Guest checkout limitation\n- `invalid_payment_token` \u2014 Card is invalid\n- `expired_payment_token` \u2014 Card has expired", "originalRequest": { "url": { "path": [ "api", "v1", "store", "payments", ":service", "sources" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Payment service name", "type": "text/plain" }, "type": "any", "value": "", "key": "service" } ], "raw": "{{baseUrl}}/api/v1/store/payments/:service/sources" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"payment_sources\",\n \"attributes\": {\n \"key_0\": \"string\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3e4b4bdb-5f3b-42e7-8b0e-644a7b01bcf5", "name": "Missing or invalid authentication token", "originalRequest": { "url": { "path": [ "api", "v1", "store", "payments", ":service", "sources" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Payment service name", "type": "text/plain" }, "type": "any", "value": "", "key": "service" } ], "raw": "{{baseUrl}}/api/v1/store/payments/:service/sources" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"payment_sources\",\n \"attributes\": {\n \"key_0\": \"string\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{id}", "description": "", "item": [ { "id": "9a7f016c-2c96-4fa1-ba2b-a350cdd676f3", "name": "Delete payment source", "request": { "name": "Delete payment source", "description": { "content": "Remove a saved payment source.\n\n**Auth pipeline**: `jwt_authenticated`\n\n**Error codes**:\n- `payment_source_not_found` \u2014 Payment source not found\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "store", "payments", ":service", "sources", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "service", "disabled": false, "description": { "content": "(Required) Payment service name", "type": "text/plain" } }, { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Payment source ID", "type": "text/plain" } } ], "raw": "{{baseUrl}}/api/v1/store/payments/:service/sources/:id" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "DELETE", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "b0c98c5e-288a-46bb-86ef-47d10a032d07", "name": "Payment source deleted", "originalRequest": { "url": { "path": [ "api", "v1", "store", "payments", ":service", "sources", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Payment service name", "type": "text/plain" }, "type": "any", "value": "", "key": "service" }, { "disabled": false, "description": { "content": "(Required) Payment source ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ], "raw": "{{baseUrl}}/api/v1/store/payments/:service/sources/:id" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ce5da366-e493-45b1-81c9-211dff947122", "name": "Possible error codes:\n- `payment_source_not_found` \u2014 Source not found", "originalRequest": { "url": { "path": [ "api", "v1", "store", "payments", ":service", "sources", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Payment service name", "type": "text/plain" }, "type": "any", "value": "", "key": "service" }, { "disabled": false, "description": { "content": "(Required) Payment source ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ], "raw": "{{baseUrl}}/api/v1/store/payments/:service/sources/:id" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "30f2af4a-b055-44ec-9e1d-d310f2fd5fcf", "name": "Missing or invalid authentication token", "originalRequest": { "url": { "path": [ "api", "v1", "store", "payments", ":service", "sources", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Payment service name", "type": "text/plain" }, "type": "any", "value": "", "key": "service" }, { "disabled": false, "description": { "content": "(Required) Payment source ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ], "raw": "{{baseUrl}}/api/v1/store/payments/:service/sources/:id" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cec8cb5a-df6c-4c31-8e93-fd0b40aff989", "name": "Update payment source", "request": { "name": "Update payment source", "description": { "content": "**Access**: restricted to certified partners. Uncertified integrations should use the\n[Checkout Handoff](/guides/checkout-handoff) instead.\n\nUpdate a payment source (e.g. set as default).\n\n**Auth pipeline**: `jwt_authenticated`\n\n**Error codes**:\n- `payment_source_not_found` \u2014 Payment source not found\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "store", "payments", ":service", "sources", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "service", "disabled": false, "description": { "content": "(Required) Payment service name", "type": "text/plain" } }, { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Payment source ID", "type": "text/plain" } } ], "raw": "{{baseUrl}}/api/v1/store/payments/:service/sources/:id" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"payment_sources\",\n \"attributes\": {\n \"key_0\": \"string\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "3e91affd-50ab-4ea5-b873-929549775079", "name": "Payment source updated", "originalRequest": { "url": { "path": [ "api", "v1", "store", "payments", ":service", "sources", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Payment service name", "type": "text/plain" }, "type": "any", "value": "", "key": "service" }, { "disabled": false, "description": { "content": "(Required) Payment source ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ], "raw": "{{baseUrl}}/api/v1/store/payments/:service/sources/:id" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"payment_sources\",\n \"attributes\": {\n \"key_0\": \"string\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a343d48b-9527-4916-ab76-d2acc2d0c8a3", "name": "Possible error codes:\n- `payment_source_not_found` \u2014 Source not found", "originalRequest": { "url": { "path": [ "api", "v1", "store", "payments", ":service", "sources", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Payment service name", "type": "text/plain" }, "type": "any", "value": "", "key": "service" }, { "disabled": false, "description": { "content": "(Required) Payment source ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ], "raw": "{{baseUrl}}/api/v1/store/payments/:service/sources/:id" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"payment_sources\",\n \"attributes\": {\n \"key_0\": \"string\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8109400d-5e29-4d3b-8dbb-e06c77593c9b", "name": "Missing or invalid authentication token", "originalRequest": { "url": { "path": [ "api", "v1", "store", "payments", ":service", "sources", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Payment service name", "type": "text/plain" }, "type": "any", "value": "", "key": "service" }, { "disabled": false, "description": { "content": "(Required) Payment source ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ], "raw": "{{baseUrl}}/api/v1/store/payments/:service/sources/:id" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"payment_sources\",\n \"attributes\": {\n \"key_0\": \"string\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "sessions", "description": "", "item": [ { "id": "6cc688ca-329f-4201-8f31-9f4eca221935", "name": "Create payment session", "request": { "name": "Create payment session", "description": { "content": "**Access**: restricted to certified partners. Uncertified integrations should use the\n[Checkout Handoff](/guides/checkout-handoff) instead.\n\nCreate a payment session for client-side payment initialization.\nUsed by providers that require server-side session creation (e.g. Adyen, Aeropay).\n\n**Auth pipeline**: `jwt_optional_authenticated`\n\n**Error codes**:\n- `payment_option_not_found` \u2014 Payment option not found\n- `not_found_payment_config` \u2014 Payment configuration not found\n- `inactive_service_config` \u2014 Service config is inactive\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "store", "payments", ":service", "sessions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "service", "disabled": false, "description": { "content": "(Required) Payment service name", "type": "text/plain" } } ], "raw": "{{baseUrl}}/api/v1/store/payments/:service/sessions" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "POST", "body": {}, "auth": { "type": "noauth" } }, "response": [ { "id": "b11973dd-0d38-412c-8007-8ec0da7bee92", "name": "Payment session created", "originalRequest": { "url": { "path": [ "api", "v1", "store", "payments", ":service", "sessions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Payment service name", "type": "text/plain" }, "type": "any", "value": "", "key": "service" } ], "raw": "{{baseUrl}}/api/v1/store/payments/:service/sessions" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c3145e88-e230-4506-9a26-7ad2e6221a53", "name": "Possible error codes:\n- `payment_option_not_found` \u2014 Payment option not found\n- `not_found_payment_config` \u2014 Config not found", "originalRequest": { "url": { "path": [ "api", "v1", "store", "payments", ":service", "sessions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Payment service name", "type": "text/plain" }, "type": "any", "value": "", "key": "service" } ], "raw": "{{baseUrl}}/api/v1/store/payments/:service/sessions" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0f9f1e5-ac81-4d73-8330-4b89972cefd2", "name": "Missing or invalid authentication token", "originalRequest": { "url": { "path": [ "api", "v1", "store", "payments", ":service", "sessions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Payment service name", "type": "text/plain" }, "type": "any", "value": "", "key": "service" } ], "raw": "{{baseUrl}}/api/v1/store/payments/:service/sessions" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "orders", "description": "", "item": [ { "name": "{uuid}", "description": "", "item": [ { "name": "pay", "description": "", "item": [ { "id": "a6649992-c960-4559-a103-54d9b2e72b81", "name": "Pay for order", "request": { "name": "Pay for order", "description": { "content": "**Access**: restricted to certified partners. Uncertified integrations should use the\n[Checkout Handoff](/guides/checkout-handoff) instead.\n\nSubmit payment for an order. The payment source and charge details vary by provider.\n\n**Auth pipeline**: `jwt_authenticated`\n\n**Error codes**:\n- `order_already_paid` \u2014 Order has already been paid\n- `payment_failed` \u2014 Payment authorization or capture failed\n- `missing_payment_source` \u2014 No payment source provided\n- `missing_payment_source_identifier` \u2014 No source ID or token\n- `charge_not_authorized` \u2014 Payment not yet authorized\n- `order_user_mismatch` \u2014 Order belongs to another user\n- `charge_canceled` \u2014 Payment canceled by provider\n- `missing_billing_address` \u2014 Billing address required\n- `missing_payment_postal_code` \u2014 Postal code required\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "store", "payments", ":service", "orders", ":uuid", "pay" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "service", "disabled": false, "description": { "content": "(Required) Payment service name", "type": "text/plain" } }, { "type": "any", "value": "", "key": "uuid", "disabled": false, "description": { "content": "(Required) Order UUID", "type": "text/plain" } } ], "raw": "{{baseUrl}}/api/v1/store/payments/:service/orders/:uuid/pay" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"payments_charge\",\n \"attributes\": {\n \"key_0\": 3551,\n \"key_1\": 3728.653995328639,\n \"key_2\": false\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "4c4996fe-4b89-47bd-8043-53e10e70f8e6", "name": "Payment processed", "originalRequest": { "url": { "path": [ "api", "v1", "store", "payments", ":service", "orders", ":uuid", "pay" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Payment service name", "type": "text/plain" }, "type": "any", "value": "", "key": "service" }, { "disabled": false, "description": { "content": "(Required) Order UUID", "type": "text/plain" }, "type": "any", "value": "", "key": "uuid" } ], "raw": "{{baseUrl}}/api/v1/store/payments/:service/orders/:uuid/pay" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"payments_charge\",\n \"attributes\": {\n \"key_0\": 3551,\n \"key_1\": 3728.653995328639,\n \"key_2\": false\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "460930c8-10fb-4182-8e99-45e00321905e", "name": "Possible error codes:\n- `order_already_paid` \u2014 Order already paid\n- `payment_failed` \u2014 Payment failed\n- `missing_payment_source` \u2014 No source provided\n- `charge_not_authorized` \u2014 Not yet authorized\n- `order_user_mismatch` \u2014 Wrong user", "originalRequest": { "url": { "path": [ "api", "v1", "store", "payments", ":service", "orders", ":uuid", "pay" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Payment service name", "type": "text/plain" }, "type": "any", "value": "", "key": "service" }, { "disabled": false, "description": { "content": "(Required) Order UUID", "type": "text/plain" }, "type": "any", "value": "", "key": "uuid" } ], "raw": "{{baseUrl}}/api/v1/store/payments/:service/orders/:uuid/pay" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"payments_charge\",\n \"attributes\": {\n \"key_0\": 3551,\n \"key_1\": 3728.653995328639,\n \"key_2\": false\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e3b0aa4f-b0f5-4481-82fd-2c6f85772015", "name": "Missing or invalid authentication token", "originalRequest": { "url": { "path": [ "api", "v1", "store", "payments", ":service", "orders", ":uuid", "pay" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Payment service name", "type": "text/plain" }, "type": "any", "value": "", "key": "service" }, { "disabled": false, "description": { "content": "(Required) Order UUID", "type": "text/plain" }, "type": "any", "value": "", "key": "uuid" } ], "raw": "{{baseUrl}}/api/v1/store/payments/:service/orders/:uuid/pay" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"payments_charge\",\n \"attributes\": {\n \"key_0\": 3551,\n \"key_1\": 3728.653995328639,\n \"key_2\": false\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] }, { "name": "tip", "description": "", "item": [ { "id": "4b850b75-efe4-40ca-813b-4ac49b2c5c21", "name": "Tip", "request": { "name": "Tip", "description": { "content": "**Access**: restricted to certified partners. Uncertified integrations should use the\n[Checkout Handoff](/guides/checkout-handoff) instead.\n\nSubmit a tip for a completed order via the specified payment service.\n\n**Auth pipeline**: `jwt_authenticated`\n\n**Error codes**:\n- `already_tipped` \u2014 Tip already processed for this order\n- `tips_not_allowed` \u2014 Tips not allowed for the selected payment option\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "store", "payments", ":service", "tip" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "service", "disabled": false, "description": { "content": "(Required) Payment service name", "type": "text/plain" } } ], "raw": "{{baseUrl}}/api/v1/store/payments/:service/tip" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"payment_sources\",\n \"attributes\": {\n \"external_id\": \"\",\n \"percentage\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "7e1eab79-89a2-452a-9387-2a1d9bb7fb27", "name": "Tip processed", "originalRequest": { "url": { "path": [ "api", "v1", "store", "payments", ":service", "tip" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Payment service name", "type": "text/plain" }, "type": "any", "value": "", "key": "service" } ], "raw": "{{baseUrl}}/api/v1/store/payments/:service/tip" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"payment_sources\",\n \"attributes\": {\n \"external_id\": \"\",\n \"percentage\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0429af1a-8e0b-424d-ba9a-06b26b17ea76", "name": "Possible error codes:\n- `already_tipped` \u2014 Tip already processed\n- `tips_not_allowed` \u2014 Tips not allowed", "originalRequest": { "url": { "path": [ "api", "v1", "store", "payments", ":service", "tip" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Payment service name", "type": "text/plain" }, "type": "any", "value": "", "key": "service" } ], "raw": "{{baseUrl}}/api/v1/store/payments/:service/tip" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"payment_sources\",\n \"attributes\": {\n \"external_id\": \"\",\n \"percentage\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "781f20ca-c903-4d37-bf26-6ca9d45ac76f", "name": "Missing or invalid authentication token", "originalRequest": { "url": { "path": [ "api", "v1", "store", "payments", ":service", "tip" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Payment service name", "type": "text/plain" }, "type": "any", "value": "", "key": "service" } ], "raw": "{{baseUrl}}/api/v1/store/payments/:service/tip" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"payment_sources\",\n \"attributes\": {\n \"external_id\": \"\",\n \"percentage\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "promotions", "description": "", "item": [ { "id": "95f5995d-c799-4e84-8fe9-ee3a181f4002", "name": "List payment promotions", "request": { "name": "List payment promotions", "description": { "content": "List promotions available through the specified payment service.\n\n**Auth pipeline**: `jwt_authenticated`\n\n**Error codes**:\n- `promotions_not_allowed` \u2014 Promotions not allowed for this payment option\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "store", "payments", ":service", "promotions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Maximum number of results to return. Defaults to 20.", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Number of results to skip for pagination. Defaults to 0.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [ { "type": "any", "value": "", "key": "service", "disabled": false, "description": { "content": "(Required) Payment service name", "type": "text/plain" } } ], "raw": "{{baseUrl}}/api/v1/store/payments/:service/promotions?limit=20&offset=0" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "353c59f0-8a21-41c8-9fac-d7dee9285acc", "name": "Payment promotions", "originalRequest": { "url": { "path": [ "api", "v1", "store", "payments", ":service", "promotions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Maximum number of results to return. Defaults to 20.", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Number of results to skip for pagination. Defaults to 0.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Payment service name", "type": "text/plain" }, "type": "any", "value": "", "key": "service" } ], "raw": "{{baseUrl}}/api/v1/store/payments/:service/promotions?limit=20&offset=0" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3ac49815-dbb8-428f-8fe6-c56ee48cb127", "name": "Possible error codes:\n- `promotions_not_allowed` \u2014 Promotions not allowed", "originalRequest": { "url": { "path": [ "api", "v1", "store", "payments", ":service", "promotions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Maximum number of results to return. Defaults to 20.", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Number of results to skip for pagination. Defaults to 0.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Payment service name", "type": "text/plain" }, "type": "any", "value": "", "key": "service" } ], "raw": "{{baseUrl}}/api/v1/store/payments/:service/promotions?limit=20&offset=0" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fb25e582-a067-4670-a024-a73a594cd81b", "name": "Missing or invalid authentication token", "originalRequest": { "url": { "path": [ "api", "v1", "store", "payments", ":service", "promotions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Maximum number of results to return. Defaults to 20.", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Number of results to skip for pagination. Defaults to 0.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Payment service name", "type": "text/plain" }, "type": "any", "value": "", "key": "service" } ], "raw": "{{baseUrl}}/api/v1/store/payments/:service/promotions?limit=20&offset=0" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "redeemable", "description": "", "item": [ { "id": "b6599b23-05b8-4431-b72d-b665ba6e0398", "name": "Check redeemable promotions", "request": { "name": "Check redeemable promotions", "description": { "content": "Check which payment promotions are redeemable for a given charge amount.\n\n**Auth pipeline**: `jwt_authenticated`\n\n**Error codes**:\n- `promotions_not_allowed` \u2014 Promotions not allowed for this payment option\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "store", "payments", ":service", "promotions", "redeemable" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "service", "disabled": false, "description": { "content": "(Required) Payment service name", "type": "text/plain" } } ], "raw": "{{baseUrl}}/api/v1/store/payments/:service/promotions/redeemable" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"payment_redeemable_promotions\",\n \"attributes\": {\n \"charge_amount\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "9b00d783-31c0-4257-ab9d-cbe6353b182c", "name": "Redeemable promotions with savings", "originalRequest": { "url": { "path": [ "api", "v1", "store", "payments", ":service", "promotions", "redeemable" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Payment service name", "type": "text/plain" }, "type": "any", "value": "", "key": "service" } ], "raw": "{{baseUrl}}/api/v1/store/payments/:service/promotions/redeemable" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"payment_redeemable_promotions\",\n \"attributes\": {\n \"charge_amount\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3e6f7a2d-7a4a-4653-89cd-8aaf0ed7db5a", "name": "Possible error codes:\n- `promotions_not_allowed` \u2014 Promotions not allowed", "originalRequest": { "url": { "path": [ "api", "v1", "store", "payments", ":service", "promotions", "redeemable" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Payment service name", "type": "text/plain" }, "type": "any", "value": "", "key": "service" } ], "raw": "{{baseUrl}}/api/v1/store/payments/:service/promotions/redeemable" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"payment_redeemable_promotions\",\n \"attributes\": {\n \"charge_amount\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a0677836-56bc-46d3-b913-a12dbb63bd45", "name": "Missing or invalid authentication token", "originalRequest": { "url": { "path": [ "api", "v1", "store", "payments", ":service", "promotions", "redeemable" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Payment service name", "type": "text/plain" }, "type": "any", "value": "", "key": "service" } ], "raw": "{{baseUrl}}/api/v1/store/payments/:service/promotions/redeemable" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"payment_redeemable_promotions\",\n \"attributes\": {\n \"charge_amount\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] } ] } ] }, { "name": "products", "description": "", "item": [ { "id": "c58ad164-4d57-42d5-8543-61d879d68220", "name": "List products", "request": { "name": "List products", "description": { "content": "Retrieve a paginated list of products for the store.\nSupports filtering by category, type, brand, tags, price range, and more.\n\n**Auth pipeline**: `jwt_optional_authenticated` (no token required \u2014 works without login)\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Maximum number of results to return. Defaults to 20.", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Number of results to skip for pagination. Defaults to 0.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": false, "description": { "content": "Sort order for results. Format varies by endpoint.\nCommon values include `name_asc`, `name_desc`, `price_asc`, `price_desc`.\n", "type": "text/plain" }, "key": "order", "value": "" }, { "disabled": false, "description": { "content": "Filter by category slug or ID", "type": "text/plain" }, "key": "category", "value": "" }, { "disabled": false, "description": { "content": "Filter by subcategory", "type": "text/plain" }, "key": "subcategory", "value": "" }, { "disabled": false, "description": { "content": "Filter by product type (e.g. \"flower\", \"edible\")", "type": "text/plain" }, "key": "product_type", "value": "" }, { "disabled": false, "description": { "content": "Filter by brand slug or ID", "type": "text/plain" }, "key": "brand", "value": "" }, { "disabled": false, "description": { "content": "Filter by tag (comma-separated for multiple)", "type": "text/plain" }, "key": "tags", "value": "" }, { "disabled": false, "description": { "content": "Minimum price filter", "type": "text/plain" }, "key": "min_price", "value": "" }, { "disabled": false, "description": { "content": "Maximum price filter", "type": "text/plain" }, "key": "max_price", "value": "" }, { "disabled": false, "description": { "content": "Full-text search query", "type": "text/plain" }, "key": "search", "value": "" } ], "variable": [], "raw": "{{baseUrl}}/api/v1/products?limit=20&offset=0&order=&category=&subcategory=&product_type=&brand=&tags=&min_price=&max_price=&search=" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "2652f40a-409e-4a38-b185-112b104c23b2", "name": "Paginated product list", "originalRequest": { "url": { "path": [ "api", "v1", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Maximum number of results to return. Defaults to 20.", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Number of results to skip for pagination. Defaults to 0.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": false, "description": { "content": "Sort order for results. Format varies by endpoint.\nCommon values include `name_asc`, `name_desc`, `price_asc`, `price_desc`.\n", "type": "text/plain" }, "key": "order", "value": "" }, { "disabled": false, "description": { "content": "Filter by category slug or ID", "type": "text/plain" }, "key": "category", "value": "" }, { "disabled": false, "description": { "content": "Filter by subcategory", "type": "text/plain" }, "key": "subcategory", "value": "" }, { "disabled": false, "description": { "content": "Filter by product type (e.g. \"flower\", \"edible\")", "type": "text/plain" }, "key": "product_type", "value": "" }, { "disabled": false, "description": { "content": "Filter by brand slug or ID", "type": "text/plain" }, "key": "brand", "value": "" }, { "disabled": false, "description": { "content": "Filter by tag (comma-separated for multiple)", "type": "text/plain" }, "key": "tags", "value": "" }, { "disabled": false, "description": { "content": "Minimum price filter", "type": "text/plain" }, "key": "min_price", "value": "" }, { "disabled": false, "description": { "content": "Maximum price filter", "type": "text/plain" }, "key": "max_price", "value": "" }, { "disabled": false, "description": { "content": "Full-text search query", "type": "text/plain" }, "key": "search", "value": "" } ], "variable": [], "raw": "{{baseUrl}}/api/v1/products?limit=20&offset=0&order=&category=&subcategory=&product_type=&brand=&tags=&min_price=&max_price=&search=" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"store_products\",\n \"attributes\": {\n \"name\": \"\",\n \"slug\": \"\",\n \"sku\": \"\",\n \"description\": \"\",\n \"external_id\": \"\",\n \"type\": \"\",\n \"strain\": \"\",\n \"flower_type\": \"\",\n \"composition\": \"\",\n \"thc\": \"\",\n \"cbd\": \"\",\n \"min_cbd\": \"\",\n \"potency\": \"\",\n \"terpenoids\": [\n \"\",\n \"\"\n ],\n \"cannabis_weight\": \"\",\n \"size\": \"\",\n \"main_image\": \"\",\n \"in_stock\": \"\",\n \"is_promoted\": \"\",\n \"discount\": \"\",\n \"unit_price\": \"\",\n \"unit_prices\": [\n {\n \"display_name\": \"\",\n \"quantity\": \"\",\n \"price\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"discount_price\": \"\",\n \"savings_per_unit\": \"\"\n },\n {\n \"display_name\": \"\",\n \"quantity\": \"\",\n \"price\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"discount_price\": \"\",\n \"savings_per_unit\": \"\"\n }\n ],\n \"weight_prices\": [\n {\n \"weight\": \"\",\n \"weight_unit\": \"\",\n \"price\": \"\",\n \"original_price\": \"\",\n \"in_stock\": \"\"\n },\n {\n \"weight\": \"\",\n \"weight_unit\": \"\",\n \"price\": \"\",\n \"original_price\": \"\",\n \"in_stock\": \"\"\n }\n ]\n }\n },\n {\n \"id\": \"\",\n \"type\": \"store_products\",\n \"attributes\": {\n \"name\": \"\",\n \"slug\": \"\",\n \"sku\": \"\",\n \"description\": \"\",\n \"external_id\": \"\",\n \"type\": \"\",\n \"strain\": \"\",\n \"flower_type\": \"\",\n \"composition\": \"\",\n \"thc\": \"\",\n \"cbd\": \"\",\n \"min_cbd\": \"\",\n \"potency\": \"\",\n \"terpenoids\": [\n \"\",\n \"\"\n ],\n \"cannabis_weight\": \"\",\n \"size\": \"\",\n \"main_image\": \"\",\n \"in_stock\": \"\",\n \"is_promoted\": \"\",\n \"discount\": \"\",\n \"unit_price\": \"\",\n \"unit_prices\": [\n {\n \"display_name\": \"\",\n \"quantity\": \"\",\n \"price\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"discount_price\": \"\",\n \"savings_per_unit\": \"\"\n },\n {\n \"display_name\": \"\",\n \"quantity\": \"\",\n \"price\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"discount_price\": \"\",\n \"savings_per_unit\": \"\"\n }\n ],\n \"weight_prices\": [\n {\n \"weight\": \"\",\n \"weight_unit\": \"\",\n \"price\": \"\",\n \"original_price\": \"\",\n \"in_stock\": \"\"\n },\n {\n \"weight\": \"\",\n \"weight_unit\": \"\",\n \"price\": \"\",\n \"original_price\": \"\",\n \"in_stock\": \"\"\n }\n ]\n }\n }\n ],\n \"included\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n },\n \"key_1\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n },\n \"key_2\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n }\n }\n }\n ],\n \"meta\": {\n \"total\": \"\",\n \"limit\": \"\",\n \"offset\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{id}", "description": "", "item": [ { "id": "631fe93e-fd1c-4565-b2d1-7585e7441624", "name": "Get product detail", "request": { "name": "Get product detail", "description": { "content": "Retrieve full details for a single product by ID or slug.\n\n**Auth pipeline**: `jwt_optional_authenticated`\n\nNote: The v2 endpoint (`/api/v2/products/{id}`) returns an enriched response with\nadditional variant and inventory data. Prefer v2 for product detail pages.\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "products", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Product UUID or slug", "type": "text/plain" } } ], "raw": "{{baseUrl}}/api/v1/products/:id" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "dab01274-e3d8-4f21-a028-fea5d3a2fb36", "name": "Product details", "originalRequest": { "url": { "path": [ "api", "v1", "products", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Product UUID or slug", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ], "raw": "{{baseUrl}}/api/v1/products/:id" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"store_products\",\n \"attributes\": {\n \"name\": \"\",\n \"slug\": \"\",\n \"sku\": \"\",\n \"description\": \"\",\n \"external_id\": \"\",\n \"type\": \"\",\n \"strain\": \"\",\n \"flower_type\": \"\",\n \"composition\": \"\",\n \"thc\": \"\",\n \"cbd\": \"\",\n \"min_cbd\": \"\",\n \"potency\": \"\",\n \"terpenoids\": [\n \"\",\n \"\"\n ],\n \"cannabis_weight\": \"\",\n \"size\": \"\",\n \"main_image\": \"\",\n \"in_stock\": \"\",\n \"is_promoted\": \"\",\n \"discount\": \"\",\n \"unit_price\": \"\",\n \"unit_prices\": [\n {\n \"display_name\": \"\",\n \"quantity\": \"\",\n \"price\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"discount_price\": \"\",\n \"savings_per_unit\": \"\"\n },\n {\n \"display_name\": \"\",\n \"quantity\": \"\",\n \"price\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"discount_price\": \"\",\n \"savings_per_unit\": \"\"\n }\n ],\n \"weight_prices\": [\n {\n \"weight\": \"\",\n \"weight_unit\": \"\",\n \"price\": \"\",\n \"original_price\": \"\",\n \"in_stock\": \"\"\n },\n {\n \"weight\": \"\",\n \"weight_unit\": \"\",\n \"price\": \"\",\n \"original_price\": \"\",\n \"in_stock\": \"\"\n }\n ]\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0cb248aa-2f7a-4c68-8d3b-074281283bf1", "name": "Resource not found", "originalRequest": { "url": { "path": [ "api", "v1", "products", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Product UUID or slug", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ], "raw": "{{baseUrl}}/api/v1/products/:id" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "categories", "description": "", "item": [ { "id": "919b0677-b48f-415b-a082-2161c75ec055", "name": "List product categories", "request": { "name": "List product categories", "description": { "content": "Retrieve all available product categories for the store.\nUse these to build category navigation menus.\n\n**Auth pipeline**: `jwt_optional_authenticated`\n\nNote: The v2 endpoint (`/api/v2/products/categories`) returns a richer response.\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "products", "categories" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/products/categories" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "25fe002c-4c59-489d-855f-392b705dcd99", "name": "List of categories", "originalRequest": { "url": { "path": [ "api", "v1", "products", "categories" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/products/categories" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n },\n \"key_1\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n },\n \"key_2\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n }\n }\n },\n \"included\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n },\n \"key_1\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n },\n \"key_2\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n }\n }\n }\n ],\n \"meta\": {\n \"total\": \"\",\n \"limit\": \"\",\n \"offset\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "brands", "description": "", "item": [ { "id": "07adccb2-4299-49dd-bc72-cfab6cd51566", "name": "List product brands", "request": { "name": "List product brands", "description": { "content": "Retrieve all available product brands for the store.\n\n**Auth pipeline**: `jwt_optional_authenticated`\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "products", "brands" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/products/brands" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "f6a0a715-52ba-4c63-91d9-706c0dee162f", "name": "List of brands", "originalRequest": { "url": { "path": [ "api", "v1", "products", "brands" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/products/brands" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n },\n \"key_1\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n },\n \"key_2\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n }\n }\n },\n \"included\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n },\n \"key_1\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n },\n \"key_2\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n }\n }\n }\n ],\n \"meta\": {\n \"total\": \"\",\n \"limit\": \"\",\n \"offset\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "filters", "description": "", "item": [ { "id": "0104b6ed-2b8a-4134-8708-e8898063b521", "name": "Get available filters", "request": { "name": "Get available filters", "description": { "content": "Retrieve the available filter options for the store's product catalog.\nReturns categories, types, brands, tags, price ranges, and other filterable dimensions.\nUse this to build filter UIs dynamically.\n\n**Auth pipeline**: `jwt_optional_authenticated`\n\nNote: The v2 endpoint (`/api/v2/products/filters`) returns a richer response. Prefer v2.\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "products", "filters" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/products/filters" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "f548d052-5417-45d1-933c-23f15f57de22", "name": "Available filter options", "originalRequest": { "url": { "path": [ "api", "v1", "products", "filters" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/products/filters" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n },\n \"key_1\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n },\n \"key_2\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n }\n }\n },\n \"included\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n },\n \"key_1\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n },\n \"key_2\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n }\n }\n }\n ],\n \"meta\": {\n \"total\": \"\",\n \"limit\": \"\",\n \"offset\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "types", "description": "", "item": [ { "id": "8be8805f-6df6-4d44-96b3-e8f55272f951", "name": "List product types", "request": { "name": "List product types", "description": { "content": "Retrieve all available product types for the store (e.g. flower, edible, concentrate).\n\n**Auth pipeline**: `jwt_optional_authenticated`\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "products", "types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/products/types" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "36f3a5be-c6e9-4cde-b712-1266cda44f4a", "name": "List of product types", "originalRequest": { "url": { "path": [ "api", "v1", "products", "types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/products/types" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n },\n \"key_1\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n },\n \"key_2\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n }\n }\n },\n \"included\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n },\n \"key_1\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n },\n \"key_2\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n }\n }\n }\n ],\n \"meta\": {\n \"total\": \"\",\n \"limit\": \"\",\n \"offset\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "tags", "description": "", "item": [ { "id": "7ee4c73c-7c21-4d82-8f8d-2cc3dcd6d183", "name": "List product tags", "request": { "name": "List product tags", "description": { "content": "Retrieve all available product tags for the store.\n\n**Auth pipeline**: `jwt_optional_authenticated`\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "products", "tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/products/tags" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "626b9ae5-55d1-4093-acbc-d5ed06a0a839", "name": "List of tags", "originalRequest": { "url": { "path": [ "api", "v1", "products", "tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/products/tags" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n },\n \"key_1\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n },\n \"key_2\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n }\n }\n },\n \"included\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n },\n \"key_1\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n },\n \"key_2\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n }\n }\n }\n ],\n \"meta\": {\n \"total\": \"\",\n \"limit\": \"\",\n \"offset\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "price-ranges", "description": "", "item": [ { "id": "0b604c07-d78e-4b93-8a88-6f0c4b9fca6e", "name": "Get price ranges", "request": { "name": "Get price ranges", "description": { "content": "Retrieve the available price range buckets for the store's products.\nUseful for building price filter UIs.\n\n**Auth pipeline**: `jwt_optional_authenticated`\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "products", "price-ranges" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/products/price-ranges" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "67d3f51f-2a65-40ee-8e8c-e3315eafe92c", "name": "Price range buckets", "originalRequest": { "url": { "path": [ "api", "v1", "products", "price-ranges" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/products/price-ranges" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n },\n \"key_1\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n },\n \"key_2\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n }\n }\n },\n \"included\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n },\n \"key_1\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n },\n \"key_2\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n }\n }\n }\n ],\n \"meta\": {\n \"total\": \"\",\n \"limit\": \"\",\n \"offset\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "showcased", "description": "", "item": [ { "id": "100d4156-87ef-436b-9458-14d031542768", "name": "Get showcased product groups", "request": { "name": "Get showcased product groups", "description": { "content": "Retrieve showcased product groups (curated collections) for the store.\nEach group contains a name, type, slug, and description that can be used\nto fetch the products within that showcase.\n\n**Auth pipeline**: `jwt_optional_authenticated`\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "products", "showcased" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/products/showcased" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "2d553a76-38df-4b18-8415-655304a59c1d", "name": "List of showcased product groups", "originalRequest": { "url": { "path": [ "api", "v1", "products", "showcased" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/products/showcased" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"showcased_products\",\n \"attributes\": {\n \"name\": \"\",\n \"slug\": \"\",\n \"type\": \"\",\n \"description\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"type\": \"showcased_products\",\n \"attributes\": {\n \"name\": \"\",\n \"slug\": \"\",\n \"type\": \"\",\n \"description\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "recommended", "description": "", "item": [ { "id": "79d20a03-1077-4290-b6e6-521a1b6bc609", "name": "Get recommended products", "request": { "name": "Get recommended products", "description": { "content": "Retrieve recommended products for the store, based on popularity\nand store-configured recommendation rules.\n\n**Auth pipeline**: `jwt_optional_authenticated`\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "products", "recommended" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Maximum number of results to return. Defaults to 20.", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Number of results to skip for pagination. Defaults to 0.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [], "raw": "{{baseUrl}}/api/v1/products/recommended?limit=20&offset=0" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "954c26d2-d39c-4bc1-af4c-937313dc1552", "name": "Recommended product list", "originalRequest": { "url": { "path": [ "api", "v1", "products", "recommended" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Maximum number of results to return. Defaults to 20.", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Number of results to skip for pagination. Defaults to 0.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [], "raw": "{{baseUrl}}/api/v1/products/recommended?limit=20&offset=0" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"store_products\",\n \"attributes\": {\n \"name\": \"\",\n \"slug\": \"\",\n \"sku\": \"\",\n \"description\": \"\",\n \"external_id\": \"\",\n \"type\": \"\",\n \"strain\": \"\",\n \"flower_type\": \"\",\n \"composition\": \"\",\n \"thc\": \"\",\n \"cbd\": \"\",\n \"min_cbd\": \"\",\n \"potency\": \"\",\n \"terpenoids\": [\n \"\",\n \"\"\n ],\n \"cannabis_weight\": \"\",\n \"size\": \"\",\n \"main_image\": \"\",\n \"in_stock\": \"\",\n \"is_promoted\": \"\",\n \"discount\": \"\",\n \"unit_price\": \"\",\n \"unit_prices\": [\n {\n \"display_name\": \"\",\n \"quantity\": \"\",\n \"price\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"discount_price\": \"\",\n \"savings_per_unit\": \"\"\n },\n {\n \"display_name\": \"\",\n \"quantity\": \"\",\n \"price\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"discount_price\": \"\",\n \"savings_per_unit\": \"\"\n }\n ],\n \"weight_prices\": [\n {\n \"weight\": \"\",\n \"weight_unit\": \"\",\n \"price\": \"\",\n \"original_price\": \"\",\n \"in_stock\": \"\"\n },\n {\n \"weight\": \"\",\n \"weight_unit\": \"\",\n \"price\": \"\",\n \"original_price\": \"\",\n \"in_stock\": \"\"\n }\n ]\n }\n },\n {\n \"id\": \"\",\n \"type\": \"store_products\",\n \"attributes\": {\n \"name\": \"\",\n \"slug\": \"\",\n \"sku\": \"\",\n \"description\": \"\",\n \"external_id\": \"\",\n \"type\": \"\",\n \"strain\": \"\",\n \"flower_type\": \"\",\n \"composition\": \"\",\n \"thc\": \"\",\n \"cbd\": \"\",\n \"min_cbd\": \"\",\n \"potency\": \"\",\n \"terpenoids\": [\n \"\",\n \"\"\n ],\n \"cannabis_weight\": \"\",\n \"size\": \"\",\n \"main_image\": \"\",\n \"in_stock\": \"\",\n \"is_promoted\": \"\",\n \"discount\": \"\",\n \"unit_price\": \"\",\n \"unit_prices\": [\n {\n \"display_name\": \"\",\n \"quantity\": \"\",\n \"price\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"discount_price\": \"\",\n \"savings_per_unit\": \"\"\n },\n {\n \"display_name\": \"\",\n \"quantity\": \"\",\n \"price\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"discount_price\": \"\",\n \"savings_per_unit\": \"\"\n }\n ],\n \"weight_prices\": [\n {\n \"weight\": \"\",\n \"weight_unit\": \"\",\n \"price\": \"\",\n \"original_price\": \"\",\n \"in_stock\": \"\"\n },\n {\n \"weight\": \"\",\n \"weight_unit\": \"\",\n \"price\": \"\",\n \"original_price\": \"\",\n \"in_stock\": \"\"\n }\n ]\n }\n }\n ],\n \"included\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n },\n \"key_1\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n },\n \"key_2\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n }\n }\n }\n ],\n \"meta\": {\n \"total\": \"\",\n \"limit\": \"\",\n \"offset\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "sponsored", "description": "", "item": [ { "id": "d5e92544-8f34-4cd5-b9be-5fa751418ce1", "name": "Get sponsored product listing", "request": { "name": "Get sponsored product listing", "description": { "content": "Retrieve a product listing that includes sponsored/promoted products\nmixed with organic results. Accepts the same query parameters as\n`GET /api/v1/products` for filtering, plus client data in the request body\nfor ad targeting.\n\n**Auth pipeline**: `jwt_optional_authenticated`\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "products", "sponsored" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Maximum number of results to return. Defaults to 20.", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Number of results to skip for pagination. Defaults to 0.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": false, "description": { "content": "Sort order for results. Format varies by endpoint.\nCommon values include `name_asc`, `name_desc`, `price_asc`, `price_desc`.\n", "type": "text/plain" }, "key": "order", "value": "" }, { "disabled": false, "description": { "content": "Filter by category slug or ID", "type": "text/plain" }, "key": "category", "value": "" }, { "disabled": false, "description": { "content": "Filter by brand slug or ID", "type": "text/plain" }, "key": "brand", "value": "" }, { "disabled": false, "description": { "content": "Filter by product type", "type": "text/plain" }, "key": "type", "value": "" }, { "disabled": false, "description": { "content": "Filter by tag", "type": "text/plain" }, "key": "tag", "value": "" }, { "disabled": false, "description": { "content": "Full-text search query", "type": "text/plain" }, "key": "q", "value": "" } ], "variable": [], "raw": "{{baseUrl}}/api/v1/products/sponsored?limit=20&offset=0&order=&category=&brand=&type=&tag=&q=" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"recommendations\",\n \"attributes\": {\n \"url\": \"\",\n \"screen\": {\n \"height\": \"\",\n \"width\": \"\"\n },\n \"navigator\": {\n \"user_agent\": \"\",\n \"language\": \"\"\n },\n \"mobile\": \"\",\n \"account_id\": \"\",\n \"site_id\": \"\",\n \"channel_id\": \"\",\n \"channel_type\": \"\",\n \"zone_id\": \"\",\n \"client_ip\": \"\",\n \"surfside_domain_id\": \"\",\n \"session_id\": \"\",\n \"store_location_data\": {},\n \"location_data\": {\n \"zip\": \"\",\n \"country\": \"\",\n \"city\": \"\",\n \"region\": \"\",\n \"utc_offset\": \"\",\n \"timezone\": \"\",\n \"coords\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"accuracy\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "713ad5d4-7a04-45b7-a32c-8561f54da97f", "name": "Sponsored + organic product list", "originalRequest": { "url": { "path": [ "api", "v1", "products", "sponsored" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Maximum number of results to return. Defaults to 20.", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Number of results to skip for pagination. Defaults to 0.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": false, "description": { "content": "Sort order for results. Format varies by endpoint.\nCommon values include `name_asc`, `name_desc`, `price_asc`, `price_desc`.\n", "type": "text/plain" }, "key": "order", "value": "" }, { "disabled": false, "description": { "content": "Filter by category slug or ID", "type": "text/plain" }, "key": "category", "value": "" }, { "disabled": false, "description": { "content": "Filter by brand slug or ID", "type": "text/plain" }, "key": "brand", "value": "" }, { "disabled": false, "description": { "content": "Filter by product type", "type": "text/plain" }, "key": "type", "value": "" }, { "disabled": false, "description": { "content": "Filter by tag", "type": "text/plain" }, "key": "tag", "value": "" }, { "disabled": false, "description": { "content": "Full-text search query", "type": "text/plain" }, "key": "q", "value": "" } ], "variable": [], "raw": "{{baseUrl}}/api/v1/products/sponsored?limit=20&offset=0&order=&category=&brand=&type=&tag=&q=" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"recommendations\",\n \"attributes\": {\n \"url\": \"\",\n \"screen\": {\n \"height\": \"\",\n \"width\": \"\"\n },\n \"navigator\": {\n \"user_agent\": \"\",\n \"language\": \"\"\n },\n \"mobile\": \"\",\n \"account_id\": \"\",\n \"site_id\": \"\",\n \"channel_id\": \"\",\n \"channel_type\": \"\",\n \"zone_id\": \"\",\n \"client_ip\": \"\",\n \"surfside_domain_id\": \"\",\n \"session_id\": \"\",\n \"store_location_data\": {},\n \"location_data\": {\n \"zip\": \"\",\n \"country\": \"\",\n \"city\": \"\",\n \"region\": \"\",\n \"utc_offset\": \"\",\n \"timezone\": \"\",\n \"coords\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"accuracy\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"store_products\",\n \"attributes\": {\n \"name\": \"\",\n \"slug\": \"\",\n \"sku\": \"\",\n \"description\": \"\",\n \"external_id\": \"\",\n \"type\": \"\",\n \"strain\": \"\",\n \"flower_type\": \"\",\n \"composition\": \"\",\n \"thc\": \"\",\n \"cbd\": \"\",\n \"min_cbd\": \"\",\n \"potency\": \"\",\n \"terpenoids\": [\n \"\",\n \"\"\n ],\n \"cannabis_weight\": \"\",\n \"size\": \"\",\n \"main_image\": \"\",\n \"in_stock\": \"\",\n \"is_promoted\": \"\",\n \"discount\": \"\",\n \"unit_price\": \"\",\n \"unit_prices\": [\n {\n \"display_name\": \"\",\n \"quantity\": \"\",\n \"price\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"discount_price\": \"\",\n \"savings_per_unit\": \"\"\n },\n {\n \"display_name\": \"\",\n \"quantity\": \"\",\n \"price\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"discount_price\": \"\",\n \"savings_per_unit\": \"\"\n }\n ],\n \"weight_prices\": [\n {\n \"weight\": \"\",\n \"weight_unit\": \"\",\n \"price\": \"\",\n \"original_price\": \"\",\n \"in_stock\": \"\"\n },\n {\n \"weight\": \"\",\n \"weight_unit\": \"\",\n \"price\": \"\",\n \"original_price\": \"\",\n \"in_stock\": \"\"\n }\n ]\n }\n },\n {\n \"id\": \"\",\n \"type\": \"store_products\",\n \"attributes\": {\n \"name\": \"\",\n \"slug\": \"\",\n \"sku\": \"\",\n \"description\": \"\",\n \"external_id\": \"\",\n \"type\": \"\",\n \"strain\": \"\",\n \"flower_type\": \"\",\n \"composition\": \"\",\n \"thc\": \"\",\n \"cbd\": \"\",\n \"min_cbd\": \"\",\n \"potency\": \"\",\n \"terpenoids\": [\n \"\",\n \"\"\n ],\n \"cannabis_weight\": \"\",\n \"size\": \"\",\n \"main_image\": \"\",\n \"in_stock\": \"\",\n \"is_promoted\": \"\",\n \"discount\": \"\",\n \"unit_price\": \"\",\n \"unit_prices\": [\n {\n \"display_name\": \"\",\n \"quantity\": \"\",\n \"price\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"discount_price\": \"\",\n \"savings_per_unit\": \"\"\n },\n {\n \"display_name\": \"\",\n \"quantity\": \"\",\n \"price\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"discount_price\": \"\",\n \"savings_per_unit\": \"\"\n }\n ],\n \"weight_prices\": [\n {\n \"weight\": \"\",\n \"weight_unit\": \"\",\n \"price\": \"\",\n \"original_price\": \"\",\n \"in_stock\": \"\"\n },\n {\n \"weight\": \"\",\n \"weight_unit\": \"\",\n \"price\": \"\",\n \"original_price\": \"\",\n \"in_stock\": \"\"\n }\n ]\n }\n }\n ],\n \"included\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n },\n \"key_1\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n },\n \"key_2\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n }\n }\n }\n ],\n \"meta\": {\n \"total\": \"\",\n \"limit\": \"\",\n \"offset\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "474dc31c-f4dc-4ea1-8295-0f7355280a73", "name": "Invalid request parameters", "originalRequest": { "url": { "path": [ "api", "v1", "products", "sponsored" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Maximum number of results to return. Defaults to 20.", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Number of results to skip for pagination. Defaults to 0.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": false, "description": { "content": "Sort order for results. Format varies by endpoint.\nCommon values include `name_asc`, `name_desc`, `price_asc`, `price_desc`.\n", "type": "text/plain" }, "key": "order", "value": "" }, { "disabled": false, "description": { "content": "Filter by category slug or ID", "type": "text/plain" }, "key": "category", "value": "" }, { "disabled": false, "description": { "content": "Filter by brand slug or ID", "type": "text/plain" }, "key": "brand", "value": "" }, { "disabled": false, "description": { "content": "Filter by product type", "type": "text/plain" }, "key": "type", "value": "" }, { "disabled": false, "description": { "content": "Filter by tag", "type": "text/plain" }, "key": "tag", "value": "" }, { "disabled": false, "description": { "content": "Full-text search query", "type": "text/plain" }, "key": "q", "value": "" } ], "variable": [], "raw": "{{baseUrl}}/api/v1/products/sponsored?limit=20&offset=0&order=&category=&brand=&type=&tag=&q=" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"recommendations\",\n \"attributes\": {\n \"url\": \"\",\n \"screen\": {\n \"height\": \"\",\n \"width\": \"\"\n },\n \"navigator\": {\n \"user_agent\": \"\",\n \"language\": \"\"\n },\n \"mobile\": \"\",\n \"account_id\": \"\",\n \"site_id\": \"\",\n \"channel_id\": \"\",\n \"channel_type\": \"\",\n \"zone_id\": \"\",\n \"client_ip\": \"\",\n \"surfside_domain_id\": \"\",\n \"session_id\": \"\",\n \"store_location_data\": {},\n \"location_data\": {\n \"zip\": \"\",\n \"country\": \"\",\n \"city\": \"\",\n \"region\": \"\",\n \"utc_offset\": \"\",\n \"timezone\": \"\",\n \"coords\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"accuracy\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "recommendations", "description": "", "item": [ { "name": "sponsored-user-top-picks", "description": "", "item": [ { "id": "81891fe6-7e1b-4e22-a54a-4f6582a21bf4", "name": "Get sponsored user top picks", "request": { "name": "Get sponsored user top picks", "description": { "content": "Retrieve personalized top-pick recommendations that include sponsored products.\nFalls back to organic recommendations if no ad data is available.\n\n**Auth pipeline**: `jwt_optional_authenticated`\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "products", "recommendations", "sponsored-user-top-picks" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Maximum number of results to return. Defaults to 20.", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Number of results to skip for pagination. Defaults to 0.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [], "raw": "{{baseUrl}}/api/v1/products/recommendations/sponsored-user-top-picks?limit=20&offset=0" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"recommendations\",\n \"attributes\": {\n \"url\": \"\",\n \"screen\": {\n \"height\": \"\",\n \"width\": \"\"\n },\n \"navigator\": {\n \"user_agent\": \"\",\n \"language\": \"\"\n },\n \"mobile\": \"\",\n \"account_id\": \"\",\n \"site_id\": \"\",\n \"channel_id\": \"\",\n \"channel_type\": \"\",\n \"zone_id\": \"\",\n \"client_ip\": \"\",\n \"surfside_domain_id\": \"\",\n \"session_id\": \"\",\n \"store_location_data\": {},\n \"location_data\": {\n \"zip\": \"\",\n \"country\": \"\",\n \"city\": \"\",\n \"region\": \"\",\n \"utc_offset\": \"\",\n \"timezone\": \"\",\n \"coords\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"accuracy\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "07941ed0-839b-49f2-89dd-d03c1c93ad5b", "name": "Sponsored user top picks", "originalRequest": { "url": { "path": [ "api", "v1", "products", "recommendations", "sponsored-user-top-picks" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Maximum number of results to return. Defaults to 20.", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Number of results to skip for pagination. Defaults to 0.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [], "raw": "{{baseUrl}}/api/v1/products/recommendations/sponsored-user-top-picks?limit=20&offset=0" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"recommendations\",\n \"attributes\": {\n \"url\": \"\",\n \"screen\": {\n \"height\": \"\",\n \"width\": \"\"\n },\n \"navigator\": {\n \"user_agent\": \"\",\n \"language\": \"\"\n },\n \"mobile\": \"\",\n \"account_id\": \"\",\n \"site_id\": \"\",\n \"channel_id\": \"\",\n \"channel_type\": \"\",\n \"zone_id\": \"\",\n \"client_ip\": \"\",\n \"surfside_domain_id\": \"\",\n \"session_id\": \"\",\n \"store_location_data\": {},\n \"location_data\": {\n \"zip\": \"\",\n \"country\": \"\",\n \"city\": \"\",\n \"region\": \"\",\n \"utc_offset\": \"\",\n \"timezone\": \"\",\n \"coords\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"accuracy\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"store_products\",\n \"attributes\": {\n \"name\": \"\",\n \"slug\": \"\",\n \"sku\": \"\",\n \"description\": \"\",\n \"external_id\": \"\",\n \"type\": \"\",\n \"strain\": \"\",\n \"flower_type\": \"\",\n \"composition\": \"\",\n \"thc\": \"\",\n \"cbd\": \"\",\n \"min_cbd\": \"\",\n \"potency\": \"\",\n \"terpenoids\": [\n \"\",\n \"\"\n ],\n \"cannabis_weight\": \"\",\n \"size\": \"\",\n \"main_image\": \"\",\n \"in_stock\": \"\",\n \"is_promoted\": \"\",\n \"discount\": \"\",\n \"unit_price\": \"\",\n \"unit_prices\": [\n {\n \"display_name\": \"\",\n \"quantity\": \"\",\n \"price\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"discount_price\": \"\",\n \"savings_per_unit\": \"\"\n },\n {\n \"display_name\": \"\",\n \"quantity\": \"\",\n \"price\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"discount_price\": \"\",\n \"savings_per_unit\": \"\"\n }\n ],\n \"weight_prices\": [\n {\n \"weight\": \"\",\n \"weight_unit\": \"\",\n \"price\": \"\",\n \"original_price\": \"\",\n \"in_stock\": \"\"\n },\n {\n \"weight\": \"\",\n \"weight_unit\": \"\",\n \"price\": \"\",\n \"original_price\": \"\",\n \"in_stock\": \"\"\n }\n ]\n }\n },\n {\n \"id\": \"\",\n \"type\": \"store_products\",\n \"attributes\": {\n \"name\": \"\",\n \"slug\": \"\",\n \"sku\": \"\",\n \"description\": \"\",\n \"external_id\": \"\",\n \"type\": \"\",\n \"strain\": \"\",\n \"flower_type\": \"\",\n \"composition\": \"\",\n \"thc\": \"\",\n \"cbd\": \"\",\n \"min_cbd\": \"\",\n \"potency\": \"\",\n \"terpenoids\": [\n \"\",\n \"\"\n ],\n \"cannabis_weight\": \"\",\n \"size\": \"\",\n \"main_image\": \"\",\n \"in_stock\": \"\",\n \"is_promoted\": \"\",\n \"discount\": \"\",\n \"unit_price\": \"\",\n \"unit_prices\": [\n {\n \"display_name\": \"\",\n \"quantity\": \"\",\n \"price\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"discount_price\": \"\",\n \"savings_per_unit\": \"\"\n },\n {\n \"display_name\": \"\",\n \"quantity\": \"\",\n \"price\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"discount_price\": \"\",\n \"savings_per_unit\": \"\"\n }\n ],\n \"weight_prices\": [\n {\n \"weight\": \"\",\n \"weight_unit\": \"\",\n \"price\": \"\",\n \"original_price\": \"\",\n \"in_stock\": \"\"\n },\n {\n \"weight\": \"\",\n \"weight_unit\": \"\",\n \"price\": \"\",\n \"original_price\": \"\",\n \"in_stock\": \"\"\n }\n ]\n }\n }\n ],\n \"included\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n },\n \"key_1\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n },\n \"key_2\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n }\n }\n }\n ],\n \"meta\": {\n \"total\": \"\",\n \"limit\": \"\",\n \"offset\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "96f87e90-beed-4eb1-a10b-9214eb1c07fe", "name": "Invalid request parameters", "originalRequest": { "url": { "path": [ "api", "v1", "products", "recommendations", "sponsored-user-top-picks" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Maximum number of results to return. Defaults to 20.", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Number of results to skip for pagination. Defaults to 0.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [], "raw": "{{baseUrl}}/api/v1/products/recommendations/sponsored-user-top-picks?limit=20&offset=0" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"recommendations\",\n \"attributes\": {\n \"url\": \"\",\n \"screen\": {\n \"height\": \"\",\n \"width\": \"\"\n },\n \"navigator\": {\n \"user_agent\": \"\",\n \"language\": \"\"\n },\n \"mobile\": \"\",\n \"account_id\": \"\",\n \"site_id\": \"\",\n \"channel_id\": \"\",\n \"channel_type\": \"\",\n \"zone_id\": \"\",\n \"client_ip\": \"\",\n \"surfside_domain_id\": \"\",\n \"session_id\": \"\",\n \"store_location_data\": {},\n \"location_data\": {\n \"zip\": \"\",\n \"country\": \"\",\n \"city\": \"\",\n \"region\": \"\",\n \"utc_offset\": \"\",\n \"timezone\": \"\",\n \"coords\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"accuracy\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "sponsored-cart-toppers", "description": "", "item": [ { "id": "ee90b384-7807-4521-aa5b-033f9455d075", "name": "Get sponsored cart toppers", "request": { "name": "Get sponsored cart toppers", "description": { "content": "Retrieve cart-topper recommendations that include sponsored products.\nShown on the cart page to encourage additional purchases.\n\n**Auth pipeline**: `jwt_optional_authenticated`\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "products", "recommendations", "sponsored-cart-toppers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Maximum number of results to return. Defaults to 20.", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Number of results to skip for pagination. Defaults to 0.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [], "raw": "{{baseUrl}}/api/v1/products/recommendations/sponsored-cart-toppers?limit=20&offset=0" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"recommendations\",\n \"attributes\": {\n \"url\": \"\",\n \"screen\": {\n \"height\": \"\",\n \"width\": \"\"\n },\n \"navigator\": {\n \"user_agent\": \"\",\n \"language\": \"\"\n },\n \"mobile\": \"\",\n \"account_id\": \"\",\n \"site_id\": \"\",\n \"channel_id\": \"\",\n \"channel_type\": \"\",\n \"zone_id\": \"\",\n \"client_ip\": \"\",\n \"surfside_domain_id\": \"\",\n \"session_id\": \"\",\n \"store_location_data\": {},\n \"location_data\": {\n \"zip\": \"\",\n \"country\": \"\",\n \"city\": \"\",\n \"region\": \"\",\n \"utc_offset\": \"\",\n \"timezone\": \"\",\n \"coords\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"accuracy\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "07ef9b98-510d-4f6f-ac50-5001a3df40e6", "name": "Sponsored cart toppers", "originalRequest": { "url": { "path": [ "api", "v1", "products", "recommendations", "sponsored-cart-toppers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Maximum number of results to return. Defaults to 20.", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Number of results to skip for pagination. Defaults to 0.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [], "raw": "{{baseUrl}}/api/v1/products/recommendations/sponsored-cart-toppers?limit=20&offset=0" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"recommendations\",\n \"attributes\": {\n \"url\": \"\",\n \"screen\": {\n \"height\": \"\",\n \"width\": \"\"\n },\n \"navigator\": {\n \"user_agent\": \"\",\n \"language\": \"\"\n },\n \"mobile\": \"\",\n \"account_id\": \"\",\n \"site_id\": \"\",\n \"channel_id\": \"\",\n \"channel_type\": \"\",\n \"zone_id\": \"\",\n \"client_ip\": \"\",\n \"surfside_domain_id\": \"\",\n \"session_id\": \"\",\n \"store_location_data\": {},\n \"location_data\": {\n \"zip\": \"\",\n \"country\": \"\",\n \"city\": \"\",\n \"region\": \"\",\n \"utc_offset\": \"\",\n \"timezone\": \"\",\n \"coords\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"accuracy\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"store_products\",\n \"attributes\": {\n \"name\": \"\",\n \"slug\": \"\",\n \"sku\": \"\",\n \"description\": \"\",\n \"external_id\": \"\",\n \"type\": \"\",\n \"strain\": \"\",\n \"flower_type\": \"\",\n \"composition\": \"\",\n \"thc\": \"\",\n \"cbd\": \"\",\n \"min_cbd\": \"\",\n \"potency\": \"\",\n \"terpenoids\": [\n \"\",\n \"\"\n ],\n \"cannabis_weight\": \"\",\n \"size\": \"\",\n \"main_image\": \"\",\n \"in_stock\": \"\",\n \"is_promoted\": \"\",\n \"discount\": \"\",\n \"unit_price\": \"\",\n \"unit_prices\": [\n {\n \"display_name\": \"\",\n \"quantity\": \"\",\n \"price\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"discount_price\": \"\",\n \"savings_per_unit\": \"\"\n },\n {\n \"display_name\": \"\",\n \"quantity\": \"\",\n \"price\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"discount_price\": \"\",\n \"savings_per_unit\": \"\"\n }\n ],\n \"weight_prices\": [\n {\n \"weight\": \"\",\n \"weight_unit\": \"\",\n \"price\": \"\",\n \"original_price\": \"\",\n \"in_stock\": \"\"\n },\n {\n \"weight\": \"\",\n \"weight_unit\": \"\",\n \"price\": \"\",\n \"original_price\": \"\",\n \"in_stock\": \"\"\n }\n ]\n }\n },\n {\n \"id\": \"\",\n \"type\": \"store_products\",\n \"attributes\": {\n \"name\": \"\",\n \"slug\": \"\",\n \"sku\": \"\",\n \"description\": \"\",\n \"external_id\": \"\",\n \"type\": \"\",\n \"strain\": \"\",\n \"flower_type\": \"\",\n \"composition\": \"\",\n \"thc\": \"\",\n \"cbd\": \"\",\n \"min_cbd\": \"\",\n \"potency\": \"\",\n \"terpenoids\": [\n \"\",\n \"\"\n ],\n \"cannabis_weight\": \"\",\n \"size\": \"\",\n \"main_image\": \"\",\n \"in_stock\": \"\",\n \"is_promoted\": \"\",\n \"discount\": \"\",\n \"unit_price\": \"\",\n \"unit_prices\": [\n {\n \"display_name\": \"\",\n \"quantity\": \"\",\n \"price\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"discount_price\": \"\",\n \"savings_per_unit\": \"\"\n },\n {\n \"display_name\": \"\",\n \"quantity\": \"\",\n \"price\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"discount_price\": \"\",\n \"savings_per_unit\": \"\"\n }\n ],\n \"weight_prices\": [\n {\n \"weight\": \"\",\n \"weight_unit\": \"\",\n \"price\": \"\",\n \"original_price\": \"\",\n \"in_stock\": \"\"\n },\n {\n \"weight\": \"\",\n \"weight_unit\": \"\",\n \"price\": \"\",\n \"original_price\": \"\",\n \"in_stock\": \"\"\n }\n ]\n }\n }\n ],\n \"included\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n },\n \"key_1\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n },\n \"key_2\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n }\n }\n }\n ],\n \"meta\": {\n \"total\": \"\",\n \"limit\": \"\",\n \"offset\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b8a3507-6ecf-4cc2-932c-de11487d3a11", "name": "Invalid request parameters", "originalRequest": { "url": { "path": [ "api", "v1", "products", "recommendations", "sponsored-cart-toppers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Maximum number of results to return. Defaults to 20.", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Number of results to skip for pagination. Defaults to 0.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [], "raw": "{{baseUrl}}/api/v1/products/recommendations/sponsored-cart-toppers?limit=20&offset=0" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"recommendations\",\n \"attributes\": {\n \"url\": \"\",\n \"screen\": {\n \"height\": \"\",\n \"width\": \"\"\n },\n \"navigator\": {\n \"user_agent\": \"\",\n \"language\": \"\"\n },\n \"mobile\": \"\",\n \"account_id\": \"\",\n \"site_id\": \"\",\n \"channel_id\": \"\",\n \"channel_type\": \"\",\n \"zone_id\": \"\",\n \"client_ip\": \"\",\n \"surfside_domain_id\": \"\",\n \"session_id\": \"\",\n \"store_location_data\": {},\n \"location_data\": {\n \"zip\": \"\",\n \"country\": \"\",\n \"city\": \"\",\n \"region\": \"\",\n \"utc_offset\": \"\",\n \"timezone\": \"\",\n \"coords\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"accuracy\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "frequently-bought-together", "description": "", "item": [ { "name": "{product_id}", "description": "", "item": [ { "id": "9e3f71d9-8f93-4b1e-957c-f4dddbef3c17", "name": "Get frequently bought together products", "request": { "name": "Get frequently bought together products", "description": { "content": "Retrieve products frequently bought together with the given product.\nIncludes sponsored products when ad data is provided.\n\n**Auth pipeline**: `jwt_optional_authenticated`\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "products", "recommendations", "frequently-bought-together", ":product_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Maximum number of results to return. Defaults to 20.", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Number of results to skip for pagination. Defaults to 0.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [ { "type": "any", "value": "", "key": "product_id", "disabled": false, "description": { "content": "(Required) Product UUID to find frequently bought together items for", "type": "text/plain" } } ], "raw": "{{baseUrl}}/api/v1/products/recommendations/frequently-bought-together/:product_id?limit=20&offset=0" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"recommendations\",\n \"attributes\": {\n \"url\": \"\",\n \"screen\": {\n \"height\": \"\",\n \"width\": \"\"\n },\n \"navigator\": {\n \"user_agent\": \"\",\n \"language\": \"\"\n },\n \"mobile\": \"\",\n \"account_id\": \"\",\n \"site_id\": \"\",\n \"channel_id\": \"\",\n \"channel_type\": \"\",\n \"zone_id\": \"\",\n \"client_ip\": \"\",\n \"surfside_domain_id\": \"\",\n \"session_id\": \"\",\n \"store_location_data\": {},\n \"location_data\": {\n \"zip\": \"\",\n \"country\": \"\",\n \"city\": \"\",\n \"region\": \"\",\n \"utc_offset\": \"\",\n \"timezone\": \"\",\n \"coords\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"accuracy\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "4e5f2021-a272-44fe-8541-bf5a395a681f", "name": "Frequently bought together products", "originalRequest": { "url": { "path": [ "api", "v1", "products", "recommendations", "frequently-bought-together", ":product_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Maximum number of results to return. Defaults to 20.", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Number of results to skip for pagination. Defaults to 0.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Product UUID to find frequently bought together items for", "type": "text/plain" }, "type": "any", "value": "", "key": "product_id" } ], "raw": "{{baseUrl}}/api/v1/products/recommendations/frequently-bought-together/:product_id?limit=20&offset=0" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"recommendations\",\n \"attributes\": {\n \"url\": \"\",\n \"screen\": {\n \"height\": \"\",\n \"width\": \"\"\n },\n \"navigator\": {\n \"user_agent\": \"\",\n \"language\": \"\"\n },\n \"mobile\": \"\",\n \"account_id\": \"\",\n \"site_id\": \"\",\n \"channel_id\": \"\",\n \"channel_type\": \"\",\n \"zone_id\": \"\",\n \"client_ip\": \"\",\n \"surfside_domain_id\": \"\",\n \"session_id\": \"\",\n \"store_location_data\": {},\n \"location_data\": {\n \"zip\": \"\",\n \"country\": \"\",\n \"city\": \"\",\n \"region\": \"\",\n \"utc_offset\": \"\",\n \"timezone\": \"\",\n \"coords\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"accuracy\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"store_products\",\n \"attributes\": {\n \"name\": \"\",\n \"slug\": \"\",\n \"sku\": \"\",\n \"description\": \"\",\n \"external_id\": \"\",\n \"type\": \"\",\n \"strain\": \"\",\n \"flower_type\": \"\",\n \"composition\": \"\",\n \"thc\": \"\",\n \"cbd\": \"\",\n \"min_cbd\": \"\",\n \"potency\": \"\",\n \"terpenoids\": [\n \"\",\n \"\"\n ],\n \"cannabis_weight\": \"\",\n \"size\": \"\",\n \"main_image\": \"\",\n \"in_stock\": \"\",\n \"is_promoted\": \"\",\n \"discount\": \"\",\n \"unit_price\": \"\",\n \"unit_prices\": [\n {\n \"display_name\": \"\",\n \"quantity\": \"\",\n \"price\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"discount_price\": \"\",\n \"savings_per_unit\": \"\"\n },\n {\n \"display_name\": \"\",\n \"quantity\": \"\",\n \"price\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"discount_price\": \"\",\n \"savings_per_unit\": \"\"\n }\n ],\n \"weight_prices\": [\n {\n \"weight\": \"\",\n \"weight_unit\": \"\",\n \"price\": \"\",\n \"original_price\": \"\",\n \"in_stock\": \"\"\n },\n {\n \"weight\": \"\",\n \"weight_unit\": \"\",\n \"price\": \"\",\n \"original_price\": \"\",\n \"in_stock\": \"\"\n }\n ]\n }\n },\n {\n \"id\": \"\",\n \"type\": \"store_products\",\n \"attributes\": {\n \"name\": \"\",\n \"slug\": \"\",\n \"sku\": \"\",\n \"description\": \"\",\n \"external_id\": \"\",\n \"type\": \"\",\n \"strain\": \"\",\n \"flower_type\": \"\",\n \"composition\": \"\",\n \"thc\": \"\",\n \"cbd\": \"\",\n \"min_cbd\": \"\",\n \"potency\": \"\",\n \"terpenoids\": [\n \"\",\n \"\"\n ],\n \"cannabis_weight\": \"\",\n \"size\": \"\",\n \"main_image\": \"\",\n \"in_stock\": \"\",\n \"is_promoted\": \"\",\n \"discount\": \"\",\n \"unit_price\": \"\",\n \"unit_prices\": [\n {\n \"display_name\": \"\",\n \"quantity\": \"\",\n \"price\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"discount_price\": \"\",\n \"savings_per_unit\": \"\"\n },\n {\n \"display_name\": \"\",\n \"quantity\": \"\",\n \"price\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"discount_price\": \"\",\n \"savings_per_unit\": \"\"\n }\n ],\n \"weight_prices\": [\n {\n \"weight\": \"\",\n \"weight_unit\": \"\",\n \"price\": \"\",\n \"original_price\": \"\",\n \"in_stock\": \"\"\n },\n {\n \"weight\": \"\",\n \"weight_unit\": \"\",\n \"price\": \"\",\n \"original_price\": \"\",\n \"in_stock\": \"\"\n }\n ]\n }\n }\n ],\n \"included\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n },\n \"key_1\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n },\n \"key_2\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n }\n }\n }\n ],\n \"meta\": {\n \"total\": \"\",\n \"limit\": \"\",\n \"offset\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "00e84bbd-3580-4121-854d-5b8b7f966854", "name": "Invalid request parameters", "originalRequest": { "url": { "path": [ "api", "v1", "products", "recommendations", "frequently-bought-together", ":product_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Maximum number of results to return. Defaults to 20.", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Number of results to skip for pagination. Defaults to 0.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Product UUID to find frequently bought together items for", "type": "text/plain" }, "type": "any", "value": "", "key": "product_id" } ], "raw": "{{baseUrl}}/api/v1/products/recommendations/frequently-bought-together/:product_id?limit=20&offset=0" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"recommendations\",\n \"attributes\": {\n \"url\": \"\",\n \"screen\": {\n \"height\": \"\",\n \"width\": \"\"\n },\n \"navigator\": {\n \"user_agent\": \"\",\n \"language\": \"\"\n },\n \"mobile\": \"\",\n \"account_id\": \"\",\n \"site_id\": \"\",\n \"channel_id\": \"\",\n \"channel_type\": \"\",\n \"zone_id\": \"\",\n \"client_ip\": \"\",\n \"surfside_domain_id\": \"\",\n \"session_id\": \"\",\n \"store_location_data\": {},\n \"location_data\": {\n \"zip\": \"\",\n \"country\": \"\",\n \"city\": \"\",\n \"region\": \"\",\n \"utc_offset\": \"\",\n \"timezone\": \"\",\n \"coords\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"accuracy\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "user-top-picks", "description": "", "item": [ { "id": "9f635927-870c-4069-ac01-3fc6457b80d2", "name": "Get user top picks", "request": { "name": "Get user top picks", "description": { "content": "Retrieve personalized product recommendations based on the user's\nbrowsing and purchase history. Works for both authenticated and\nanonymous users.\n\n**Auth pipeline**: `jwt_optional_authenticated`\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "products", "recommendations", "user-top-picks" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Maximum number of results to return. Defaults to 20.", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Number of results to skip for pagination. Defaults to 0.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [], "raw": "{{baseUrl}}/api/v1/products/recommendations/user-top-picks?limit=20&offset=0" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "039c2da9-3310-4dfb-8fd8-e53c5e050a93", "name": "User top pick recommendations", "originalRequest": { "url": { "path": [ "api", "v1", "products", "recommendations", "user-top-picks" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Maximum number of results to return. Defaults to 20.", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Number of results to skip for pagination. Defaults to 0.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [], "raw": "{{baseUrl}}/api/v1/products/recommendations/user-top-picks?limit=20&offset=0" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"store_products\",\n \"attributes\": {\n \"name\": \"\",\n \"slug\": \"\",\n \"sku\": \"\",\n \"description\": \"\",\n \"external_id\": \"\",\n \"type\": \"\",\n \"strain\": \"\",\n \"flower_type\": \"\",\n \"composition\": \"\",\n \"thc\": \"\",\n \"cbd\": \"\",\n \"min_cbd\": \"\",\n \"potency\": \"\",\n \"terpenoids\": [\n \"\",\n \"\"\n ],\n \"cannabis_weight\": \"\",\n \"size\": \"\",\n \"main_image\": \"\",\n \"in_stock\": \"\",\n \"is_promoted\": \"\",\n \"discount\": \"\",\n \"unit_price\": \"\",\n \"unit_prices\": [\n {\n \"display_name\": \"\",\n \"quantity\": \"\",\n \"price\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"discount_price\": \"\",\n \"savings_per_unit\": \"\"\n },\n {\n \"display_name\": \"\",\n \"quantity\": \"\",\n \"price\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"discount_price\": \"\",\n \"savings_per_unit\": \"\"\n }\n ],\n \"weight_prices\": [\n {\n \"weight\": \"\",\n \"weight_unit\": \"\",\n \"price\": \"\",\n \"original_price\": \"\",\n \"in_stock\": \"\"\n },\n {\n \"weight\": \"\",\n \"weight_unit\": \"\",\n \"price\": \"\",\n \"original_price\": \"\",\n \"in_stock\": \"\"\n }\n ]\n }\n },\n {\n \"id\": \"\",\n \"type\": \"store_products\",\n \"attributes\": {\n \"name\": \"\",\n \"slug\": \"\",\n \"sku\": \"\",\n \"description\": \"\",\n \"external_id\": \"\",\n \"type\": \"\",\n \"strain\": \"\",\n \"flower_type\": \"\",\n \"composition\": \"\",\n \"thc\": \"\",\n \"cbd\": \"\",\n \"min_cbd\": \"\",\n \"potency\": \"\",\n \"terpenoids\": [\n \"\",\n \"\"\n ],\n \"cannabis_weight\": \"\",\n \"size\": \"\",\n \"main_image\": \"\",\n \"in_stock\": \"\",\n \"is_promoted\": \"\",\n \"discount\": \"\",\n \"unit_price\": \"\",\n \"unit_prices\": [\n {\n \"display_name\": \"\",\n \"quantity\": \"\",\n \"price\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"discount_price\": \"\",\n \"savings_per_unit\": \"\"\n },\n {\n \"display_name\": \"\",\n \"quantity\": \"\",\n \"price\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"discount_price\": \"\",\n \"savings_per_unit\": \"\"\n }\n ],\n \"weight_prices\": [\n {\n \"weight\": \"\",\n \"weight_unit\": \"\",\n \"price\": \"\",\n \"original_price\": \"\",\n \"in_stock\": \"\"\n },\n {\n \"weight\": \"\",\n \"weight_unit\": \"\",\n \"price\": \"\",\n \"original_price\": \"\",\n \"in_stock\": \"\"\n }\n ]\n }\n }\n ],\n \"included\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n },\n \"key_1\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n },\n \"key_2\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n }\n }\n }\n ],\n \"meta\": {\n \"total\": \"\",\n \"limit\": \"\",\n \"offset\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "cart-toppers", "description": "", "item": [ { "id": "00325561-5326-4216-9df6-65a2be418837", "name": "Get cart toppers", "request": { "name": "Get cart toppers", "description": { "content": "Retrieve product recommendations to show on the cart page,\nsuggesting complementary items the user might want to add\nbefore checkout.\n\n**Auth pipeline**: `jwt_optional_authenticated`\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "products", "recommendations", "cart-toppers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Maximum number of results to return. Defaults to 20.", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Number of results to skip for pagination. Defaults to 0.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [], "raw": "{{baseUrl}}/api/v1/products/recommendations/cart-toppers?limit=20&offset=0" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "30b4266c-41b2-47ae-bfc9-687ff18c4be1", "name": "Cart topper recommendations", "originalRequest": { "url": { "path": [ "api", "v1", "products", "recommendations", "cart-toppers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Maximum number of results to return. Defaults to 20.", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Number of results to skip for pagination. Defaults to 0.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [], "raw": "{{baseUrl}}/api/v1/products/recommendations/cart-toppers?limit=20&offset=0" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"store_products\",\n \"attributes\": {\n \"name\": \"\",\n \"slug\": \"\",\n \"sku\": \"\",\n \"description\": \"\",\n \"external_id\": \"\",\n \"type\": \"\",\n \"strain\": \"\",\n \"flower_type\": \"\",\n \"composition\": \"\",\n \"thc\": \"\",\n \"cbd\": \"\",\n \"min_cbd\": \"\",\n \"potency\": \"\",\n \"terpenoids\": [\n \"\",\n \"\"\n ],\n \"cannabis_weight\": \"\",\n \"size\": \"\",\n \"main_image\": \"\",\n \"in_stock\": \"\",\n \"is_promoted\": \"\",\n \"discount\": \"\",\n \"unit_price\": \"\",\n \"unit_prices\": [\n {\n \"display_name\": \"\",\n \"quantity\": \"\",\n \"price\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"discount_price\": \"\",\n \"savings_per_unit\": \"\"\n },\n {\n \"display_name\": \"\",\n \"quantity\": \"\",\n \"price\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"discount_price\": \"\",\n \"savings_per_unit\": \"\"\n }\n ],\n \"weight_prices\": [\n {\n \"weight\": \"\",\n \"weight_unit\": \"\",\n \"price\": \"\",\n \"original_price\": \"\",\n \"in_stock\": \"\"\n },\n {\n \"weight\": \"\",\n \"weight_unit\": \"\",\n \"price\": \"\",\n \"original_price\": \"\",\n \"in_stock\": \"\"\n }\n ]\n }\n },\n {\n \"id\": \"\",\n \"type\": \"store_products\",\n \"attributes\": {\n \"name\": \"\",\n \"slug\": \"\",\n \"sku\": \"\",\n \"description\": \"\",\n \"external_id\": \"\",\n \"type\": \"\",\n \"strain\": \"\",\n \"flower_type\": \"\",\n \"composition\": \"\",\n \"thc\": \"\",\n \"cbd\": \"\",\n \"min_cbd\": \"\",\n \"potency\": \"\",\n \"terpenoids\": [\n \"\",\n \"\"\n ],\n \"cannabis_weight\": \"\",\n \"size\": \"\",\n \"main_image\": \"\",\n \"in_stock\": \"\",\n \"is_promoted\": \"\",\n \"discount\": \"\",\n \"unit_price\": \"\",\n \"unit_prices\": [\n {\n \"display_name\": \"\",\n \"quantity\": \"\",\n \"price\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"discount_price\": \"\",\n \"savings_per_unit\": \"\"\n },\n {\n \"display_name\": \"\",\n \"quantity\": \"\",\n \"price\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"discount_price\": \"\",\n \"savings_per_unit\": \"\"\n }\n ],\n \"weight_prices\": [\n {\n \"weight\": \"\",\n \"weight_unit\": \"\",\n \"price\": \"\",\n \"original_price\": \"\",\n \"in_stock\": \"\"\n },\n {\n \"weight\": \"\",\n \"weight_unit\": \"\",\n \"price\": \"\",\n \"original_price\": \"\",\n \"in_stock\": \"\"\n }\n ]\n }\n }\n ],\n \"included\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n },\n \"key_1\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n },\n \"key_2\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n }\n }\n }\n ],\n \"meta\": {\n \"total\": \"\",\n \"limit\": \"\",\n \"offset\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] }, { "name": "groups", "description": "", "item": [ { "name": "stores", "description": "", "item": [ { "id": "ec933dbf-33f2-46d6-ace3-b30a0cabf0e3", "name": "List group stores", "request": { "name": "List group stores", "description": { "content": "Retrieve all stores belonging to the group identified by the `X-Group` header.\nUsed for multi-store storefronts with store pickers.\n\n**Auth pipeline**: `jwt_optional_authenticated`\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "groups", "stores" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/groups/stores" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the group to scope the request to.\nRequired on group-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Group", "value": "" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "d797d101-7fdd-4511-aaad-3d9ad2b5fe3f", "name": "List of stores in the group", "originalRequest": { "url": { "path": [ "api", "v1", "groups", "stores" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/groups/stores" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the group to scope the request to.\nRequired on group-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Group", "value": "" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"stores\",\n \"attributes\": {\n \"name\": \"\",\n \"slug\": \"\",\n \"address\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\",\n \"country\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"phone\": \"\",\n \"email\": \"\",\n \"is_active\": \"\",\n \"point_of_sales\": \"\",\n \"delivery_enabled\": \"\",\n \"pickup_enabled\": \"\",\n \"timezone\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"type\": \"stores\",\n \"attributes\": {\n \"name\": \"\",\n \"slug\": \"\",\n \"address\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\",\n \"country\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"phone\": \"\",\n \"email\": \"\",\n \"is_active\": \"\",\n \"point_of_sales\": \"\",\n \"delivery_enabled\": \"\",\n \"pickup_enabled\": \"\",\n \"timezone\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "39d8600f-3ce8-40bf-87be-53089342e729", "name": "Bad Request. Possible error codes:\n- `bad_request` \u2014 Missing X-Group header", "originalRequest": { "url": { "path": [ "api", "v1", "groups", "stores" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/groups/stores" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the group to scope the request to.\nRequired on group-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Group", "value": "" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bd0af04a-cd72-4fae-bc4c-03fc5b69230b", "name": "Resource not found", "originalRequest": { "url": { "path": [ "api", "v1", "groups", "stores" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/groups/stores" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the group to scope the request to.\nRequired on group-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Group", "value": "" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "orders", "description": "", "item": [ { "name": "{uuid}", "description": "", "item": [ { "id": "ba0d3677-4e4c-4d6d-92d6-3250f6ffae21", "name": "Get order details", "request": { "name": "Get order details", "description": { "content": "Retrieve full details for a single order including items, totals,\ndelivery info, and status.\n\n**Auth pipeline**: `jwt_optional_authenticated`\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "orders", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "uuid", "disabled": false, "description": { "content": "(Required) Order UUID", "type": "text/plain" } } ], "raw": "{{baseUrl}}/api/v1/orders/:uuid" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {}, "auth": { "type": "noauth" } }, "response": [ { "id": "ef629b8c-448e-4867-8fe0-34412290ec10", "name": "Order details", "originalRequest": { "url": { "path": [ "api", "v1", "orders", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Order UUID", "type": "text/plain" }, "type": "any", "value": "", "key": "uuid" } ], "raw": "{{baseUrl}}/api/v1/orders/:uuid" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"orders\",\n \"attributes\": {\n \"status\": \"\",\n \"order_number\": \"\",\n \"subtotal\": \"\",\n \"total\": \"\",\n \"tax\": \"\",\n \"discount\": \"\",\n \"delivery_fee\": \"\",\n \"delivery_type\": \"\",\n \"delivery_date\": \"\",\n \"delivery_time_slot\": \"\",\n \"notes\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n \"relationships\": {\n \"order_items\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n }\n }\n },\n \"included\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7e16981e-c563-430f-9908-7183bb9920c2", "name": "Possible error codes:\n- `order_user_mismatch` \u2014 Order belongs to another user", "originalRequest": { "url": { "path": [ "api", "v1", "orders", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Order UUID", "type": "text/plain" }, "type": "any", "value": "", "key": "uuid" } ], "raw": "{{baseUrl}}/api/v1/orders/:uuid" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "833bfc10-50a6-42db-83b7-69fbc7f378dc", "name": "Resource not found", "originalRequest": { "url": { "path": [ "api", "v1", "orders", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Order UUID", "type": "text/plain" }, "type": "any", "value": "", "key": "uuid" } ], "raw": "{{baseUrl}}/api/v1/orders/:uuid" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "complete", "description": "", "item": [ { "id": "c972bd18-a4f3-49cf-a604-e69da02d0d97", "name": "Complete order", "request": { "name": "Complete order", "description": { "content": "Mark an order as completed. Typically called after customer pickup\nor delivery confirmation.\n\n**Auth pipeline**: `jwt_optional_authenticated`\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "orders", ":uuid", "complete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "uuid", "disabled": false, "description": { "content": "(Required) Order UUID", "type": "text/plain" } } ], "raw": "{{baseUrl}}/api/v1/orders/:uuid/complete" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "PATCH", "body": {}, "auth": { "type": "noauth" } }, "response": [ { "id": "a060da45-db91-4655-bb33-6dc4e56c195b", "name": "Order marked as completed", "originalRequest": { "url": { "path": [ "api", "v1", "orders", ":uuid", "complete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Order UUID", "type": "text/plain" }, "type": "any", "value": "", "key": "uuid" } ], "raw": "{{baseUrl}}/api/v1/orders/:uuid/complete" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "PATCH", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"orders\",\n \"attributes\": {\n \"status\": \"\",\n \"order_number\": \"\",\n \"subtotal\": \"\",\n \"total\": \"\",\n \"tax\": \"\",\n \"discount\": \"\",\n \"delivery_fee\": \"\",\n \"delivery_type\": \"\",\n \"delivery_date\": \"\",\n \"delivery_time_slot\": \"\",\n \"notes\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b5421819-af87-4e0b-b51b-53b73a85269a", "name": "Resource not found", "originalRequest": { "url": { "path": [ "api", "v1", "orders", ":uuid", "complete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Order UUID", "type": "text/plain" }, "type": "any", "value": "", "key": "uuid" } ], "raw": "{{baseUrl}}/api/v1/orders/:uuid/complete" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "PATCH", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "id": "b1e5a802-4f10-496c-80df-ad8670bdf63c", "name": "List orders (order history)", "request": { "name": "List orders (order history)", "description": { "content": "Retrieve a paginated list of orders for the authenticated user.\nUsed for order history pages.\n\n**Auth pipeline**: `jwt_authenticated` (requires login)\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "orders" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Maximum number of results to return. Defaults to 20.", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Number of results to skip for pagination. Defaults to 0.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [], "raw": "{{baseUrl}}/api/v1/orders?limit=20&offset=0" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "d490897a-3af5-45a3-99d7-ca36237f10e6", "name": "Paginated order list", "originalRequest": { "url": { "path": [ "api", "v1", "orders" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Maximum number of results to return. Defaults to 20.", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Number of results to skip for pagination. Defaults to 0.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [], "raw": "{{baseUrl}}/api/v1/orders?limit=20&offset=0" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"orders\",\n \"attributes\": {\n \"status\": \"\",\n \"order_number\": \"\",\n \"subtotal\": \"\",\n \"total\": \"\",\n \"tax\": \"\",\n \"discount\": \"\",\n \"delivery_fee\": \"\",\n \"delivery_type\": \"\",\n \"delivery_date\": \"\",\n \"delivery_time_slot\": \"\",\n \"notes\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"type\": \"orders\",\n \"attributes\": {\n \"status\": \"\",\n \"order_number\": \"\",\n \"subtotal\": \"\",\n \"total\": \"\",\n \"tax\": \"\",\n \"discount\": \"\",\n \"delivery_fee\": \"\",\n \"delivery_type\": \"\",\n \"delivery_date\": \"\",\n \"delivery_time_slot\": \"\",\n \"notes\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n }\n ],\n \"included\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n },\n \"key_1\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n },\n \"key_1\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n },\n \"key_2\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n },\n \"key_3\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n }\n }\n }\n ],\n \"meta\": {\n \"total\": \"\",\n \"limit\": \"\",\n \"offset\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f841486f-f789-4ae6-bf23-5b7d5f3fd98e", "name": "Missing or invalid authentication token", "originalRequest": { "url": { "path": [ "api", "v1", "orders" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Maximum number of results to return. Defaults to 20.", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Number of results to skip for pagination. Defaults to 0.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [], "raw": "{{baseUrl}}/api/v1/orders?limit=20&offset=0" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "users", "description": "", "item": [ { "name": "me", "description": "", "item": [ { "id": "ca0da20a-f115-4d97-aeb9-e75d72148d71", "name": "Get current user profile", "request": { "name": "Get current user profile", "description": { "content": "Retrieve the authenticated user's profile details.\nThe `X-Store` header is optional \u2014 if provided, store-specific data may be included.\n\n**Auth pipeline**: `jwt_authenticated`\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "users", "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/users/me" }, "header": [ { "disabled": false, "description": { "content": "Optional store UUID to include store-specific user data", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "dc773580-ac79-407f-a4fe-5186bf348fa2", "name": "User profile", "originalRequest": { "url": { "path": [ "api", "v1", "users", "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/users/me" }, "header": [ { "disabled": false, "description": { "content": "Optional store UUID to include store-specific user data", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"users\",\n \"attributes\": {\n \"email\": \"\",\n \"phone_number\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"zip_code\": \"\",\n \"address\": {\n \"key_0\": 1220\n },\n \"billing_address\": {\n \"key_0\": 8200.265830963244\n },\n \"date_of_birth\": \"\",\n \"marketing_email_opt_in\": \"\",\n \"marketing_sms_opt_in\": \"\",\n \"medical_id\": {\n \"number\": \"\",\n \"expiration_date\": \"\"\n },\n \"drivers_license_id\": {\n \"number\": \"\",\n \"expiration_date\": \"\"\n },\n \"customer_type\": \"\",\n \"is_confirmed\": \"\",\n \"is_active\": \"\",\n \"token\": \"\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9ea20843-8910-44af-89d7-62e88349bab3", "name": "Missing or invalid authentication token", "originalRequest": { "url": { "path": [ "api", "v1", "users", "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/users/me" }, "header": [ { "disabled": false, "description": { "content": "Optional store UUID to include store-specific user data", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "20ceb76a-3f90-4720-b6b7-30767fee3d63", "name": "Update user profile", "request": { "name": "Update user profile", "description": { "content": "Update the authenticated user's profile. All fields are optional \u2014 only provided fields are updated.\n\n**Auth pipeline**: `jwt_authenticated`\n\n**Error codes**:\n- `name_and_dob_update_not_alowed` \u2014 Name/DOB updates locked after verification\n- `locked_verified_user_uploads` \u2014 Document uploads locked after ID verification\n- `user_is_not_confirmed` \u2014 Cannot update an unconfirmed user\n- `age_not_allowed` \u2014 Date of birth does not meet minimum age requirement\n- `inactive_user` \u2014 User account is inactive\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "users", "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/users/me" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"users\",\n \"attributes\": {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"zip_code\": \"\",\n \"address\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"billing_address\": {\n \"key_0\": 3569,\n \"key_1\": 8667\n },\n \"date_of_birth\": \"\",\n \"marketing_email_opt_in\": \"\",\n \"marketing_sms_opt_in\": \"\",\n \"medical_id\": {\n \"number\": \"\",\n \"expiration_date\": \"\"\n },\n \"drivers_license_id\": {\n \"number\": \"\",\n \"expiration_date\": \"\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "3f7e4ea1-f1c3-4e37-8d80-b26c7bc2133b", "name": "Updated user profile", "originalRequest": { "url": { "path": [ "api", "v1", "users", "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/users/me" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"users\",\n \"attributes\": {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"zip_code\": \"\",\n \"address\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"billing_address\": {\n \"key_0\": 3569,\n \"key_1\": 8667\n },\n \"date_of_birth\": \"\",\n \"marketing_email_opt_in\": \"\",\n \"marketing_sms_opt_in\": \"\",\n \"medical_id\": {\n \"number\": \"\",\n \"expiration_date\": \"\"\n },\n \"drivers_license_id\": {\n \"number\": \"\",\n \"expiration_date\": \"\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"users\",\n \"attributes\": {\n \"email\": \"\",\n \"phone_number\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"zip_code\": \"\",\n \"address\": {\n \"key_0\": 1220\n },\n \"billing_address\": {\n \"key_0\": 8200.265830963244\n },\n \"date_of_birth\": \"\",\n \"marketing_email_opt_in\": \"\",\n \"marketing_sms_opt_in\": \"\",\n \"medical_id\": {\n \"number\": \"\",\n \"expiration_date\": \"\"\n },\n \"drivers_license_id\": {\n \"number\": \"\",\n \"expiration_date\": \"\"\n },\n \"customer_type\": \"\",\n \"is_confirmed\": \"\",\n \"is_active\": \"\",\n \"token\": \"\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "717cf358-3ffa-454b-98ea-2818dfde63d6", "name": "Bad request. Possible error codes:\n- `name_and_dob_update_not_alowed` \u2014 Name/DOB updates locked\n- `locked_verified_user_uploads` \u2014 Verified user uploads locked\n- `user_is_not_confirmed` \u2014 User not confirmed\n- `age_not_allowed` \u2014 Minimum age not met", "originalRequest": { "url": { "path": [ "api", "v1", "users", "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/users/me" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"users\",\n \"attributes\": {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"zip_code\": \"\",\n \"address\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"billing_address\": {\n \"key_0\": 3569,\n \"key_1\": 8667\n },\n \"date_of_birth\": \"\",\n \"marketing_email_opt_in\": \"\",\n \"marketing_sms_opt_in\": \"\",\n \"medical_id\": {\n \"number\": \"\",\n \"expiration_date\": \"\"\n },\n \"drivers_license_id\": {\n \"number\": \"\",\n \"expiration_date\": \"\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fb663637-b7d9-4cb5-80e0-92196e7ff876", "name": "Missing or invalid authentication token", "originalRequest": { "url": { "path": [ "api", "v1", "users", "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/users/me" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"users\",\n \"attributes\": {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"zip_code\": \"\",\n \"address\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"billing_address\": {\n \"key_0\": 3569,\n \"key_1\": 8667\n },\n \"date_of_birth\": \"\",\n \"marketing_email_opt_in\": \"\",\n \"marketing_sms_opt_in\": \"\",\n \"medical_id\": {\n \"number\": \"\",\n \"expiration_date\": \"\"\n },\n \"drivers_license_id\": {\n \"number\": \"\",\n \"expiration_date\": \"\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7eafd8a4-861d-4b2e-ba51-2650fdff0b22", "name": "Update user profile (partial)", "request": { "name": "Update user profile (partial)", "description": { "content": "Partially update the authenticated user's profile. Same behavior as PUT.\n\n**Auth pipeline**: `jwt_authenticated`\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "users", "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/users/me" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"users\",\n \"attributes\": {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"zip_code\": \"\",\n \"address\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"billing_address\": {\n \"key_0\": 3569,\n \"key_1\": 8667\n },\n \"date_of_birth\": \"\",\n \"marketing_email_opt_in\": \"\",\n \"marketing_sms_opt_in\": \"\",\n \"medical_id\": {\n \"number\": \"\",\n \"expiration_date\": \"\"\n },\n \"drivers_license_id\": {\n \"number\": \"\",\n \"expiration_date\": \"\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "894571cb-7fa1-4af7-83c9-7580f0aab822", "name": "Updated user profile", "originalRequest": { "url": { "path": [ "api", "v1", "users", "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/users/me" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"users\",\n \"attributes\": {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"zip_code\": \"\",\n \"address\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"billing_address\": {\n \"key_0\": 3569,\n \"key_1\": 8667\n },\n \"date_of_birth\": \"\",\n \"marketing_email_opt_in\": \"\",\n \"marketing_sms_opt_in\": \"\",\n \"medical_id\": {\n \"number\": \"\",\n \"expiration_date\": \"\"\n },\n \"drivers_license_id\": {\n \"number\": \"\",\n \"expiration_date\": \"\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"users\",\n \"attributes\": {\n \"email\": \"\",\n \"phone_number\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"zip_code\": \"\",\n \"address\": {\n \"key_0\": 1220\n },\n \"billing_address\": {\n \"key_0\": 8200.265830963244\n },\n \"date_of_birth\": \"\",\n \"marketing_email_opt_in\": \"\",\n \"marketing_sms_opt_in\": \"\",\n \"medical_id\": {\n \"number\": \"\",\n \"expiration_date\": \"\"\n },\n \"drivers_license_id\": {\n \"number\": \"\",\n \"expiration_date\": \"\"\n },\n \"customer_type\": \"\",\n \"is_confirmed\": \"\",\n \"is_active\": \"\",\n \"token\": \"\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b373fde-3e7d-4515-acbe-dcd8d1923329", "name": "Invalid request parameters", "originalRequest": { "url": { "path": [ "api", "v1", "users", "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/users/me" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"users\",\n \"attributes\": {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"zip_code\": \"\",\n \"address\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"billing_address\": {\n \"key_0\": 3569,\n \"key_1\": 8667\n },\n \"date_of_birth\": \"\",\n \"marketing_email_opt_in\": \"\",\n \"marketing_sms_opt_in\": \"\",\n \"medical_id\": {\n \"number\": \"\",\n \"expiration_date\": \"\"\n },\n \"drivers_license_id\": {\n \"number\": \"\",\n \"expiration_date\": \"\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d16faf4f-cb07-4e0b-8a63-2cf54d166afc", "name": "Missing or invalid authentication token", "originalRequest": { "url": { "path": [ "api", "v1", "users", "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/users/me" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"users\",\n \"attributes\": {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"zip_code\": \"\",\n \"address\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"billing_address\": {\n \"key_0\": 3569,\n \"key_1\": 8667\n },\n \"date_of_birth\": \"\",\n \"marketing_email_opt_in\": \"\",\n \"marketing_sms_opt_in\": \"\",\n \"medical_id\": {\n \"number\": \"\",\n \"expiration_date\": \"\"\n },\n \"drivers_license_id\": {\n \"number\": \"\",\n \"expiration_date\": \"\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7962a5fb-482d-4160-af09-5463c774a4b0", "name": "Deactivate account", "request": { "name": "Deactivate account", "description": { "content": "Deactivate the authenticated user's account.\n\n**Auth pipeline**: `jwt_authenticated`\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "users", "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/users/me" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "DELETE", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "5fd73003-33e8-4d36-9687-ad8a3cb1e982", "name": "Account deactivated", "originalRequest": { "url": { "path": [ "api", "v1", "users", "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/users/me" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "86250dcd-01a4-4cb6-b8c1-100bb3e3a65f", "name": "Missing or invalid authentication token", "originalRequest": { "url": { "path": [ "api", "v1", "users", "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/users/me" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "access_token", "description": "", "item": [ { "id": "687d43b1-75e5-4715-aab4-754babf6d639", "name": "Mint a short-lived handoff token", "request": { "name": "Mint a short-lived handoff token", "description": { "content": "Issue a short-lived access token for the authenticated user, used to transfer\ntheir session to another surface \u2014 most notably the Blaze-hosted checkout.\nSee the [Checkout Handoff guide](/guides/checkout-handoff).\n\n**The token expires 5 minutes after it is issued.** Mint it immediately before\nthe redirect that consumes it; do not cache or reuse it.\n\nThe token is redeemed by posting it to `POST /api/v1/auth/login` as the\n`access_token` attribute, which returns a full session token.\n\n> **Security**: for its lifetime this token authenticates as the user. It is not\n> restricted to a single use or to a particular cart. Never log it, persist it, or\n> place it in a shareable link.\n\n**Auth pipeline**: `jwt_authenticated`\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "users", "me", "access_token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/users/me/access_token" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"user_access_tokens\",\n \"attributes\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "4b3d5456-2ffc-4917-be73-4e2995179afc", "name": "Short-lived access token", "originalRequest": { "url": { "path": [ "api", "v1", "users", "me", "access_token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/users/me/access_token" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"user_access_tokens\",\n \"attributes\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"user_access_tokens\",\n \"attributes\": {\n \"access_token\": \"\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "667fab5b-ff8d-49c4-9462-10c20969d5d9", "name": "Missing or invalid authentication token", "originalRequest": { "url": { "path": [ "api", "v1", "users", "me", "access_token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/users/me/access_token" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"user_access_tokens\",\n \"attributes\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "sync", "description": "", "item": [ { "id": "6cd094dc-bfd1-4223-99ee-28d62fc5e65f", "name": "Sync user with POS", "request": { "name": "Sync user with POS", "description": { "content": "Synchronize the authenticated user's profile with the Point of Sale system.\nUpdates local data with the latest from the POS (loyalty points, member status, etc.).\n\n**Auth pipeline**: `jwt_authenticated`\n\n**Error codes**:\n- `user_is_not_linked` \u2014 User is not linked to any POS profile\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "users", "me", "sync" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/users/me/sync" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "fff2935a-62de-4828-a751-569b94c30216", "name": "User synced with POS", "originalRequest": { "url": { "path": [ "api", "v1", "users", "me", "sync" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/users/me/sync" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"users\",\n \"attributes\": {\n \"email\": \"\",\n \"phone_number\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"zip_code\": \"\",\n \"address\": {\n \"key_0\": 1220\n },\n \"billing_address\": {\n \"key_0\": 8200.265830963244\n },\n \"date_of_birth\": \"\",\n \"marketing_email_opt_in\": \"\",\n \"marketing_sms_opt_in\": \"\",\n \"medical_id\": {\n \"number\": \"\",\n \"expiration_date\": \"\"\n },\n \"drivers_license_id\": {\n \"number\": \"\",\n \"expiration_date\": \"\"\n },\n \"customer_type\": \"\",\n \"is_confirmed\": \"\",\n \"is_active\": \"\",\n \"token\": \"\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "274e2b0d-ddae-47aa-9d89-31ae6eba21f7", "name": "Possible error codes:\n- `user_is_not_linked` \u2014 User is not linked to any POS profile", "originalRequest": { "url": { "path": [ "api", "v1", "users", "me", "sync" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/users/me/sync" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "526159d2-79b0-492a-8e4b-e78b0a9b31b2", "name": "Missing or invalid authentication token", "originalRequest": { "url": { "path": [ "api", "v1", "users", "me", "sync" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/users/me/sync" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "billing", "description": "", "item": [ { "id": "f8013794-62b9-406d-b226-38d354859e99", "name": "Get billing info", "request": { "name": "Get billing info", "description": { "content": "Retrieve the authenticated user's billing information.\n\n**Auth pipeline**: `jwt_authenticated`\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "users", "me", "billing" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/users/me/billing" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "0f78a608-4272-4911-b268-2b3d7f125ce3", "name": "Billing information", "originalRequest": { "url": { "path": [ "api", "v1", "users", "me", "billing" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/users/me/billing" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"billing\",\n \"attributes\": {\n \"address\": null\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9753ee7f-a4eb-417a-aa5e-409f811c0d28", "name": "Missing or invalid authentication token", "originalRequest": { "url": { "path": [ "api", "v1", "users", "me", "billing" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/users/me/billing" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "610fac3d-8195-4d16-bacb-5ef77f8315b2", "name": "Update billing address", "request": { "name": "Update billing address", "description": { "content": "Update the authenticated user's billing address.\n\n**Auth pipeline**: `jwt_authenticated`\n\n**Error codes**:\n- `missing_billing_address` \u2014 Billing address fields are missing\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "users", "me", "billing" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/users/me/billing" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"billing\",\n \"attributes\": {\n \"address\": {\n \"address\": \"\",\n \"address_line2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\",\n \"country\": \"\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "c1421003-fb6f-4383-abd6-d825091cdc8a", "name": "Billing address updated", "originalRequest": { "url": { "path": [ "api", "v1", "users", "me", "billing" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/users/me/billing" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"billing\",\n \"attributes\": {\n \"address\": {\n \"address\": \"\",\n \"address_line2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\",\n \"country\": \"\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "351c51ef-6f41-4cf9-84b4-6e8a11a2fdc3", "name": "Possible error codes:\n- `missing_billing_address` \u2014 Required billing fields missing", "originalRequest": { "url": { "path": [ "api", "v1", "users", "me", "billing" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/users/me/billing" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"billing\",\n \"attributes\": {\n \"address\": {\n \"address\": \"\",\n \"address_line2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\",\n \"country\": \"\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4ab581fd-e6b9-4f67-bf38-9fa9576b1caf", "name": "Missing or invalid authentication token", "originalRequest": { "url": { "path": [ "api", "v1", "users", "me", "billing" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/users/me/billing" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"billing\",\n \"attributes\": {\n \"address\": {\n \"address\": \"\",\n \"address_line2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\",\n \"country\": \"\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c10fbf50-9dce-4d2d-baf3-a5245f8622f5", "name": "Replace billing address", "request": { "name": "Replace billing address", "description": { "content": "Replace the authenticated user's billing address. Same as PATCH.\n\n**Auth pipeline**: `jwt_authenticated`\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "users", "me", "billing" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/users/me/billing" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"billing\",\n \"attributes\": {\n \"address\": {\n \"address\": \"\",\n \"address_line2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\",\n \"country\": \"\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "0a6ea108-95c2-4460-887c-39987870b9ec", "name": "Billing address updated", "originalRequest": { "url": { "path": [ "api", "v1", "users", "me", "billing" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/users/me/billing" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"billing\",\n \"attributes\": {\n \"address\": {\n \"address\": \"\",\n \"address_line2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\",\n \"country\": \"\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9ba99b06-68cf-4d7d-bafa-c48899d1ff2e", "name": "Invalid request parameters", "originalRequest": { "url": { "path": [ "api", "v1", "users", "me", "billing" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/users/me/billing" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"billing\",\n \"attributes\": {\n \"address\": {\n \"address\": \"\",\n \"address_line2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\",\n \"country\": \"\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1d97d164-b4ab-4eb5-afcd-93e3100e89d6", "name": "Missing or invalid authentication token", "originalRequest": { "url": { "path": [ "api", "v1", "users", "me", "billing" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/users/me/billing" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"billing\",\n \"attributes\": {\n \"address\": {\n \"address\": \"\",\n \"address_line2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\",\n \"country\": \"\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "rewards", "description": "", "item": [ { "id": "89589726-f7ac-4b5c-b2c0-eb6665036613", "name": "Get available rewards", "request": { "name": "Get available rewards", "description": { "content": "Retrieve rewards available for the authenticated user to redeem.\n\n**Auth pipeline**: `jwt_authenticated`\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "users", "me", "rewards" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/users/me/rewards" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "6c7bda65-209a-403f-9b55-74de5511aad3", "name": "Available rewards", "originalRequest": { "url": { "path": [ "api", "v1", "users", "me", "rewards" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/users/me/rewards" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"rewards\",\n \"attributes\": {\n \"name\": \"\",\n \"slug\": \"\",\n \"description\": \"\",\n \"image_url\": \"\",\n \"points_required\": \"\",\n \"discount_type\": \"\",\n \"discount_value\": \"\",\n \"is_active\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"type\": \"rewards\",\n \"attributes\": {\n \"name\": \"\",\n \"slug\": \"\",\n \"description\": \"\",\n \"image_url\": \"\",\n \"points_required\": \"\",\n \"discount_type\": \"\",\n \"discount_value\": \"\",\n \"is_active\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f8a15276-4ffb-4013-94fb-3ed22db204a7", "name": "Missing or invalid authentication token", "originalRequest": { "url": { "path": [ "api", "v1", "users", "me", "rewards" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/users/me/rewards" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "identity-verification", "description": "", "item": [ { "id": "3662d27f-3bc9-4da9-86ff-bc2c0e720b87", "name": "Get identity verification report", "request": { "name": "Get identity verification report", "description": { "content": "Retrieve the identity verification report for the authenticated user.\n\n**Auth pipeline**: `jwt_authenticated`\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "users", "me", "identity-verification" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/users/me/identity-verification" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "c4424de6-0230-4018-bd6f-c08cb099b85a", "name": "Identity verification report", "originalRequest": { "url": { "path": [ "api", "v1", "users", "me", "identity-verification" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/users/me/identity-verification" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"identity_verifications\",\n \"attributes\": {\n \"service\": \"\",\n \"status\": \"\",\n \"identity_verification_id\": \"\",\n \"client_token\": \"\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cff3b097-b6df-47a1-a0aa-a8bc1c1816b8", "name": "Missing or invalid authentication token", "originalRequest": { "url": { "path": [ "api", "v1", "users", "me", "identity-verification" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/users/me/identity-verification" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{service}", "description": "", "item": [ { "id": "0ba26555-53c0-43aa-baaf-94044ca5c30b", "name": "Create identity verification", "request": { "name": "Create identity verification", "description": { "content": "Initiate an identity verification transaction with the specified service.\n\n**Auth pipeline**: `jwt_authenticated`\n\n**Error codes**:\n- `bad_request` \u2014 Invalid identity verification option\n- `user_already_verified` \u2014 User already verified by this service\n- `missing_identity_verification_data` \u2014 Missing required verification data\n- `inactive_service_config` \u2014 Verification service configuration is inactive\n- `missing_service_config` \u2014 Verification service not configured\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "users", "me", "identity-verification", ":service" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "service", "disabled": false, "description": { "content": "(Required) Identity verification service (e.g. \"berbix\")", "type": "text/plain" } } ], "raw": "{{baseUrl}}/api/v1/users/me/identity-verification/:service" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"identity_verifications\",\n \"attributes\": {\n \"identity_verification_id\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "a492171c-3198-4fc7-8352-c0dc4b74fe04", "name": "Verification transaction created", "originalRequest": { "url": { "path": [ "api", "v1", "users", "me", "identity-verification", ":service" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identity verification service (e.g. \"berbix\")", "type": "text/plain" }, "type": "any", "value": "", "key": "service" } ], "raw": "{{baseUrl}}/api/v1/users/me/identity-verification/:service" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"identity_verifications\",\n \"attributes\": {\n \"identity_verification_id\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "678b2979-70c1-4554-966a-4f187d29b469", "name": "Possible error codes:\n- `bad_request` \u2014 Invalid identity verification option\n- `user_already_verified` \u2014 Already verified by this service\n- `missing_identity_verification_data` \u2014 Missing required data\n- `inactive_service_config` \u2014 Service config is inactive\n- `missing_service_config` \u2014 Service not configured", "originalRequest": { "url": { "path": [ "api", "v1", "users", "me", "identity-verification", ":service" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identity verification service (e.g. \"berbix\")", "type": "text/plain" }, "type": "any", "value": "", "key": "service" } ], "raw": "{{baseUrl}}/api/v1/users/me/identity-verification/:service" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"identity_verifications\",\n \"attributes\": {\n \"identity_verification_id\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d5c72fde-1bad-473b-8b7b-ea3695b46430", "name": "Missing or invalid authentication token", "originalRequest": { "url": { "path": [ "api", "v1", "users", "me", "identity-verification", ":service" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identity verification service (e.g. \"berbix\")", "type": "text/plain" }, "type": "any", "value": "", "key": "service" } ], "raw": "{{baseUrl}}/api/v1/users/me/identity-verification/:service" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"identity_verifications\",\n \"attributes\": {\n \"identity_verification_id\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a1c4df2f-ad5d-4d3d-a06a-4605cbeb39a6", "name": "Get identity verification status", "request": { "name": "Get identity verification status", "description": { "content": "Get the status of an identity verification transaction for the specified service.\n\n**Auth pipeline**: `jwt_authenticated`\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "users", "me", "identity-verification", ":service" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "service", "disabled": false, "description": { "content": "(Required) Identity verification service (e.g. \"berbix\")", "type": "text/plain" } } ], "raw": "{{baseUrl}}/api/v1/users/me/identity-verification/:service" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "269c7c5a-98f9-4199-b2b7-2ab6c31a277a", "name": "Verification status", "originalRequest": { "url": { "path": [ "api", "v1", "users", "me", "identity-verification", ":service" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identity verification service (e.g. \"berbix\")", "type": "text/plain" }, "type": "any", "value": "", "key": "service" } ], "raw": "{{baseUrl}}/api/v1/users/me/identity-verification/:service" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dfd4b718-8f08-4a77-8a9c-6ad6f84376eb", "name": "Missing or invalid authentication token", "originalRequest": { "url": { "path": [ "api", "v1", "users", "me", "identity-verification", ":service" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identity verification service (e.g. \"berbix\")", "type": "text/plain" }, "type": "any", "value": "", "key": "service" } ], "raw": "{{baseUrl}}/api/v1/users/me/identity-verification/:service" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "devices", "description": "", "item": [ { "id": "9a4fa965-2f1c-4b28-b036-79327ae6aadc", "name": "Register push device", "request": { "name": "Register push device", "description": { "content": "Register a device for push notifications.\n\n**Auth pipeline**: `jwt_authenticated`\n\n**Error codes**:\n- `bad_request` \u2014 Invalid device data or external service error\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "users", "me", "devices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/users/me/devices" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"devices\",\n \"attributes\": {\n \"device_token\": \"\",\n \"platform\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "3a2be473-4ff5-4e44-af6e-7f6d33c27c4b", "name": "Device registered", "originalRequest": { "url": { "path": [ "api", "v1", "users", "me", "devices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/users/me/devices" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"devices\",\n \"attributes\": {\n \"device_token\": \"\",\n \"platform\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "108628f6-3fea-4f17-a11c-07d0f1b45515", "name": "Possible error codes:\n- `bad_request` \u2014 Invalid device data or credentials", "originalRequest": { "url": { "path": [ "api", "v1", "users", "me", "devices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/users/me/devices" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"devices\",\n \"attributes\": {\n \"device_token\": \"\",\n \"platform\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d474494c-21cb-41c2-8910-64401e3d3d20", "name": "Missing or invalid authentication token", "originalRequest": { "url": { "path": [ "api", "v1", "users", "me", "devices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v1/users/me/devices" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"devices\",\n \"attributes\": {\n \"device_token\": \"\",\n \"platform\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{external_device_id}", "description": "", "item": [ { "id": "ba9b31ef-847c-41b1-a3f3-a04ee5a532a4", "name": "Unregister device", "request": { "name": "Unregister device", "description": { "content": "Unregister a device from push notifications.\n\n**Auth pipeline**: `jwt_authenticated`\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "users", "me", "devices", ":external_device_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "external_device_id", "disabled": false, "description": { "content": "(Required) External device ID to unregister", "type": "text/plain" } } ], "raw": "{{baseUrl}}/api/v1/users/me/devices/:external_device_id" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "DELETE", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "0f51563a-7d2e-4cf8-b216-5cd1f676a25b", "name": "Device unregistered", "originalRequest": { "url": { "path": [ "api", "v1", "users", "me", "devices", ":external_device_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) External device ID to unregister", "type": "text/plain" }, "type": "any", "value": "", "key": "external_device_id" } ], "raw": "{{baseUrl}}/api/v1/users/me/devices/:external_device_id" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fc71a038-4a9f-482a-9266-597040a236c9", "name": "Missing or invalid authentication token", "originalRequest": { "url": { "path": [ "api", "v1", "users", "me", "devices", ":external_device_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) External device ID to unregister", "type": "text/plain" }, "type": "any", "value": "", "key": "external_device_id" } ], "raw": "{{baseUrl}}/api/v1/users/me/devices/:external_device_id" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "28974b7e-4bd4-4464-bfe5-7d074a9d67fd", "name": "Resource not found", "originalRequest": { "url": { "path": [ "api", "v1", "users", "me", "devices", ":external_device_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) External device ID to unregister", "type": "text/plain" }, "type": "any", "value": "", "key": "external_device_id" } ], "raw": "{{baseUrl}}/api/v1/users/me/devices/:external_device_id" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] } ] }, { "name": "hooks", "description": "", "item": [ { "name": "order_updated", "description": "", "item": [ { "name": "{token}", "description": "", "item": [ { "id": "75a3303e-21e5-479e-86b5-917b2004c318", "name": "Order updated webhook", "request": { "name": "Order updated webhook", "description": { "content": "Inbound webhook triggered when an order is updated in the POS.\nThe store is identified via the token in the URL path.\n\n**Auth pipeline**: `store_hook` (token-based)\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "hooks", "order_updated", ":token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "token", "disabled": false, "description": { "content": "(Required) Store webhook token", "type": "text/plain" } } ], "raw": "{{baseUrl}}/api/v1/hooks/order_updated/:token" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": true,\n \"key_1\": 47.50437963360277\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "36749c6a-c64d-4428-907b-f96e247cd63e", "name": "Webhook processed", "originalRequest": { "url": { "path": [ "api", "v1", "hooks", "order_updated", ":token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Store webhook token", "type": "text/plain" }, "type": "any", "value": "", "key": "token" } ], "raw": "{{baseUrl}}/api/v1/hooks/order_updated/:token" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": true,\n \"key_1\": 47.50437963360277\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "742e8e70-37d1-428e-a3a3-f2d6fdec7279", "name": "Invalid request parameters", "originalRequest": { "url": { "path": [ "api", "v1", "hooks", "order_updated", ":token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Store webhook token", "type": "text/plain" }, "type": "any", "value": "", "key": "token" } ], "raw": "{{baseUrl}}/api/v1/hooks/order_updated/:token" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": true,\n \"key_1\": 47.50437963360277\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "member_updated", "description": "", "item": [ { "name": "{token}", "description": "", "item": [ { "id": "cb63606b-b537-42d6-8996-3308ca88eed3", "name": "Member updated webhook", "request": { "name": "Member updated webhook", "description": { "content": "Inbound webhook triggered when a member/customer is updated in the POS.\n\n**Auth pipeline**: `store_hook` (token-based)\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "hooks", "member_updated", ":token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "token", "disabled": false, "description": { "content": "(Required) Store webhook token", "type": "text/plain" } } ], "raw": "{{baseUrl}}/api/v1/hooks/member_updated/:token" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": true,\n \"key_1\": 47.50437963360277\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "9bb7d617-57b5-4fe1-830b-fbbb7348d5ef", "name": "Webhook processed", "originalRequest": { "url": { "path": [ "api", "v1", "hooks", "member_updated", ":token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Store webhook token", "type": "text/plain" }, "type": "any", "value": "", "key": "token" } ], "raw": "{{baseUrl}}/api/v1/hooks/member_updated/:token" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": true,\n \"key_1\": 47.50437963360277\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "abb4a68e-4978-46bb-a329-39bb470b7b04", "name": "Invalid request parameters", "originalRequest": { "url": { "path": [ "api", "v1", "hooks", "member_updated", ":token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Store webhook token", "type": "text/plain" }, "type": "any", "value": "", "key": "token" } ], "raw": "{{baseUrl}}/api/v1/hooks/member_updated/:token" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": true,\n \"key_1\": 47.50437963360277\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "new_member", "description": "", "item": [ { "name": "{token}", "description": "", "item": [ { "id": "ea019ab8-4d9c-4fc7-acab-6f0a049cfd7f", "name": "New member webhook", "request": { "name": "New member webhook", "description": { "content": "Inbound webhook triggered when a new member/customer is created in the POS.\n\n**Auth pipeline**: `store_hook` (token-based)\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "hooks", "new_member", ":token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "token", "disabled": false, "description": { "content": "(Required) Store webhook token", "type": "text/plain" } } ], "raw": "{{baseUrl}}/api/v1/hooks/new_member/:token" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": true,\n \"key_1\": 47.50437963360277\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "39a7f2a5-93fe-4b8c-90f0-695b8c23620b", "name": "Webhook processed", "originalRequest": { "url": { "path": [ "api", "v1", "hooks", "new_member", ":token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Store webhook token", "type": "text/plain" }, "type": "any", "value": "", "key": "token" } ], "raw": "{{baseUrl}}/api/v1/hooks/new_member/:token" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": true,\n \"key_1\": 47.50437963360277\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "708e49de-23a7-4f2e-88f4-a702fd55a42c", "name": "Invalid request parameters", "originalRequest": { "url": { "path": [ "api", "v1", "hooks", "new_member", ":token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Store webhook token", "type": "text/plain" }, "type": "any", "value": "", "key": "token" } ], "raw": "{{baseUrl}}/api/v1/hooks/new_member/:token" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": true,\n \"key_1\": 47.50437963360277\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "payment-auth-completed", "description": "", "item": [ { "name": "{service}", "description": "", "item": [ { "name": "{token}", "description": "", "item": [ { "id": "dbe7c43d-1ccc-4aad-816e-a15907d0f242", "name": "Payment auth completed webhook", "request": { "name": "Payment auth completed webhook", "description": { "content": "Inbound webhook triggered when a payment authorization is completed\nby the external payment provider.\n\n**Auth pipeline**: `store_hook` (token-based)\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "hooks", "payment-auth-completed", ":service", ":token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "service", "disabled": false, "description": { "content": "(Required) Payment service name (e.g. \"moneris\", \"adyen\")", "type": "text/plain" } }, { "type": "any", "value": "", "key": "token", "disabled": false, "description": { "content": "(Required) Store webhook token", "type": "text/plain" } } ], "raw": "{{baseUrl}}/api/v1/hooks/payment-auth-completed/:service/:token" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": true,\n \"key_1\": 47.50437963360277\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "51a523f4-da4c-46ad-b382-323be092f3ab", "name": "Webhook processed", "originalRequest": { "url": { "path": [ "api", "v1", "hooks", "payment-auth-completed", ":service", ":token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Payment service name (e.g. \"moneris\", \"adyen\")", "type": "text/plain" }, "type": "any", "value": "", "key": "service" }, { "disabled": false, "description": { "content": "(Required) Store webhook token", "type": "text/plain" }, "type": "any", "value": "", "key": "token" } ], "raw": "{{baseUrl}}/api/v1/hooks/payment-auth-completed/:service/:token" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": true,\n \"key_1\": 47.50437963360277\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "927e1bcf-092c-4b32-bfdd-08c8e4dcb9b9", "name": "Invalid request parameters", "originalRequest": { "url": { "path": [ "api", "v1", "hooks", "payment-auth-completed", ":service", ":token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Payment service name (e.g. \"moneris\", \"adyen\")", "type": "text/plain" }, "type": "any", "value": "", "key": "service" }, { "disabled": false, "description": { "content": "(Required) Store webhook token", "type": "text/plain" }, "type": "any", "value": "", "key": "token" } ], "raw": "{{baseUrl}}/api/v1/hooks/payment-auth-completed/:service/:token" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": true,\n \"key_1\": 47.50437963360277\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] }, { "name": "identity-verification-updated", "description": "", "item": [ { "name": "{service}", "description": "", "item": [ { "name": "{token}", "description": "", "item": [ { "id": "57beed7a-06a6-40cb-bcdb-b6117dc703f5", "name": "Identity verification updated webhook", "request": { "name": "Identity verification updated webhook", "description": { "content": "Inbound webhook triggered when an identity verification transaction\nstatus is updated by the verification provider.\n\n**Auth pipeline**: `store_hook` (token-based)\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "hooks", "identity-verification-updated", ":service", ":token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "service", "disabled": false, "description": { "content": "(Required) Identity verification service (e.g. \"berbix\")", "type": "text/plain" } }, { "type": "any", "value": "", "key": "token", "disabled": false, "description": { "content": "(Required) Store webhook token", "type": "text/plain" } } ], "raw": "{{baseUrl}}/api/v1/hooks/identity-verification-updated/:service/:token" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": true,\n \"key_1\": 47.50437963360277\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "90f7a38d-b95b-428b-bb43-6d1f60033026", "name": "Webhook processed", "originalRequest": { "url": { "path": [ "api", "v1", "hooks", "identity-verification-updated", ":service", ":token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identity verification service (e.g. \"berbix\")", "type": "text/plain" }, "type": "any", "value": "", "key": "service" }, { "disabled": false, "description": { "content": "(Required) Store webhook token", "type": "text/plain" }, "type": "any", "value": "", "key": "token" } ], "raw": "{{baseUrl}}/api/v1/hooks/identity-verification-updated/:service/:token" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": true,\n \"key_1\": 47.50437963360277\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3600d1ef-0553-4b1c-93d5-59f4a619e010", "name": "Invalid request parameters", "originalRequest": { "url": { "path": [ "api", "v1", "hooks", "identity-verification-updated", ":service", ":token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identity verification service (e.g. \"berbix\")", "type": "text/plain" }, "type": "any", "value": "", "key": "service" }, { "disabled": false, "description": { "content": "(Required) Store webhook token", "type": "text/plain" }, "type": "any", "value": "", "key": "token" } ], "raw": "{{baseUrl}}/api/v1/hooks/identity-verification-updated/:service/:token" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": true,\n \"key_1\": 47.50437963360277\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] }, { "name": "identity-verification-completed", "description": "", "item": [ { "name": "{service}", "description": "", "item": [ { "name": "{token}", "description": "", "item": [ { "id": "63b3f58c-77b8-4812-aba1-ecda65451df4", "name": "Identity verification completed webhook", "request": { "name": "Identity verification completed webhook", "description": { "content": "Inbound webhook triggered when an identity verification transaction\nis fully completed by the verification provider.\n\n**Auth pipeline**: `store_hook` (token-based)\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "hooks", "identity-verification-completed", ":service", ":token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "service", "disabled": false, "description": { "content": "(Required) Identity verification service (e.g. \"berbix\")", "type": "text/plain" } }, { "type": "any", "value": "", "key": "token", "disabled": false, "description": { "content": "(Required) Store webhook token", "type": "text/plain" } } ], "raw": "{{baseUrl}}/api/v1/hooks/identity-verification-completed/:service/:token" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": true,\n \"key_1\": 47.50437963360277\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "4d75891e-ea77-4d7d-aef4-f683598f0a88", "name": "Webhook processed", "originalRequest": { "url": { "path": [ "api", "v1", "hooks", "identity-verification-completed", ":service", ":token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identity verification service (e.g. \"berbix\")", "type": "text/plain" }, "type": "any", "value": "", "key": "service" }, { "disabled": false, "description": { "content": "(Required) Store webhook token", "type": "text/plain" }, "type": "any", "value": "", "key": "token" } ], "raw": "{{baseUrl}}/api/v1/hooks/identity-verification-completed/:service/:token" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": true,\n \"key_1\": 47.50437963360277\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "61d76705-e1bd-4260-9145-5f5a76b80bc6", "name": "Invalid request parameters", "originalRequest": { "url": { "path": [ "api", "v1", "hooks", "identity-verification-completed", ":service", ":token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identity verification service (e.g. \"berbix\")", "type": "text/plain" }, "type": "any", "value": "", "key": "service" }, { "disabled": false, "description": { "content": "(Required) Store webhook token", "type": "text/plain" }, "type": "any", "value": "", "key": "token" } ], "raw": "{{baseUrl}}/api/v1/hooks/identity-verification-completed/:service/:token" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": true,\n \"key_1\": 47.50437963360277\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] } ] } ] }, { "name": "v2", "description": "", "item": [ { "name": "products", "description": "", "item": [ { "name": "{id}", "description": "", "item": [ { "id": "4768bb23-a46e-4e4b-b96f-b97fd57c034d", "name": "Get product detail (v2)", "request": { "name": "Get product detail (v2)", "description": { "content": "Retrieve enriched product details including full variant data, inventory,\nrelationships to brands/categories/images, and detailed pricing.\nPreferred over v1 for product detail pages.\n\n**Auth pipeline**: `jwt_optional_authenticated`\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "products", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Product UUID or slug", "type": "text/plain" } } ], "raw": "{{baseUrl}}/api/v2/products/:id" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "3f2a1484-247e-470f-a63f-b8dbce50f70f", "name": "Enriched product details", "originalRequest": { "url": { "path": [ "api", "v2", "products", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Product UUID or slug", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ], "raw": "{{baseUrl}}/api/v2/products/:id" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"store_products\",\n \"attributes\": {\n \"name\": \"\",\n \"slug\": \"\",\n \"sku\": \"\",\n \"description\": \"\",\n \"external_id\": \"\",\n \"type\": \"\",\n \"strain\": \"\",\n \"flower_type\": \"\",\n \"composition\": \"\",\n \"thc\": \"\",\n \"cbd\": \"\",\n \"min_cbd\": \"\",\n \"potency\": \"\",\n \"terpenoids\": [\n \"\",\n \"\"\n ],\n \"cannabis_weight\": \"\",\n \"size\": \"\",\n \"main_image\": \"\",\n \"in_stock\": \"\",\n \"is_promoted\": \"\",\n \"discount\": \"\",\n \"unit_price\": \"\",\n \"unit_prices\": [\n {\n \"display_name\": \"\",\n \"quantity\": \"\",\n \"price\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"discount_price\": \"\",\n \"savings_per_unit\": \"\"\n },\n {\n \"display_name\": \"\",\n \"quantity\": \"\",\n \"price\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"discount_price\": \"\",\n \"savings_per_unit\": \"\"\n }\n ],\n \"weight_prices\": [\n {\n \"weight\": \"\",\n \"weight_unit\": \"\",\n \"price\": \"\",\n \"original_price\": \"\",\n \"in_stock\": \"\"\n },\n {\n \"weight\": \"\",\n \"weight_unit\": \"\",\n \"price\": \"\",\n \"original_price\": \"\",\n \"in_stock\": \"\"\n }\n ]\n },\n \"relationships\": {\n \"product_brands\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n },\n \"product_categories\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n },\n \"product_images\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n },\n \"global_brands\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n }\n }\n },\n \"included\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6b536c82-9cc1-4ab6-b404-124fae323890", "name": "Resource not found", "originalRequest": { "url": { "path": [ "api", "v2", "products", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Product UUID or slug", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ], "raw": "{{baseUrl}}/api/v2/products/:id" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "categories", "description": "", "item": [ { "id": "bbd106ab-1fc5-4291-9801-b5108b173011", "name": "List product categories (v2)", "request": { "name": "List product categories (v2)", "description": { "content": "Retrieve all available product categories with enriched attributes\nincluding count, position, icon, slug, and parent hierarchy.\n\n**Auth pipeline**: `jwt_optional_authenticated`\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "products", "categories" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v2/products/categories" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "0a783475-cead-462f-8a13-8c649f1d051b", "name": "List of categories with enriched attributes", "originalRequest": { "url": { "path": [ "api", "v2", "products", "categories" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v2/products/categories" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"product_categories\",\n \"attributes\": {\n \"id\": \"\",\n \"name\": \"\",\n \"slug\": \"\",\n \"description\": \"\",\n \"count\": \"\",\n \"position\": \"\",\n \"is_active\": \"\",\n \"icon_url\": \"\",\n \"parent_category_id\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"type\": \"product_categories\",\n \"attributes\": {\n \"id\": \"\",\n \"name\": \"\",\n \"slug\": \"\",\n \"description\": \"\",\n \"count\": \"\",\n \"position\": \"\",\n \"is_active\": \"\",\n \"icon_url\": \"\",\n \"parent_category_id\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "filters", "description": "", "item": [ { "id": "f1aa9515-71ea-43a1-be1f-7e9f2a22aaf4", "name": "Get filter catalog (v2)", "request": { "name": "Get filter catalog (v2)", "description": { "content": "Retrieve the full filter catalog for the store's products.\nReturns price ranges, weight options, THC/CBD ranges, on-sale count,\nand relationships to types, tags, categories, and brands\n(sideloaded in `included`).\n\n**Auth pipeline**: `jwt_optional_authenticated`\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "products", "filters" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v2/products/filters" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "ed77d526-9b69-406e-97c2-776dfba4798f", "name": "Filter catalog with relationships and included resources", "originalRequest": { "url": { "path": [ "api", "v2", "products", "filters" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v2/products/filters" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"filters\",\n \"attributes\": {\n \"price_ranges\": {\n \"min\": \"\",\n \"max\": \"\"\n },\n \"weights\": [\n \"\",\n \"\"\n ],\n \"thc_ranges\": {\n \"min\": \"\",\n \"max\": \"\",\n \"unit\": \"\"\n },\n \"cbd_ranges\": {\n \"min\": \"\",\n \"max\": \"\",\n \"unit\": \"\"\n },\n \"on_sale\": {\n \"count\": \"\"\n }\n },\n \"relationships\": {\n \"types\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n },\n \"categories\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n },\n \"brands\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n }\n }\n },\n \"included\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n },\n \"key_1\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "brands", "description": "", "item": [ { "id": "b15a046a-9308-45cb-a1bf-5a06085c7084", "name": "List product brands (v2)", "request": { "name": "List product brands (v2)", "description": { "content": "Retrieve all available product brands with enriched attributes\nincluding count, slug, logo, and promoted status.\n\n**Auth pipeline**: `jwt_optional_authenticated`\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "products", "brands" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v2/products/brands" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "20dd6e03-9113-45e1-b6da-2a47292aa4a8", "name": "List of brands with enriched attributes", "originalRequest": { "url": { "path": [ "api", "v2", "products", "brands" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v2/products/brands" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"product_brands\",\n \"attributes\": {\n \"id\": \"\",\n \"name\": \"\",\n \"slug\": \"\",\n \"description\": \"\",\n \"external_id\": \"\",\n \"logo_url\": \"\",\n \"count\": \"\",\n \"is_promoted\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"type\": \"product_brands\",\n \"attributes\": {\n \"id\": \"\",\n \"name\": \"\",\n \"slug\": \"\",\n \"description\": \"\",\n \"external_id\": \"\",\n \"logo_url\": \"\",\n \"count\": \"\",\n \"is_promoted\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "orders", "description": "", "item": [ { "name": "{uuid}", "description": "", "item": [ { "name": "refresh-status", "description": "", "item": [ { "id": "778486f7-03e0-437f-92ed-455d08313a7b", "name": "Refresh order status", "request": { "name": "Refresh order status", "description": { "content": "Refresh the order status by syncing with the POS system.\nUse this to get the latest order state when the POS may have\nupdated it externally.\n\n**Auth pipeline**: `jwt_authenticated` (requires login)\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "orders", ":uuid", "refresh-status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "uuid", "disabled": false, "description": { "content": "(Required) Order UUID", "type": "text/plain" } } ], "raw": "{{baseUrl}}/api/v2/orders/:uuid/refresh-status" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "PATCH", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "f6d8c110-29d2-4512-8f16-09e4be3c8852", "name": "Refreshed order status", "originalRequest": { "url": { "path": [ "api", "v2", "orders", ":uuid", "refresh-status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Order UUID", "type": "text/plain" }, "type": "any", "value": "", "key": "uuid" } ], "raw": "{{baseUrl}}/api/v2/orders/:uuid/refresh-status" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"orders\",\n \"attributes\": {\n \"status\": \"\",\n \"order_number\": \"\",\n \"subtotal\": \"\",\n \"total\": \"\",\n \"tax\": \"\",\n \"discount\": \"\",\n \"delivery_fee\": \"\",\n \"delivery_type\": \"\",\n \"delivery_date\": \"\",\n \"delivery_time_slot\": \"\",\n \"notes\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9bec362a-5e06-4bab-8420-f8008db54db7", "name": "Missing or invalid authentication token", "originalRequest": { "url": { "path": [ "api", "v2", "orders", ":uuid", "refresh-status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Order UUID", "type": "text/plain" }, "type": "any", "value": "", "key": "uuid" } ], "raw": "{{baseUrl}}/api/v2/orders/:uuid/refresh-status" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2c53e001-667e-4f41-b896-f41628b8a592", "name": "Resource not found", "originalRequest": { "url": { "path": [ "api", "v2", "orders", ":uuid", "refresh-status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Order UUID", "type": "text/plain" }, "type": "any", "value": "", "key": "uuid" } ], "raw": "{{baseUrl}}/api/v2/orders/:uuid/refresh-status" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] }, { "name": "store", "description": "", "item": [ { "name": "payments", "description": "", "item": [ { "name": "sources", "description": "", "item": [ { "id": "e67017cd-4fb2-4dd9-83e3-a0060372dde1", "name": "List payment sources (v2, unified)", "request": { "name": "List payment sources (v2, unified)", "description": { "content": "List all saved payment sources across all payment services for the authenticated user.\nUnified view \u2014 does not require a service path parameter.\n\n**Auth pipeline**: `jwt_authenticated`\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "store", "payments", "sources" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v2/store/payments/sources" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "3f3a88b8-f0d4-4da2-b756-ce0d8c965d92", "name": "Unified list of payment sources across all services", "originalRequest": { "url": { "path": [ "api", "v2", "store", "payments", "sources" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v2/store/payments/sources" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b9165721-dea3-44ef-9759-1cf1653dc937", "name": "Missing or invalid authentication token", "originalRequest": { "url": { "path": [ "api", "v2", "store", "payments", "sources" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v2/store/payments/sources" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] } ] }, { "name": "v5", "description": "", "item": [ { "name": "carts", "description": "", "item": [ { "id": "01d29367-efbb-4f1a-9460-a3b25e8a075a", "name": "Create cart", "request": { "name": "Create cart", "description": { "content": "Create a new shopping cart with the first item.\nThe cart is associated with the store and optionally with an authenticated user.\nAlso available as `POST /api/v4/carts` (v4).\n\n**Auth pipeline**: `jwt_optional_authenticated`\n", "type": "text/plain" }, "url": { "path": [ "api", "v5", "carts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v5/carts" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"carts\",\n \"attributes\": {\n \"item\": {\n \"product_id\": \"\",\n \"quantity\": \"\",\n \"weight\": \"\"\n },\n \"delivery_specification\": null,\n \"inventory_type\": \"\",\n \"conversion_breadcrumb\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "noauth" } }, "response": [ { "id": "ed12009f-15fa-403e-beba-2f92175834aa", "name": "Cart created with the first item", "originalRequest": { "url": { "path": [ "api", "v5", "carts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v5/carts" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"carts\",\n \"attributes\": {\n \"item\": {\n \"product_id\": \"\",\n \"quantity\": \"\",\n \"weight\": \"\"\n },\n \"delivery_specification\": null,\n \"inventory_type\": \"\",\n \"conversion_breadcrumb\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"carts\",\n \"attributes\": {\n \"status\": \"\",\n \"delivery_type\": \"\",\n \"promo_codes\": [\n \"\",\n \"\"\n ],\n \"reward_id\": \"\",\n \"subtotal\": \"\",\n \"total\": \"\",\n \"tax\": \"\",\n \"discount\": \"\",\n \"delivery_fee\": \"\",\n \"item_count\": \"\",\n \"delivery_specification\": null\n }\n },\n \"included\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ae6ec942-5ca9-4ab2-aa7f-8cda08e6e062", "name": "Bad Request. Possible error codes:\n- `invalid_item` (404) \u2014 Product is no longer available\n- `out_of_stock` \u2014 Product is out of stock for your location", "originalRequest": { "url": { "path": [ "api", "v5", "carts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v5/carts" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"carts\",\n \"attributes\": {\n \"item\": {\n \"product_id\": \"\",\n \"quantity\": \"\",\n \"weight\": \"\"\n },\n \"delivery_specification\": null,\n \"inventory_type\": \"\",\n \"conversion_breadcrumb\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{uuid}", "description": "", "item": [ { "id": "ddbe787e-531e-42dd-8027-611ac797c1b6", "name": "Show cart", "request": { "name": "Show cart", "description": { "content": "Retrieve the current state of a cart including items, totals, and applied promotions.\nAlso available as `GET /api/v4/carts/{uuid}` (v4).\n\n**Auth pipeline**: `jwt_optional_authenticated`\n", "type": "text/plain" }, "url": { "path": [ "api", "v5", "carts", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "uuid", "disabled": false, "description": { "content": "(Required) Cart UUID", "type": "text/plain" } } ], "raw": "{{baseUrl}}/api/v5/carts/:uuid" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {}, "auth": { "type": "noauth" } }, "response": [ { "id": "5736c705-3af7-4343-a558-228670aed1fe", "name": "Cart details with items", "originalRequest": { "url": { "path": [ "api", "v5", "carts", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Cart UUID", "type": "text/plain" }, "type": "any", "value": "", "key": "uuid" } ], "raw": "{{baseUrl}}/api/v5/carts/:uuid" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"carts\",\n \"attributes\": {\n \"status\": \"\",\n \"delivery_type\": \"\",\n \"promo_codes\": [\n \"\",\n \"\"\n ],\n \"reward_id\": \"\",\n \"subtotal\": \"\",\n \"total\": \"\",\n \"tax\": \"\",\n \"discount\": \"\",\n \"delivery_fee\": \"\",\n \"item_count\": \"\",\n \"delivery_specification\": {\n \"key_0\": false\n }\n },\n \"relationships\": {\n \"cart_items\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n }\n }\n },\n \"included\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n },\n \"key_1\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0dd8a14d-9347-4e23-a4ed-6d712142375d", "name": "Resource not found", "originalRequest": { "url": { "path": [ "api", "v5", "carts", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Cart UUID", "type": "text/plain" }, "type": "any", "value": "", "key": "uuid" } ], "raw": "{{baseUrl}}/api/v5/carts/:uuid" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2766d659-3c1e-459a-a3d7-4cf95b8b6b1f", "name": "Update cart", "request": { "name": "Update cart", "description": { "content": "Update cart-level attributes such as promo codes and rewards.\nAlso available as `PUT /api/v4/carts/{uuid}` (v4).\n\n**Auth pipeline**: `jwt_optional_authenticated`\n", "type": "text/plain" }, "url": { "path": [ "api", "v5", "carts", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "uuid", "disabled": false, "description": { "content": "(Required) Cart UUID", "type": "text/plain" } } ], "raw": "{{baseUrl}}/api/v5/carts/:uuid" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"carts\",\n \"attributes\": {\n \"promo_codes\": [\n \"\",\n \"\"\n ],\n \"reward_id\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "noauth" } }, "response": [ { "id": "8d980f6b-ddac-42a5-afbb-41c31270d050", "name": "Updated cart", "originalRequest": { "url": { "path": [ "api", "v5", "carts", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Cart UUID", "type": "text/plain" }, "type": "any", "value": "", "key": "uuid" } ], "raw": "{{baseUrl}}/api/v5/carts/:uuid" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"carts\",\n \"attributes\": {\n \"promo_codes\": [\n \"\",\n \"\"\n ],\n \"reward_id\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"carts\",\n \"attributes\": {\n \"status\": \"\",\n \"delivery_type\": \"\",\n \"promo_codes\": [\n \"\",\n \"\"\n ],\n \"reward_id\": \"\",\n \"subtotal\": \"\",\n \"total\": \"\",\n \"tax\": \"\",\n \"discount\": \"\",\n \"delivery_fee\": \"\",\n \"item_count\": \"\",\n \"delivery_specification\": null\n }\n },\n \"included\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "940fecfe-f433-4a60-85d3-6fadfb9e5e40", "name": "Bad Request. Possible error codes:\n- `invalid_promo_code` \u2014 Coupon code does not exist\n- `duplicate_promo_code` \u2014 Coupon already applied", "originalRequest": { "url": { "path": [ "api", "v5", "carts", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Cart UUID", "type": "text/plain" }, "type": "any", "value": "", "key": "uuid" } ], "raw": "{{baseUrl}}/api/v5/carts/:uuid" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"carts\",\n \"attributes\": {\n \"promo_codes\": [\n \"\",\n \"\"\n ],\n \"reward_id\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9783cc35-4ab9-4f85-b70d-d9703d136261", "name": "Resource not found", "originalRequest": { "url": { "path": [ "api", "v5", "carts", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Cart UUID", "type": "text/plain" }, "type": "any", "value": "", "key": "uuid" } ], "raw": "{{baseUrl}}/api/v5/carts/:uuid" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"carts\",\n \"attributes\": {\n \"promo_codes\": [\n \"\",\n \"\"\n ],\n \"reward_id\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "{cart_uuid}", "description": "", "item": [ { "name": "items", "description": "", "item": [ { "id": "25e4c8f3-9b9c-4e58-9dec-5a6602588704", "name": "Add item to cart", "request": { "name": "Add item to cart", "description": { "content": "Add a new item to an existing cart.\nAlso available as `POST /api/v4/carts/{cart_uuid}/items` (v4).\n\n**Auth pipeline**: `jwt_optional_authenticated`\n", "type": "text/plain" }, "url": { "path": [ "api", "v5", "carts", ":cart_uuid", "items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "cart_uuid", "disabled": false, "description": { "content": "(Required) Cart UUID", "type": "text/plain" } } ], "raw": "{{baseUrl}}/api/v5/carts/:cart_uuid/items" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"cart_items\",\n \"attributes\": {\n \"product_id\": \"\",\n \"quantity\": \"\",\n \"weight\": \"\"\n },\n \"id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "noauth" } }, "response": [ { "id": "12f2c5ef-0fbb-4c0b-b23a-54e4ace51adb", "name": "Item added to cart", "originalRequest": { "url": { "path": [ "api", "v5", "carts", ":cart_uuid", "items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Cart UUID", "type": "text/plain" }, "type": "any", "value": "", "key": "cart_uuid" } ], "raw": "{{baseUrl}}/api/v5/carts/:cart_uuid/items" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"cart_items\",\n \"attributes\": {\n \"product_id\": \"\",\n \"quantity\": \"\",\n \"weight\": \"\"\n },\n \"id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"carts\",\n \"attributes\": {\n \"status\": \"\",\n \"delivery_type\": \"\",\n \"promo_codes\": [\n \"\",\n \"\"\n ],\n \"reward_id\": \"\",\n \"subtotal\": \"\",\n \"total\": \"\",\n \"tax\": \"\",\n \"discount\": \"\",\n \"delivery_fee\": \"\",\n \"item_count\": \"\",\n \"delivery_specification\": null\n }\n },\n \"included\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4a9b0e76-c141-4283-92ec-eb91b56ec57f", "name": "Bad Request. Possible error codes:\n- `invalid_item` (404) \u2014 Product is no longer available\n- `out_of_stock` \u2014 Product is out of stock", "originalRequest": { "url": { "path": [ "api", "v5", "carts", ":cart_uuid", "items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Cart UUID", "type": "text/plain" }, "type": "any", "value": "", "key": "cart_uuid" } ], "raw": "{{baseUrl}}/api/v5/carts/:cart_uuid/items" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"cart_items\",\n \"attributes\": {\n \"product_id\": \"\",\n \"quantity\": \"\",\n \"weight\": \"\"\n },\n \"id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9f15b46b-c947-40c5-8467-7d79a1924832", "name": "Resource not found", "originalRequest": { "url": { "path": [ "api", "v5", "carts", ":cart_uuid", "items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Cart UUID", "type": "text/plain" }, "type": "any", "value": "", "key": "cart_uuid" } ], "raw": "{{baseUrl}}/api/v5/carts/:cart_uuid/items" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"cart_items\",\n \"attributes\": {\n \"product_id\": \"\",\n \"quantity\": \"\",\n \"weight\": \"\"\n },\n \"id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{item_uuid}", "description": "", "item": [ { "id": "6d82edca-2428-40e5-a24c-3f6c8289219c", "name": "Update item quantity", "request": { "name": "Update item quantity", "description": { "content": "Update an existing cart item (e.g. change quantity).\nAlso available as `PATCH /api/v4/carts/{cart_uuid}/items/{item_uuid}` (v4).\n\n**Auth pipeline**: `jwt_optional_authenticated`\n", "type": "text/plain" }, "url": { "path": [ "api", "v5", "carts", ":cart_uuid", "items", ":item_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "cart_uuid", "disabled": false, "description": { "content": "(Required) Cart UUID", "type": "text/plain" } }, { "type": "any", "value": "", "key": "item_uuid", "disabled": false, "description": { "content": "(Required) Cart item UUID", "type": "text/plain" } } ], "raw": "{{baseUrl}}/api/v5/carts/:cart_uuid/items/:item_uuid" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"cart_items\",\n \"attributes\": {\n \"product_id\": \"\",\n \"quantity\": \"\",\n \"weight\": \"\"\n },\n \"id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "noauth" } }, "response": [ { "id": "aa8ee107-8275-4d95-a6ac-ba33fdb4f33a", "name": "Cart item updated", "originalRequest": { "url": { "path": [ "api", "v5", "carts", ":cart_uuid", "items", ":item_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Cart UUID", "type": "text/plain" }, "type": "any", "value": "", "key": "cart_uuid" }, { "disabled": false, "description": { "content": "(Required) Cart item UUID", "type": "text/plain" }, "type": "any", "value": "", "key": "item_uuid" } ], "raw": "{{baseUrl}}/api/v5/carts/:cart_uuid/items/:item_uuid" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"cart_items\",\n \"attributes\": {\n \"product_id\": \"\",\n \"quantity\": \"\",\n \"weight\": \"\"\n },\n \"id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"carts\",\n \"attributes\": {\n \"status\": \"\",\n \"delivery_type\": \"\",\n \"promo_codes\": [\n \"\",\n \"\"\n ],\n \"reward_id\": \"\",\n \"subtotal\": \"\",\n \"total\": \"\",\n \"tax\": \"\",\n \"discount\": \"\",\n \"delivery_fee\": \"\",\n \"item_count\": \"\",\n \"delivery_specification\": null\n }\n },\n \"included\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d5bb5560-3d7f-4038-bff0-e109913454ce", "name": "Invalid request parameters", "originalRequest": { "url": { "path": [ "api", "v5", "carts", ":cart_uuid", "items", ":item_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Cart UUID", "type": "text/plain" }, "type": "any", "value": "", "key": "cart_uuid" }, { "disabled": false, "description": { "content": "(Required) Cart item UUID", "type": "text/plain" }, "type": "any", "value": "", "key": "item_uuid" } ], "raw": "{{baseUrl}}/api/v5/carts/:cart_uuid/items/:item_uuid" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"cart_items\",\n \"attributes\": {\n \"product_id\": \"\",\n \"quantity\": \"\",\n \"weight\": \"\"\n },\n \"id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4cd72975-9f78-435c-8120-dffab1aef09c", "name": "Resource not found", "originalRequest": { "url": { "path": [ "api", "v5", "carts", ":cart_uuid", "items", ":item_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Cart UUID", "type": "text/plain" }, "type": "any", "value": "", "key": "cart_uuid" }, { "disabled": false, "description": { "content": "(Required) Cart item UUID", "type": "text/plain" }, "type": "any", "value": "", "key": "item_uuid" } ], "raw": "{{baseUrl}}/api/v5/carts/:cart_uuid/items/:item_uuid" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"cart_items\",\n \"attributes\": {\n \"product_id\": \"\",\n \"quantity\": \"\",\n \"weight\": \"\"\n },\n \"id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "be38e66e-2455-484d-b45a-5f34d4c91f72", "name": "Update item", "request": { "name": "Update item", "description": { "content": "Replace/update an existing cart item fully.\nAlso available as `PUT /api/v4/carts/{cart_uuid}/items/{item_uuid}` (v4).\n\n**Auth pipeline**: `jwt_optional_authenticated`\n", "type": "text/plain" }, "url": { "path": [ "api", "v5", "carts", ":cart_uuid", "items", ":item_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "cart_uuid", "disabled": false, "description": { "content": "(Required) Cart UUID", "type": "text/plain" } }, { "type": "any", "value": "", "key": "item_uuid", "disabled": false, "description": { "content": "(Required) Cart item UUID", "type": "text/plain" } } ], "raw": "{{baseUrl}}/api/v5/carts/:cart_uuid/items/:item_uuid" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"cart_items\",\n \"attributes\": {\n \"product_id\": \"\",\n \"quantity\": \"\",\n \"weight\": \"\"\n },\n \"id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "noauth" } }, "response": [ { "id": "e53731fd-fe1c-4749-9867-d013aa61ce07", "name": "Cart item replaced", "originalRequest": { "url": { "path": [ "api", "v5", "carts", ":cart_uuid", "items", ":item_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Cart UUID", "type": "text/plain" }, "type": "any", "value": "", "key": "cart_uuid" }, { "disabled": false, "description": { "content": "(Required) Cart item UUID", "type": "text/plain" }, "type": "any", "value": "", "key": "item_uuid" } ], "raw": "{{baseUrl}}/api/v5/carts/:cart_uuid/items/:item_uuid" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"cart_items\",\n \"attributes\": {\n \"product_id\": \"\",\n \"quantity\": \"\",\n \"weight\": \"\"\n },\n \"id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"carts\",\n \"attributes\": {\n \"status\": \"\",\n \"delivery_type\": \"\",\n \"promo_codes\": [\n \"\",\n \"\"\n ],\n \"reward_id\": \"\",\n \"subtotal\": \"\",\n \"total\": \"\",\n \"tax\": \"\",\n \"discount\": \"\",\n \"delivery_fee\": \"\",\n \"item_count\": \"\",\n \"delivery_specification\": null\n }\n },\n \"included\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "572653d3-5a72-450c-8f89-cf1bfc72a401", "name": "Invalid request parameters", "originalRequest": { "url": { "path": [ "api", "v5", "carts", ":cart_uuid", "items", ":item_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Cart UUID", "type": "text/plain" }, "type": "any", "value": "", "key": "cart_uuid" }, { "disabled": false, "description": { "content": "(Required) Cart item UUID", "type": "text/plain" }, "type": "any", "value": "", "key": "item_uuid" } ], "raw": "{{baseUrl}}/api/v5/carts/:cart_uuid/items/:item_uuid" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"cart_items\",\n \"attributes\": {\n \"product_id\": \"\",\n \"quantity\": \"\",\n \"weight\": \"\"\n },\n \"id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d05730bd-5ad3-47fd-938b-ff0c48e1ffbc", "name": "Resource not found", "originalRequest": { "url": { "path": [ "api", "v5", "carts", ":cart_uuid", "items", ":item_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Cart UUID", "type": "text/plain" }, "type": "any", "value": "", "key": "cart_uuid" }, { "disabled": false, "description": { "content": "(Required) Cart item UUID", "type": "text/plain" }, "type": "any", "value": "", "key": "item_uuid" } ], "raw": "{{baseUrl}}/api/v5/carts/:cart_uuid/items/:item_uuid" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"cart_items\",\n \"attributes\": {\n \"product_id\": \"\",\n \"quantity\": \"\",\n \"weight\": \"\"\n },\n \"id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dfedd463-3315-4651-9d2d-f1b4c2961786", "name": "Remove item from cart", "request": { "name": "Remove item from cart", "description": { "content": "Remove an item from the cart.\nAlso available as `DELETE /api/v4/carts/{cart_uuid}/items/{item_uuid}` (v4).\n\n**Auth pipeline**: `jwt_optional_authenticated`\n", "type": "text/plain" }, "url": { "path": [ "api", "v5", "carts", ":cart_uuid", "items", ":item_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "cart_uuid", "disabled": false, "description": { "content": "(Required) Cart UUID", "type": "text/plain" } }, { "type": "any", "value": "", "key": "item_uuid", "disabled": false, "description": { "content": "(Required) Cart item UUID", "type": "text/plain" } } ], "raw": "{{baseUrl}}/api/v5/carts/:cart_uuid/items/:item_uuid" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "DELETE", "body": {}, "auth": { "type": "noauth" } }, "response": [ { "id": "5542db26-63a0-456e-a78a-1bec66ee39d8", "name": "Item removed \u2014 returns updated cart", "originalRequest": { "url": { "path": [ "api", "v5", "carts", ":cart_uuid", "items", ":item_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Cart UUID", "type": "text/plain" }, "type": "any", "value": "", "key": "cart_uuid" }, { "disabled": false, "description": { "content": "(Required) Cart item UUID", "type": "text/plain" }, "type": "any", "value": "", "key": "item_uuid" } ], "raw": "{{baseUrl}}/api/v5/carts/:cart_uuid/items/:item_uuid" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"carts\",\n \"attributes\": {\n \"status\": \"\",\n \"delivery_type\": \"\",\n \"promo_codes\": [\n \"\",\n \"\"\n ],\n \"reward_id\": \"\",\n \"subtotal\": \"\",\n \"total\": \"\",\n \"tax\": \"\",\n \"discount\": \"\",\n \"delivery_fee\": \"\",\n \"item_count\": \"\",\n \"delivery_specification\": null\n }\n },\n \"included\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6f7509cd-7c6e-4bae-8ab0-1631489579be", "name": "Resource not found", "originalRequest": { "url": { "path": [ "api", "v5", "carts", ":cart_uuid", "items", ":item_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Cart UUID", "type": "text/plain" }, "type": "any", "value": "", "key": "cart_uuid" }, { "disabled": false, "description": { "content": "(Required) Cart item UUID", "type": "text/plain" }, "type": "any", "value": "", "key": "item_uuid" } ], "raw": "{{baseUrl}}/api/v5/carts/:cart_uuid/items/:item_uuid" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "valid", "description": "", "item": [ { "id": "8383282b-4f49-4bb1-abab-754caaafec3b", "name": "Validate cart", "request": { "name": "Validate cart", "description": { "content": "Validate the cart before checkout. Checks item availability, promo code validity,\nreward applicability, and delivery constraints. Returns the validated cart with\nupdated totals or error details for invalid items.\nAlso available as `POST /api/v4/carts/{cart_uuid}/valid` (v4).\n\n**Auth pipeline**: `jwt_optional_authenticated`\n", "type": "text/plain" }, "url": { "path": [ "api", "v5", "carts", ":cart_uuid", "valid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "cart_uuid", "disabled": false, "description": { "content": "(Required) Cart UUID", "type": "text/plain" } } ], "raw": "{{baseUrl}}/api/v5/carts/:cart_uuid/valid" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"carts\",\n \"attributes\": {\n \"promo_codes\": [\n \"\",\n \"\"\n ],\n \"reward_id\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "noauth" } }, "response": [ { "id": "2f14f394-f71c-4423-8edf-ef3bc9f19bd7", "name": "Cart validated successfully", "originalRequest": { "url": { "path": [ "api", "v5", "carts", ":cart_uuid", "valid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Cart UUID", "type": "text/plain" }, "type": "any", "value": "", "key": "cart_uuid" } ], "raw": "{{baseUrl}}/api/v5/carts/:cart_uuid/valid" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"carts\",\n \"attributes\": {\n \"promo_codes\": [\n \"\",\n \"\"\n ],\n \"reward_id\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"carts\",\n \"attributes\": {\n \"status\": \"\",\n \"delivery_type\": \"\",\n \"promo_codes\": [\n \"\",\n \"\"\n ],\n \"reward_id\": \"\",\n \"subtotal\": \"\",\n \"total\": \"\",\n \"tax\": \"\",\n \"discount\": \"\",\n \"delivery_fee\": \"\",\n \"item_count\": \"\",\n \"delivery_specification\": null\n }\n },\n \"included\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "976ec2bc-1833-48f6-a3bc-dab58995aaf1", "name": "Bad Request. Possible error codes:\n- `empty_cart` \u2014 The cart is empty\n- `invalid_cart` \u2014 Cart has invalid items\n- `under_order_minimum` \u2014 Cart total is below minimum\n- `cannabis_weight_limit_exceeded` \u2014 Cannabis weight limit exceeded", "originalRequest": { "url": { "path": [ "api", "v5", "carts", ":cart_uuid", "valid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Cart UUID", "type": "text/plain" }, "type": "any", "value": "", "key": "cart_uuid" } ], "raw": "{{baseUrl}}/api/v5/carts/:cart_uuid/valid" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"carts\",\n \"attributes\": {\n \"promo_codes\": [\n \"\",\n \"\"\n ],\n \"reward_id\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b659e3d9-8bcf-465d-b214-4c7620415a21", "name": "Resource not found", "originalRequest": { "url": { "path": [ "api", "v5", "carts", ":cart_uuid", "valid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Cart UUID", "type": "text/plain" }, "type": "any", "value": "", "key": "cart_uuid" } ], "raw": "{{baseUrl}}/api/v5/carts/:cart_uuid/valid" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"carts\",\n \"attributes\": {\n \"promo_codes\": [\n \"\",\n \"\"\n ],\n \"reward_id\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] }, { "name": "orders", "description": "", "item": [ { "id": "52fb1882-adbd-49cd-a806-ea634761d385", "name": "Submit cart for asynchronous checkout", "request": { "name": "Submit cart for asynchronous checkout", "description": { "content": "**Access**: restricted to certified partners. Uncertified integrations should use the\n[Checkout Handoff](/guides/checkout-handoff) instead.\n\n> **This is not a drop-in alternative to `POST /api/v4/orders`.** Despite the path, v5\n> does not return an order. It enqueues the cart for background submission and returns\n> the **cart** resource with a `submission_status`. Most integrations should use\n> [`POST /api/v4/orders`](/api#tag/Orders/post/api/v4/orders), which creates the order\n> synchronously and returns it.\n\nEnqueues a validated cart for asynchronous submission to the POS. Responds `200` with a\n`carts` resource whose `submission_status` is `pending`.\n\nTo obtain the resulting order, poll\n[`GET /api/v5/carts/{uuid}`](/api#tag/Cart/get/api/v5/carts/{uuid}) until\n`submission_status` becomes:\n\n- `done` \u2014 the `order` relationship is populated; fetch it via\n [`GET /api/v1/orders/{uuid}`](/api#tag/Orders/get/api/v1/orders/{uuid})\n- `failed` \u2014 inspect `submission_errors` on the cart\n\nIntermediate states are `pending` and `processing`.\n\n**Auth pipeline**: `jwt_optional_authenticated`\n", "type": "text/plain" }, "url": { "path": [ "api", "v5", "orders" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v5/orders" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"orders\",\n \"attributes\": {\n \"cart_uuid\": \"\",\n \"notes\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "noauth" } }, "response": [ { "id": "36eddbfb-cd4c-43c9-baed-f8892d4f770d", "name": "Cart accepted for submission. Note this is the **cart**, not the order \u2014 poll the cart\nuntil `submission_status` is `done`, then read its `order` relationship.", "originalRequest": { "url": { "path": [ "api", "v5", "orders" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v5/orders" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"orders\",\n \"attributes\": {\n \"cart_uuid\": \"\",\n \"notes\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"carts\",\n \"attributes\": {\n \"submission_status\": \"processing\",\n \"submission_pending_at\": \"\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5ee82a5d-d3bf-4b07-813f-09ef6d36ab48", "name": "Bad Request. Possible error codes:\n- `empty_cart` \u2014 The cart is empty\n- `failed_to_submit_cart` \u2014 Unexpected problem submitting the cart", "originalRequest": { "url": { "path": [ "api", "v5", "orders" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v5/orders" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"orders\",\n \"attributes\": {\n \"cart_uuid\": \"\",\n \"notes\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d042ceae-ce13-4844-9b50-d90c2bc7236b", "name": "Missing or invalid authentication token", "originalRequest": { "url": { "path": [ "api", "v5", "orders" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v5/orders" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"orders\",\n \"attributes\": {\n \"cart_uuid\": \"\",\n \"notes\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "v4", "description": "", "item": [ { "name": "carts", "description": "", "item": [ { "name": "{cart_uuid}", "description": "", "item": [ { "name": "delivery-specification", "description": "", "item": [ { "id": "73f2554c-ab8b-4dc5-a4a8-6df91fdb579f", "name": "Set delivery specification", "request": { "name": "Set delivery specification", "description": { "content": "Set or replace the delivery specification on a cart. Includes delivery type,\naddress, scheduled date/time, and related delivery configuration.\n\n**Auth pipeline**: `jwt_optional_authenticated`\n", "type": "text/plain" }, "url": { "path": [ "api", "v4", "carts", ":cart_uuid", "delivery-specification" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "cart_uuid", "disabled": false, "description": { "content": "(Required) Cart UUID", "type": "text/plain" } } ], "raw": "{{baseUrl}}/api/v4/carts/:cart_uuid/delivery-specification" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"carts\",\n \"attributes\": {\n \"delivery_specification\": {\n \"type\": \"kiosk\",\n \"mode\": \"asap\",\n \"address\": {\n \"address\": \"\",\n \"address_line2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\",\n \"country\": \"US\",\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"scheduled_start_time\": \"\",\n \"scheduled_end_time\": \"\",\n \"delivery_inventories\": null\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "noauth" } }, "response": [ { "id": "9193341a-0a04-407a-8d40-bc4d49300287", "name": "Delivery specification set", "originalRequest": { "url": { "path": [ "api", "v4", "carts", ":cart_uuid", "delivery-specification" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Cart UUID", "type": "text/plain" }, "type": "any", "value": "", "key": "cart_uuid" } ], "raw": "{{baseUrl}}/api/v4/carts/:cart_uuid/delivery-specification" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"carts\",\n \"attributes\": {\n \"delivery_specification\": {\n \"type\": \"kiosk\",\n \"mode\": \"asap\",\n \"address\": {\n \"address\": \"\",\n \"address_line2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\",\n \"country\": \"US\",\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"scheduled_start_time\": \"\",\n \"scheduled_end_time\": \"\",\n \"delivery_inventories\": null\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"carts\",\n \"attributes\": {\n \"status\": \"\",\n \"delivery_type\": \"\",\n \"promo_codes\": [\n \"\",\n \"\"\n ],\n \"reward_id\": \"\",\n \"subtotal\": \"\",\n \"total\": \"\",\n \"tax\": \"\",\n \"discount\": \"\",\n \"delivery_fee\": \"\",\n \"item_count\": \"\",\n \"delivery_specification\": null\n }\n },\n \"included\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac86f7db-5179-4e21-abaf-9a3eb99bb920", "name": "Bad Request. Possible error codes:\n- `missing_address` \u2014 Address is required\n- `missing_zip_code` \u2014 Zip code is required\n- `invalid_zip_code` \u2014 Zip code is invalid for the given country\n- `geo_data_required` \u2014 Geo location data required for this delivery mode\n- `zip_code_required` \u2014 Zip code is required for this delivery mode\n- `no_deliveries_at_location` \u2014 Address is outside all delivery zones\n- `no_delivery_fee` \u2014 No delivery fee could be calculated for this location", "originalRequest": { "url": { "path": [ "api", "v4", "carts", ":cart_uuid", "delivery-specification" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Cart UUID", "type": "text/plain" }, "type": "any", "value": "", "key": "cart_uuid" } ], "raw": "{{baseUrl}}/api/v4/carts/:cart_uuid/delivery-specification" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"carts\",\n \"attributes\": {\n \"delivery_specification\": {\n \"type\": \"kiosk\",\n \"mode\": \"asap\",\n \"address\": {\n \"address\": \"\",\n \"address_line2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\",\n \"country\": \"US\",\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"scheduled_start_time\": \"\",\n \"scheduled_end_time\": \"\",\n \"delivery_inventories\": null\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f76dfb35-ece1-441d-b61b-3b02713b83ea", "name": "Resource not found", "originalRequest": { "url": { "path": [ "api", "v4", "carts", ":cart_uuid", "delivery-specification" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Cart UUID", "type": "text/plain" }, "type": "any", "value": "", "key": "cart_uuid" } ], "raw": "{{baseUrl}}/api/v4/carts/:cart_uuid/delivery-specification" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"carts\",\n \"attributes\": {\n \"delivery_specification\": {\n \"type\": \"kiosk\",\n \"mode\": \"asap\",\n \"address\": {\n \"address\": \"\",\n \"address_line2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\",\n \"country\": \"US\",\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"scheduled_start_time\": \"\",\n \"scheduled_end_time\": \"\",\n \"delivery_inventories\": null\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c0a7afe7-0a81-44dc-96bc-d5e62ba9f8d4", "name": "Update delivery specification", "request": { "name": "Update delivery specification", "description": { "content": "Partially update the delivery specification on a cart.\n\n**Auth pipeline**: `jwt_optional_authenticated`\n", "type": "text/plain" }, "url": { "path": [ "api", "v4", "carts", ":cart_uuid", "delivery-specification" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "cart_uuid", "disabled": false, "description": { "content": "(Required) Cart UUID", "type": "text/plain" } } ], "raw": "{{baseUrl}}/api/v4/carts/:cart_uuid/delivery-specification" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"carts\",\n \"attributes\": {\n \"delivery_specification\": {\n \"type\": \"kiosk\",\n \"mode\": \"asap\",\n \"address\": {\n \"address\": \"\",\n \"address_line2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\",\n \"country\": \"US\",\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"scheduled_start_time\": \"\",\n \"scheduled_end_time\": \"\",\n \"delivery_inventories\": null\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "noauth" } }, "response": [ { "id": "ea2081e0-5976-4b5f-aff2-15f24fef50ff", "name": "Delivery specification updated", "originalRequest": { "url": { "path": [ "api", "v4", "carts", ":cart_uuid", "delivery-specification" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Cart UUID", "type": "text/plain" }, "type": "any", "value": "", "key": "cart_uuid" } ], "raw": "{{baseUrl}}/api/v4/carts/:cart_uuid/delivery-specification" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"carts\",\n \"attributes\": {\n \"delivery_specification\": {\n \"type\": \"kiosk\",\n \"mode\": \"asap\",\n \"address\": {\n \"address\": \"\",\n \"address_line2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\",\n \"country\": \"US\",\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"scheduled_start_time\": \"\",\n \"scheduled_end_time\": \"\",\n \"delivery_inventories\": null\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"carts\",\n \"attributes\": {\n \"status\": \"\",\n \"delivery_type\": \"\",\n \"promo_codes\": [\n \"\",\n \"\"\n ],\n \"reward_id\": \"\",\n \"subtotal\": \"\",\n \"total\": \"\",\n \"tax\": \"\",\n \"discount\": \"\",\n \"delivery_fee\": \"\",\n \"item_count\": \"\",\n \"delivery_specification\": null\n }\n },\n \"included\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5f469961-ac23-4e22-93e4-e9f3f2e37303", "name": "Invalid request parameters", "originalRequest": { "url": { "path": [ "api", "v4", "carts", ":cart_uuid", "delivery-specification" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Cart UUID", "type": "text/plain" }, "type": "any", "value": "", "key": "cart_uuid" } ], "raw": "{{baseUrl}}/api/v4/carts/:cart_uuid/delivery-specification" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"carts\",\n \"attributes\": {\n \"delivery_specification\": {\n \"type\": \"kiosk\",\n \"mode\": \"asap\",\n \"address\": {\n \"address\": \"\",\n \"address_line2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\",\n \"country\": \"US\",\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"scheduled_start_time\": \"\",\n \"scheduled_end_time\": \"\",\n \"delivery_inventories\": null\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b1a7b1a5-9464-4bc3-9e33-017fce1ac7b8", "name": "Resource not found", "originalRequest": { "url": { "path": [ "api", "v4", "carts", ":cart_uuid", "delivery-specification" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Cart UUID", "type": "text/plain" }, "type": "any", "value": "", "key": "cart_uuid" } ], "raw": "{{baseUrl}}/api/v4/carts/:cart_uuid/delivery-specification" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"carts\",\n \"attributes\": {\n \"delivery_specification\": {\n \"type\": \"kiosk\",\n \"mode\": \"asap\",\n \"address\": {\n \"address\": \"\",\n \"address_line2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\",\n \"country\": \"US\",\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"scheduled_start_time\": \"\",\n \"scheduled_end_time\": \"\",\n \"delivery_inventories\": null\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] }, { "name": "orders", "description": "", "item": [ { "id": "3dfb52c9-8da8-4383-bf6a-8bae55b35043", "name": "Create order (checkout)", "request": { "name": "Create order (checkout)", "description": { "content": "**Access**: restricted to certified partners. Uncertified integrations should use the\n[Checkout Handoff](/guides/checkout-handoff) instead.\n\nConvert a validated cart into an order. This is the checkout endpoint.\nThe cart must have been validated via `POST /api/v5/carts/{cart_uuid}/valid`\nbefore calling this endpoint.\nReturns the created order synchronously.\n\nAn asynchronous variant exists at `POST /api/v5/orders`, which enqueues the\nsubmission and returns the cart instead \u2014 see that endpoint before using it.\n\n**Auth pipeline**: `jwt_optional_authenticated`\n", "type": "text/plain" }, "url": { "path": [ "api", "v4", "orders" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v4/orders" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"orders\",\n \"attributes\": {\n \"cart_uuid\": \"\",\n \"notes\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "noauth" } }, "response": [ { "id": "5e07104d-a893-4c1c-8c7d-f09c3761bb56", "name": "Order created", "originalRequest": { "url": { "path": [ "api", "v4", "orders" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v4/orders" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"orders\",\n \"attributes\": {\n \"cart_uuid\": \"\",\n \"notes\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"orders\",\n \"attributes\": {\n \"status\": \"\",\n \"order_number\": \"\",\n \"subtotal\": \"\",\n \"total\": \"\",\n \"tax\": \"\",\n \"discount\": \"\",\n \"delivery_fee\": \"\",\n \"delivery_type\": \"\",\n \"delivery_date\": \"\",\n \"delivery_time_slot\": \"\",\n \"notes\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n },\n \"included\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n },\n \"key_1\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n },\n \"key_2\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"attributes\": {},\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n },\n \"key_1\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n },\n \"key_2\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d8decfad-ced7-4855-86b3-a62f3ba4e29b", "name": "Bad Request. Possible error codes:\n- `cart_already_submitted` \u2014 Cart has already been submitted\n- `empty_cart` \u2014 The cart is empty\n- `failed_to_submit_cart` \u2014 Unexpected problem submitting the cart", "originalRequest": { "url": { "path": [ "api", "v4", "orders" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v4/orders" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"orders\",\n \"attributes\": {\n \"cart_uuid\": \"\",\n \"notes\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "97544a56-f0da-4a52-8862-7bef596a7c01", "name": "Missing or invalid authentication token", "originalRequest": { "url": { "path": [ "api", "v4", "orders" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v4/orders" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"orders\",\n \"attributes\": {\n \"cart_uuid\": \"\",\n \"notes\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "v3", "description": "", "item": [ { "name": "deliveries", "description": "", "item": [ { "name": "stores", "description": "", "item": [ { "id": "576dad25-215e-4dcf-85e2-f9493877757b", "name": "Get available delivery stores", "request": { "name": "Get available delivery stores", "description": { "content": "Check which stores can deliver to a given address. Returns a list of stores\nthat serve the provided delivery address, optionally filtered by delivery mode\nand preferred inventory types.\nAlso available as `POST /api/v4/deliveries/stores` (v4, with region geo-zone support).\n\n**Auth pipeline**: `jwt_optional_authenticated`\n", "type": "text/plain" }, "url": { "path": [ "api", "v3", "deliveries", "stores" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v3/deliveries/stores" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"addresses\",\n \"attributes\": {\n \"address\": {\n \"address\": \"\",\n \"address_line2\": \"\",\n \"city\": \"\",\n \"country\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\",\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"preferred_inventories\": null,\n \"mode\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "noauth" } }, "response": [ { "id": "210f3b5b-14ac-4acf-97ad-90de142010b0", "name": "List of stores that can deliver to the address. The v3 response returns `stores` resources.\nThe v4 response returns `delivery_stores` resources with additional fields like\n`delivers_to_zip_code`, `open_schedule`, `unavailable_reason`, `alternative_mode`,\nand delivery inventory details.", "originalRequest": { "url": { "path": [ "api", "v3", "deliveries", "stores" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v3/deliveries/stores" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"addresses\",\n \"attributes\": {\n \"address\": {\n \"address\": \"\",\n \"address_line2\": \"\",\n \"city\": \"\",\n \"country\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\",\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"preferred_inventories\": null,\n \"mode\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"stores\",\n \"attributes\": {\n \"name\": \"\",\n \"slug\": \"\",\n \"address\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\",\n \"country\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"phone\": \"\",\n \"email\": \"\",\n \"is_active\": \"\",\n \"point_of_sales\": \"\",\n \"delivery_enabled\": \"\",\n \"pickup_enabled\": \"\",\n \"timezone\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"type\": \"stores\",\n \"attributes\": {\n \"name\": \"\",\n \"slug\": \"\",\n \"address\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\",\n \"country\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"phone\": \"\",\n \"email\": \"\",\n \"is_active\": \"\",\n \"point_of_sales\": \"\",\n \"delivery_enabled\": \"\",\n \"pickup_enabled\": \"\",\n \"timezone\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "75c69b13-d1c9-499d-b880-1f67c4a237ee", "name": "Bad Request. Possible error codes:\n- `missing_zip_code` \u2014 Zip code is required in the address\n- `no_deliveries_at_location` \u2014 No stores deliver to this address\n- `no_delivery_fee` \u2014 No delivery fee could be calculated for this location", "originalRequest": { "url": { "path": [ "api", "v3", "deliveries", "stores" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v3/deliveries/stores" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"addresses\",\n \"attributes\": {\n \"address\": {\n \"address\": \"\",\n \"address_line2\": \"\",\n \"city\": \"\",\n \"country\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\",\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"preferred_inventories\": null,\n \"mode\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "users", "description": "", "item": [ { "name": "me", "description": "", "item": [ { "name": "loyalty", "description": "", "item": [ { "id": "1276b314-4b1c-434c-8341-973342f04a44", "name": "Get loyalty points (v3)", "request": { "name": "Get loyalty points (v3)", "description": { "content": "Retrieve the authenticated user's loyalty points balance and tier.\n\n**Auth pipeline**: `jwt_authenticated`\n\n**Error codes**:\n- `no_loyalty` \u2014 No loyalty provider configured for the store\n", "type": "text/plain" }, "url": { "path": [ "api", "v3", "users", "me", "loyalty" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v3/users/me/loyalty" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "7473c6b8-634e-4eb0-994e-9eba78884f00", "name": "Loyalty information", "originalRequest": { "url": { "path": [ "api", "v3", "users", "me", "loyalty" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v3/users/me/loyalty" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"loyalty\",\n \"attributes\": {\n \"points\": \"\",\n \"tier\": \"\",\n \"lifetime_points\": \"\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "17e832a8-61ad-4295-ba27-fc4254cec6a9", "name": "Possible error codes:\n- `no_loyalty` \u2014 No loyalty provider found for store", "originalRequest": { "url": { "path": [ "api", "v3", "users", "me", "loyalty" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v3/users/me/loyalty" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "48a82dfd-3307-4ba5-8e14-6a6e3612a061", "name": "Missing or invalid authentication token", "originalRequest": { "url": { "path": [ "api", "v3", "users", "me", "loyalty" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/v3/users/me/loyalty" }, "header": [ { "disabled": false, "description": { "content": "(Required) The UUID of the store to scope the request to.\nRequired on all store-scoped endpoints.\n", "type": "text/plain" }, "key": "X-Store", "value": "{{storeId}}" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": false,\n \"key_1\": 942.3073039883611\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"extra_info\": {\n \"key_0\": 6785.692128699735\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] } ] } ] } ], "event": [], "variable": [ { "key": "baseUrl", "value": "https://ecom-api.staging.blaze.me", "type": "string" }, { "key": "storeId", "value": "e87437f2-3e35-4738-af5e-6307e368255c", "type": "string" }, { "key": "token", "value": "", "type": "string", "description": "Bearer token obtained after login. Set this after calling POST Login." }, { "key": "bearerToken", "value": "{{token}}", "type": "string", "description": "Alias for token variable - used by bearer auth. Set 'token' variable instead." } ], "info": { "_postman_id": "6789a419-bdcc-4606-bc42-66d7e79532c3", "name": "Blaze ECOM Storefront API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "The Blaze ECOM Storefront API powers headless ecommerce experiences for cannabis retail.\nIt provides a full suite of commerce capabilities \u2014 products, carts, orders, payments,\nuser accounts, delivery, and recommendations \u2014 designed for building custom storefronts\non any platform.\n\n## Key Concepts\n\n- **JSON:API format**: All requests and responses follow the [JSON:API](https://jsonapi.org/) specification\n- **Store-scoped**: Most endpoints require an `X-Store` header identifying the target store\n- **JWT authentication**: Authenticated endpoints require a Bearer token obtained via `/api/v1/auth/login`\n- **Versioned**: Endpoints are available under `/api/v1` through `/api/v5` depending on the domain\n\nFor a quick introduction, see the [Quick Start guide](guides/quick-start.md).\n\n\nContact Support:\n Name: Blaze ECOM Engineering\n Email: ecomsupport@blaze.me", "type": "text/plain" } } }