diff --git "a/catalogs/shopping.json" "b/catalogs/shopping.json" new file mode 100644--- /dev/null +++ "b/catalogs/shopping.json" @@ -0,0 +1,9076 @@ +{ + "_meta": { + "generated_at": "2026-04-08", + "magento_root": "/var/www/magento2", + "webapi_xml_files_scanned": 55, + "graphqls_files_scanned": 39, + "websockets": "None found. No Ratchet, ReactPHP, or WebSocket server in vendor or composer.json.", + "total_endpoints": 502 + }, + "endpoints": [ + { + "api_type": "rest", + "endpoint": "POST /rest/V1/integration/admin/token", + "auth": "none", + "path_params": {}, + "query_params": {}, + "body_params": { + "username": { + "type": "string", + "source": "STATIC", + "notes": "Admin username" + }, + "password": { + "type": "string", + "source": "STATIC", + "notes": "Admin password" + } + }, + "response_key_fields": [ + "." + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/integration/customer/token", + "auth": "none", + "path_params": {}, + "query_params": {}, + "body_params": { + "username": { + "type": "string", + "source": "STATIC", + "notes": "Customer email" + }, + "password": { + "type": "string", + "source": "STATIC", + "notes": "Customer password" + } + }, + "response_key_fields": [ + "." + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/integration/customer/revoke-customer-token", + "auth": "bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": {}, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/tfa/installed-providers", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".[].code" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/tfa/forced-providers", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".[].code" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/tfa/user-providers/:userId", + "auth": "admin_bearer_token", + "path_params": { + "userId": { + "type": "integer", + "source": "DERIVED", + "notes": "Admin user ID" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/tfa/providers-to-activate/:userId", + "auth": "admin_bearer_token", + "path_params": { + "userId": { + "type": "integer", + "source": "DERIVED" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/tfa/default-provider-code/:userId", + "auth": "admin_bearer_token", + "path_params": { + "userId": { + "type": "integer", + "source": "DERIVED" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + "." + ] + }, + { + "api_type": "rest", + "endpoint": "PUT /rest/V1/tfa/default-provider-code/:userId", + "auth": "admin_bearer_token", + "path_params": { + "userId": { + "type": "integer", + "source": "DERIVED" + } + }, + "query_params": {}, + "body_params": { + "value": { + "type": "string", + "source": "PREV_CALL", + "from_endpoint": "GET /rest/V1/tfa/installed-providers", + "from_field": ".[].code" + } + }, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/tfa/tfat-user-providers", + "auth": "none", + "path_params": {}, + "query_params": {}, + "body_params": {}, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/tfa/tfat-providers-to-activate", + "auth": "none", + "path_params": {}, + "query_params": {}, + "body_params": {}, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/tfa/provider/google/configure", + "auth": "none", + "path_params": {}, + "query_params": {}, + "body_params": { + "tfaToken": { + "type": "string", + "source": "AUTH_FLOW", + "notes": "Temporary token from first-step auth" + } + }, + "response_key_fields": [ + ".qr_code_base64", + ".secret_code" + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/tfa/provider/google/authenticate", + "auth": "none", + "path_params": {}, + "query_params": {}, + "body_params": { + "tfaToken": { + "type": "string", + "source": "AUTH_FLOW" + }, + "otp": { + "type": "string", + "source": "STATIC", + "notes": "TOTP code" + } + }, + "response_key_fields": [ + ".token" + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/tfa/provider/google/activate", + "auth": "none", + "path_params": {}, + "query_params": {}, + "body_params": { + "tfaToken": { + "type": "string", + "source": "AUTH_FLOW" + }, + "otp": { + "type": "string", + "source": "STATIC" + } + }, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/tfa/provider/authy/configure", + "auth": "none", + "path_params": {}, + "query_params": {}, + "body_params": { + "tfaToken": { + "type": "string", + "source": "AUTH_FLOW" + } + }, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/tfa/provider/authy/activate", + "auth": "none", + "path_params": {}, + "query_params": {}, + "body_params": { + "tfaToken": { + "type": "string", + "source": "AUTH_FLOW" + }, + "verifyCode": { + "type": "string", + "source": "STATIC" + } + }, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/tfa/provider/authy/authenticate", + "auth": "none", + "path_params": {}, + "query_params": {}, + "body_params": { + "tfaToken": { + "type": "string", + "source": "AUTH_FLOW" + }, + "otp": { + "type": "string", + "source": "STATIC" + } + }, + "response_key_fields": [ + ".token" + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/tfa/provider/authy/send-token/:via", + "auth": "none", + "path_params": { + "via": { + "type": "string", + "source": "STATIC", + "notes": "sms or call" + } + }, + "query_params": {}, + "body_params": { + "tfaToken": { + "type": "string", + "source": "AUTH_FLOW" + } + }, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/tfa/provider/authy/authenticate-onetouch", + "auth": "none", + "path_params": {}, + "query_params": {}, + "body_params": { + "tfaToken": { + "type": "string", + "source": "AUTH_FLOW" + } + }, + "response_key_fields": [ + ".token" + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/tfa/provider/u2fkey/configure", + "auth": "none", + "path_params": {}, + "query_params": {}, + "body_params": { + "tfaToken": { + "type": "string", + "source": "AUTH_FLOW" + } + }, + "response_key_fields": [ + ".registration_data" + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/tfa/provider/u2fkey/activate", + "auth": "none", + "path_params": {}, + "query_params": {}, + "body_params": { + "tfaToken": { + "type": "string", + "source": "AUTH_FLOW" + }, + "publicKeyCredential": { + "type": "string", + "source": "AUTH_FLOW" + } + }, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/tfa/provider/u2fkey/authentication-challenge", + "auth": "none", + "path_params": {}, + "query_params": {}, + "body_params": { + "tfaToken": { + "type": "string", + "source": "AUTH_FLOW" + } + }, + "response_key_fields": [ + ".credential_request_options" + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/tfa/provider/u2fkey/verify", + "auth": "none", + "path_params": {}, + "query_params": {}, + "body_params": { + "tfaToken": { + "type": "string", + "source": "AUTH_FLOW" + }, + "publicKeyCredential": { + "type": "string", + "source": "AUTH_FLOW" + } + }, + "response_key_fields": [ + ".token" + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/tfa/provider/duo_security/configure", + "auth": "none", + "path_params": {}, + "query_params": {}, + "body_params": { + "tfaToken": { + "type": "string", + "source": "AUTH_FLOW" + } + }, + "response_key_fields": [ + ".signature", + ".api_hostname" + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/tfa/provider/duo_security/activate", + "auth": "none", + "path_params": {}, + "query_params": {}, + "body_params": { + "tfaToken": { + "type": "string", + "source": "AUTH_FLOW" + }, + "signatureResponse": { + "type": "string", + "source": "AUTH_FLOW" + } + }, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/tfa/provider/duo_security/get-authentication-data", + "auth": "none", + "path_params": {}, + "query_params": {}, + "body_params": { + "tfaToken": { + "type": "string", + "source": "AUTH_FLOW" + } + }, + "response_key_fields": [ + ".signature", + ".api_hostname" + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/tfa/provider/duo_security/authenticate", + "auth": "none", + "path_params": {}, + "query_params": {}, + "body_params": { + "tfaToken": { + "type": "string", + "source": "AUTH_FLOW" + }, + "signatureResponse": { + "type": "string", + "source": "AUTH_FLOW" + } + }, + "response_key_fields": [ + ".token" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/products", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": { + "searchCriteria[filterGroups][0][filters][0][field]": { + "type": "string", + "source": "STATIC" + }, + "searchCriteria[filterGroups][0][filters][0][value]": { + "type": "string", + "source": "STATIC" + }, + "searchCriteria[filterGroups][0][filters][0][conditionType]": { + "type": "string", + "source": "STATIC" + }, + "searchCriteria[pageSize]": { + "type": "integer", + "source": "STATIC" + }, + "searchCriteria[currentPage]": { + "type": "integer", + "source": "STATIC" + } + }, + "body_params": {}, + "response_key_fields": [ + ".items[].sku", + ".items[].id", + ".total_count" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/products/:sku", + "auth": "admin_bearer_token", + "path_params": { + "sku": { + "type": "string", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".id", + ".sku", + ".name", + ".price", + ".status" + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/products", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": { + "product": { + "type": "object", + "source": "STATIC", + "notes": "ProductInterface object with sku, name, price, attribute_set_id, status, visibility, type_id" + } + }, + "response_key_fields": [ + ".id", + ".sku" + ] + }, + { + "api_type": "rest", + "endpoint": "PUT /rest/V1/products/:sku", + "auth": "admin_bearer_token", + "path_params": { + "sku": { + "type": "string", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": { + "product": { + "type": "object", + "source": "STATIC", + "notes": "Partial ProductInterface update" + } + }, + "response_key_fields": [ + ".id", + ".sku" + ] + }, + { + "api_type": "rest", + "endpoint": "DELETE /rest/V1/products/:sku", + "auth": "admin_bearer_token", + "path_params": { + "sku": { + "type": "string", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/products/attributes/types", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".[].value" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/products/attributes/:attributeCode", + "auth": "admin_bearer_token", + "path_params": { + "attributeCode": { + "type": "string", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".attribute_id", + ".attribute_code", + ".frontend_input" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/products/attributes", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": { + "searchCriteria[pageSize]": { + "type": "integer", + "source": "STATIC" + } + }, + "body_params": {}, + "response_key_fields": [ + ".items[].attribute_code" + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/products/attributes", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": { + "attribute": { + "type": "object", + "source": "STATIC" + } + }, + "response_key_fields": [ + ".attribute_id", + ".attribute_code" + ] + }, + { + "api_type": "rest", + "endpoint": "PUT /rest/V1/products/attributes/:attributeCode", + "auth": "admin_bearer_token", + "path_params": { + "attributeCode": { + "type": "string", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": { + "attribute": { + "type": "object", + "source": "STATIC" + } + }, + "response_key_fields": [ + ".attribute_id" + ] + }, + { + "api_type": "rest", + "endpoint": "DELETE /rest/V1/products/attributes/:attributeCode", + "auth": "admin_bearer_token", + "path_params": { + "attributeCode": { + "type": "string", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/products/attributes/:attributeCode/options", + "auth": "admin_bearer_token", + "path_params": { + "attributeCode": { + "type": "string", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".[].value", + ".[].label" + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/products/attributes/:attributeCode/options", + "auth": "admin_bearer_token", + "path_params": { + "attributeCode": { + "type": "string", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": { + "option": { + "type": "object", + "source": "STATIC", + "notes": "AttributeOptionInterface with label" + } + }, + "response_key_fields": [ + "." + ] + }, + { + "api_type": "rest", + "endpoint": "PUT /rest/V1/products/attributes/:attributeCode/options/:optionId", + "auth": "admin_bearer_token", + "path_params": { + "attributeCode": { + "type": "string", + "source": "STATIC" + }, + "optionId": { + "type": "string", + "source": "PREV_CALL", + "from_endpoint": "GET /rest/V1/products/attributes/:attributeCode/options", + "from_field": ".[].value" + } + }, + "query_params": {}, + "body_params": { + "option": { + "type": "object", + "source": "STATIC" + } + }, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "DELETE /rest/V1/products/attributes/:attributeCode/options/:optionId", + "auth": "admin_bearer_token", + "path_params": { + "attributeCode": { + "type": "string", + "source": "STATIC" + }, + "optionId": { + "type": "string", + "source": "PREV_CALL", + "from_endpoint": "GET /rest/V1/products/attributes/:attributeCode/options", + "from_field": ".[].value" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/products/types", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".[].name" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/products/attribute-sets/sets/list", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": { + "searchCriteria[pageSize]": { + "type": "integer", + "source": "STATIC" + } + }, + "body_params": {}, + "response_key_fields": [ + ".items[].attribute_set_id", + ".items[].attribute_set_name" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/products/attribute-sets/:attributeSetId", + "auth": "admin_bearer_token", + "path_params": { + "attributeSetId": { + "type": "integer", + "source": "PREV_CALL", + "from_endpoint": "GET /rest/V1/products/attribute-sets/sets/list", + "from_field": ".items[].attribute_set_id" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".attribute_set_id", + ".attribute_set_name" + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/products/attribute-sets", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": { + "attributeSet": { + "type": "object", + "source": "STATIC" + }, + "skeletonId": { + "type": "integer", + "source": "STATIC" + } + }, + "response_key_fields": [ + ".attribute_set_id" + ] + }, + { + "api_type": "rest", + "endpoint": "PUT /rest/V1/products/attribute-sets/:attributeSetId", + "auth": "admin_bearer_token", + "path_params": { + "attributeSetId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": { + "attributeSet": { + "type": "object", + "source": "STATIC" + } + }, + "response_key_fields": [ + ".attribute_set_id" + ] + }, + { + "api_type": "rest", + "endpoint": "DELETE /rest/V1/products/attribute-sets/:attributeSetId", + "auth": "admin_bearer_token", + "path_params": { + "attributeSetId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/products/attribute-sets/:attributeSetId/attributes", + "auth": "admin_bearer_token", + "path_params": { + "attributeSetId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".[].attribute_code" + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/products/attribute-sets/attributes", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": { + "attributeSetId": { + "type": "integer", + "source": "STATIC" + }, + "attributeGroupId": { + "type": "integer", + "source": "STATIC" + }, + "attributeCode": { + "type": "string", + "source": "STATIC" + }, + "sortOrder": { + "type": "integer", + "source": "STATIC" + } + }, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "DELETE /rest/V1/products/attribute-sets/:attributeSetId/attributes/:attributeCode", + "auth": "admin_bearer_token", + "path_params": { + "attributeSetId": { + "type": "integer", + "source": "STATIC" + }, + "attributeCode": { + "type": "string", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/products/attribute-sets/groups/list", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": { + "searchCriteria[pageSize]": { + "type": "integer", + "source": "STATIC" + } + }, + "body_params": {}, + "response_key_fields": [ + ".items[].attribute_group_id" + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/products/attribute-sets/groups", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": { + "group": { + "type": "object", + "source": "STATIC" + } + }, + "response_key_fields": [ + ".attribute_group_id" + ] + }, + { + "api_type": "rest", + "endpoint": "PUT /rest/V1/products/attribute-sets/:attributeSetId/groups", + "auth": "admin_bearer_token", + "path_params": { + "attributeSetId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": { + "group": { + "type": "object", + "source": "STATIC" + } + }, + "response_key_fields": [ + ".attribute_group_id" + ] + }, + { + "api_type": "rest", + "endpoint": "DELETE /rest/V1/products/attribute-sets/groups/:groupId", + "auth": "admin_bearer_token", + "path_params": { + "groupId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/products/media/types/:attributeSetName", + "auth": "admin_bearer_token", + "path_params": { + "attributeSetName": { + "type": "string", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/products/:sku/media", + "auth": "admin_bearer_token", + "path_params": { + "sku": { + "type": "string", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".[].id", + ".[].file" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/products/:sku/media/:entryId", + "auth": "admin_bearer_token", + "path_params": { + "sku": { + "type": "string", + "source": "STATIC" + }, + "entryId": { + "type": "integer", + "source": "PREV_CALL", + "from_endpoint": "GET /rest/V1/products/:sku/media", + "from_field": ".[].id" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".id", + ".file" + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/products/:sku/media", + "auth": "admin_bearer_token", + "path_params": { + "sku": { + "type": "string", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": { + "entry": { + "type": "object", + "source": "STATIC", + "notes": "ProductAttributeMediaGalleryEntryInterface" + } + }, + "response_key_fields": [ + "." + ] + }, + { + "api_type": "rest", + "endpoint": "PUT /rest/V1/products/:sku/media/:entryId", + "auth": "admin_bearer_token", + "path_params": { + "sku": { + "type": "string", + "source": "STATIC" + }, + "entryId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": { + "entry": { + "type": "object", + "source": "STATIC" + } + }, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "DELETE /rest/V1/products/:sku/media/:entryId", + "auth": "admin_bearer_token", + "path_params": { + "sku": { + "type": "string", + "source": "STATIC" + }, + "entryId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/products-render-info", + "auth": "none", + "path_params": {}, + "query_params": { + "searchCriteria[filterGroups][0][filters][0][field]": { + "type": "string", + "source": "STATIC" + }, + "searchCriteria[filterGroups][0][filters][0][value]": { + "type": "string", + "source": "STATIC" + }, + "storeId": { + "type": "integer", + "source": "STATIC" + }, + "currencyCode": { + "type": "string", + "source": "STATIC" + } + }, + "body_params": {}, + "response_key_fields": [ + ".items[].id", + ".items[].name", + ".items[].price_info" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/categories", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": { + "rootCategoryId": { + "type": "integer", + "source": "STATIC" + }, + "depth": { + "type": "integer", + "source": "STATIC" + } + }, + "body_params": {}, + "response_key_fields": [ + ".id", + ".children_data[].id" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/categories/:categoryId", + "auth": "admin_bearer_token", + "path_params": { + "categoryId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".id", + ".name", + ".parent_id" + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/categories", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": { + "category": { + "type": "object", + "source": "STATIC", + "notes": "CategoryInterface with name, parent_id, is_active" + } + }, + "response_key_fields": [ + ".id" + ] + }, + { + "api_type": "rest", + "endpoint": "PUT /rest/V1/categories/:id", + "auth": "admin_bearer_token", + "path_params": { + "id": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": { + "category": { + "type": "object", + "source": "STATIC" + } + }, + "response_key_fields": [ + ".id" + ] + }, + { + "api_type": "rest", + "endpoint": "DELETE /rest/V1/categories/:categoryId", + "auth": "admin_bearer_token", + "path_params": { + "categoryId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/categories/list", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": { + "searchCriteria[pageSize]": { + "type": "integer", + "source": "STATIC" + } + }, + "body_params": {}, + "response_key_fields": [ + ".items[].id", + ".items[].name" + ] + }, + { + "api_type": "rest", + "endpoint": "PUT /rest/V1/categories/:categoryId/move", + "auth": "admin_bearer_token", + "path_params": { + "categoryId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": { + "parentId": { + "type": "integer", + "source": "STATIC" + }, + "afterId": { + "type": "integer", + "source": "STATIC" + } + }, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/categories/:categoryId/products", + "auth": "admin_bearer_token", + "path_params": { + "categoryId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".[].sku", + ".[].position" + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/categories/:categoryId/products", + "auth": "admin_bearer_token", + "path_params": { + "categoryId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": { + "productLink": { + "type": "object", + "source": "STATIC", + "notes": "CategoryProductLink with sku, position" + } + }, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "DELETE /rest/V1/categories/:categoryId/products/:sku", + "auth": "admin_bearer_token", + "path_params": { + "categoryId": { + "type": "integer", + "source": "STATIC" + }, + "sku": { + "type": "string", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/categories/attributes/:attributeCode", + "auth": "admin_bearer_token", + "path_params": { + "attributeCode": { + "type": "string", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".attribute_code", + ".attribute_id" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/categories/attributes", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": { + "searchCriteria[pageSize]": { + "type": "integer", + "source": "STATIC" + } + }, + "body_params": {}, + "response_key_fields": [ + ".items[].attribute_code" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/categories/attributes/:attributeCode/options", + "auth": "admin_bearer_token", + "path_params": { + "attributeCode": { + "type": "string", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".[].value", + ".[].label" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/products/options/types", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".[].code", + ".[].label" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/products/:sku/options", + "auth": "admin_bearer_token", + "path_params": { + "sku": { + "type": "string", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".[].option_id", + ".[].type" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/products/:sku/options/:optionId", + "auth": "admin_bearer_token", + "path_params": { + "sku": { + "type": "string", + "source": "STATIC" + }, + "optionId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".option_id" + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/products/options", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": { + "option": { + "type": "object", + "source": "STATIC" + } + }, + "response_key_fields": [ + ".option_id" + ] + }, + { + "api_type": "rest", + "endpoint": "PUT /rest/V1/products/options/:optionId", + "auth": "admin_bearer_token", + "path_params": { + "optionId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": { + "option": { + "type": "object", + "source": "STATIC" + } + }, + "response_key_fields": [ + ".option_id" + ] + }, + { + "api_type": "rest", + "endpoint": "DELETE /rest/V1/products/:sku/options/:optionId", + "auth": "admin_bearer_token", + "path_params": { + "sku": { + "type": "string", + "source": "STATIC" + }, + "optionId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/products/links/types", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".[].code" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/products/links/:type/attributes", + "auth": "admin_bearer_token", + "path_params": { + "type": { + "type": "string", + "source": "STATIC", + "notes": "related|crosssell|upsell|associated" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".[].code" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/products/:sku/links/:type", + "auth": "admin_bearer_token", + "path_params": { + "sku": { + "type": "string", + "source": "STATIC" + }, + "type": { + "type": "string", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".[].linked_product_sku" + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/products/:sku/links", + "auth": "admin_bearer_token", + "path_params": { + "sku": { + "type": "string", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": { + "items": { + "type": "array", + "source": "STATIC", + "notes": "Array of ProductLinkInterface" + } + }, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "PUT /rest/V1/products/:sku/links", + "auth": "admin_bearer_token", + "path_params": { + "sku": { + "type": "string", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": { + "entity": { + "type": "object", + "source": "STATIC" + } + }, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "DELETE /rest/V1/products/:sku/links/:type/:linkedProductSku", + "auth": "admin_bearer_token", + "path_params": { + "sku": { + "type": "string", + "source": "STATIC" + }, + "type": { + "type": "string", + "source": "STATIC" + }, + "linkedProductSku": { + "type": "string", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/products/:sku/websites", + "auth": "admin_bearer_token", + "path_params": { + "sku": { + "type": "string", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": { + "productWebsiteLink": { + "type": "object", + "source": "STATIC", + "notes": "ProductWebsiteLinkInterface with website_id" + } + }, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "DELETE /rest/V1/products/:sku/websites/:websiteId", + "auth": "admin_bearer_token", + "path_params": { + "sku": { + "type": "string", + "source": "STATIC" + }, + "websiteId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/products/special-price-information", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": { + "skus": { + "type": "array", + "source": "STATIC", + "notes": "Array of SKU strings" + } + }, + "response_key_fields": [ + ".[].price", + ".[].store_id", + ".[].sku" + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/products/special-price", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": { + "prices": { + "type": "array", + "source": "STATIC", + "notes": "Array of SpecialPriceInterface" + } + }, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/products/special-price-delete", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": { + "prices": { + "type": "array", + "source": "STATIC" + } + }, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/products/tier-prices-information", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": { + "skus": { + "type": "array", + "source": "STATIC" + } + }, + "response_key_fields": [ + ".[].price", + ".[].qty", + ".[].customer_group" + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/products/tier-prices", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": { + "prices": { + "type": "array", + "source": "STATIC" + } + }, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "PUT /rest/V1/products/tier-prices", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": { + "prices": { + "type": "array", + "source": "STATIC" + } + }, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/products/tier-prices-delete", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": { + "prices": { + "type": "array", + "source": "STATIC" + } + }, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/products/base-prices-information", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": { + "skus": { + "type": "array", + "source": "STATIC" + } + }, + "response_key_fields": [ + ".[].price", + ".[].sku" + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/products/base-prices", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": { + "prices": { + "type": "array", + "source": "STATIC" + } + }, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/products/cost-information", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": { + "skus": { + "type": "array", + "source": "STATIC" + } + }, + "response_key_fields": [ + ".[].cost", + ".[].sku" + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/products/cost", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": { + "prices": { + "type": "array", + "source": "STATIC" + } + }, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/products/cost-delete", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": { + "skus": { + "type": "array", + "source": "STATIC" + } + }, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/customers", + "auth": "none", + "path_params": {}, + "query_params": {}, + "body_params": { + "customer": { + "type": "object", + "source": "STATIC", + "notes": "CustomerInterface with firstname, lastname, email" + }, + "password": { + "type": "string", + "source": "STATIC" + } + }, + "response_key_fields": [ + ".id", + ".email" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/customers/:customerId", + "auth": "admin_bearer_token", + "path_params": { + "customerId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".id", + ".email", + ".firstname", + ".lastname" + ] + }, + { + "api_type": "rest", + "endpoint": "PUT /rest/V1/customers/:customerId", + "auth": "admin_bearer_token", + "path_params": { + "customerId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": { + "customer": { + "type": "object", + "source": "STATIC" + } + }, + "response_key_fields": [ + ".id" + ] + }, + { + "api_type": "rest", + "endpoint": "DELETE /rest/V1/customers/:customerId", + "auth": "admin_bearer_token", + "path_params": { + "customerId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/customers/me", + "auth": "bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".id", + ".email", + ".firstname", + ".lastname", + ".addresses" + ] + }, + { + "api_type": "rest", + "endpoint": "PUT /rest/V1/customers/me", + "auth": "bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": { + "customer": { + "type": "object", + "source": "STATIC", + "notes": "Partial customer update" + } + }, + "response_key_fields": [ + ".id" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/customers/search", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": { + "searchCriteria[filterGroups][0][filters][0][field]": { + "type": "string", + "source": "STATIC" + }, + "searchCriteria[filterGroups][0][filters][0][value]": { + "type": "string", + "source": "STATIC" + }, + "searchCriteria[pageSize]": { + "type": "integer", + "source": "STATIC" + } + }, + "body_params": {}, + "response_key_fields": [ + ".items[].id", + ".items[].email", + ".total_count" + ] + }, + { + "api_type": "rest", + "endpoint": "PUT /rest/V1/customers/me/activate", + "auth": "bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": { + "confirmationKey": { + "type": "string", + "source": "STATIC" + } + }, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "PUT /rest/V1/customers/:email/activate", + "auth": "admin_bearer_token", + "path_params": { + "email": { + "type": "string", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": { + "confirmationKey": { + "type": "string", + "source": "STATIC" + } + }, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "PUT /rest/V1/customers/me/password", + "auth": "bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": { + "currentPassword": { + "type": "string", + "source": "STATIC" + }, + "newPassword": { + "type": "string", + "source": "STATIC" + } + }, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/customers/:customerId/password/resetLinkToken/:resetPasswordLinkToken", + "auth": "none", + "path_params": { + "customerId": { + "type": "integer", + "source": "STATIC" + }, + "resetPasswordLinkToken": { + "type": "string", + "source": "AUTH_FLOW" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "PUT /rest/V1/customers/password", + "auth": "none", + "path_params": {}, + "query_params": {}, + "body_params": { + "email": { + "type": "string", + "source": "STATIC" + }, + "template": { + "type": "string", + "source": "STATIC", + "notes": "email_reset or email_reminder" + }, + "websiteId": { + "type": "integer", + "source": "STATIC" + } + }, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/customers/resetPassword", + "auth": "none", + "path_params": {}, + "query_params": {}, + "body_params": { + "email": { + "type": "string", + "source": "STATIC" + }, + "resetToken": { + "type": "string", + "source": "AUTH_FLOW" + }, + "newPassword": { + "type": "string", + "source": "STATIC" + } + }, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/customers/isEmailAvailable", + "auth": "none", + "path_params": {}, + "query_params": {}, + "body_params": { + "customerEmail": { + "type": "string", + "source": "STATIC" + }, + "websiteId": { + "type": "integer", + "source": "STATIC" + } + }, + "response_key_fields": [ + "." + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/customers/:customerId/confirm", + "auth": "admin_bearer_token", + "path_params": { + "customerId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + "." + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/customers/confirm", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": { + "email": { + "type": "string", + "source": "STATIC" + }, + "websiteId": { + "type": "integer", + "source": "STATIC" + }, + "redirectUrl": { + "type": "string", + "source": "STATIC" + } + }, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "PUT /rest/V1/customers/validate", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": { + "customer": { + "type": "object", + "source": "STATIC" + } + }, + "response_key_fields": [ + ".valid" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/customers/:customerId/permissions/readonly", + "auth": "admin_bearer_token", + "path_params": { + "customerId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + "." + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/customerGroups/:id", + "auth": "admin_bearer_token", + "path_params": { + "id": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".id", + ".code" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/customerGroups/search", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": { + "searchCriteria[pageSize]": { + "type": "integer", + "source": "STATIC" + } + }, + "body_params": {}, + "response_key_fields": [ + ".items[].id", + ".items[].code" + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/customerGroups", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": { + "group": { + "type": "object", + "source": "STATIC", + "notes": "CustomerGroupInterface with code, tax_class_id" + } + }, + "response_key_fields": [ + ".id" + ] + }, + { + "api_type": "rest", + "endpoint": "PUT /rest/V1/customerGroups/:id", + "auth": "admin_bearer_token", + "path_params": { + "id": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": { + "group": { + "type": "object", + "source": "STATIC" + } + }, + "response_key_fields": [ + ".id" + ] + }, + { + "api_type": "rest", + "endpoint": "DELETE /rest/V1/customerGroups/:id", + "auth": "admin_bearer_token", + "path_params": { + "id": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/customerGroups/default", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".id", + ".code" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/customerGroups/default/:storeId", + "auth": "admin_bearer_token", + "path_params": { + "storeId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".id", + ".code" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/customerGroups/:id/permissions", + "auth": "admin_bearer_token", + "path_params": { + "id": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + "." + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/customers/addresses/:addressId", + "auth": "admin_bearer_token", + "path_params": { + "addressId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".id", + ".firstname", + ".lastname" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/customers/me/billingAddress", + "auth": "bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".id", + ".street", + ".city", + ".postcode" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/customers/:customerId/billingAddress", + "auth": "admin_bearer_token", + "path_params": { + "customerId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".id" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/customers/me/shippingAddress", + "auth": "bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".id", + ".street", + ".city", + ".postcode" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/customers/:customerId/shippingAddress", + "auth": "admin_bearer_token", + "path_params": { + "customerId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".id" + ] + }, + { + "api_type": "rest", + "endpoint": "DELETE /rest/V1/addresses/:addressId", + "auth": "admin_bearer_token", + "path_params": { + "addressId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/attributeMetadata/customer", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".[].attribute_code" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/attributeMetadata/customer/attribute/:attributeCode", + "auth": "admin_bearer_token", + "path_params": { + "attributeCode": { + "type": "string", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".attribute_code" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/attributeMetadata/customer/form/:formCode", + "auth": "admin_bearer_token", + "path_params": { + "formCode": { + "type": "string", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".[].attribute_code" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/attributeMetadata/customer/custom", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".[].attribute_code" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/attributeMetadata/customerAddress", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".[].attribute_code" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/attributeMetadata/customerAddress/attribute/:attributeCode", + "auth": "admin_bearer_token", + "path_params": { + "attributeCode": { + "type": "string", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".attribute_code" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/attributeMetadata/customerAddress/form/:formCode", + "auth": "admin_bearer_token", + "path_params": { + "formCode": { + "type": "string", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".[].attribute_code" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/attributeMetadata/customerAddress/custom", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".[].attribute_code" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/carts/:cartId", + "auth": "admin_bearer_token", + "path_params": { + "cartId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".id", + ".customer.id", + ".items_count" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/carts/search", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": { + "searchCriteria[pageSize]": { + "type": "integer", + "source": "STATIC" + } + }, + "body_params": {}, + "response_key_fields": [ + ".items[].id", + ".total_count" + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/carts/", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + "." + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/customers/:customerId/carts", + "auth": "admin_bearer_token", + "path_params": { + "customerId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + "." + ] + }, + { + "api_type": "rest", + "endpoint": "PUT /rest/V1/carts/:cartId", + "auth": "admin_bearer_token", + "path_params": { + "cartId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": { + "customerId": { + "type": "integer", + "source": "STATIC" + }, + "storeId": { + "type": "integer", + "source": "STATIC" + } + }, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/carts/mine", + "auth": "bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + "." + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/carts/mine", + "auth": "bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".id", + ".items", + "items_count" + ] + }, + { + "api_type": "rest", + "endpoint": "PUT /rest/V1/carts/mine/order", + "auth": "bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": { + "paymentMethod": { + "type": "object", + "source": "STATIC", + "notes": "PaymentInterface" + } + }, + "response_key_fields": [ + "." + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/guest-carts", + "auth": "none", + "path_params": {}, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + "." + ], + "_notes": "Returns plain quoted string \u2014 the cartId" + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/guest-carts/:cartId", + "auth": "none", + "path_params": { + "cartId": { + "type": "string", + "source": "PREV_CALL", + "from_endpoint": "POST /rest/V1/guest-carts", + "from_field": "." + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".id", + ".items_count" + ] + }, + { + "api_type": "rest", + "endpoint": "PUT /rest/V1/guest-carts/:cartId", + "auth": "bearer_token", + "path_params": { + "cartId": { + "type": "string", + "source": "PREV_CALL", + "from_endpoint": "POST /rest/V1/guest-carts", + "from_field": "." + } + }, + "query_params": {}, + "body_params": { + "customerId": { + "type": "integer", + "source": "AUTH_FLOW" + }, + "storeId": { + "type": "integer", + "source": "STATIC" + } + }, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "PUT /rest/V1/guest-carts/:cartId/order", + "auth": "none", + "path_params": { + "cartId": { + "type": "string", + "source": "PREV_CALL", + "from_endpoint": "POST /rest/V1/guest-carts", + "from_field": "." + } + }, + "query_params": {}, + "body_params": { + "paymentMethod": { + "type": "object", + "source": "STATIC" + } + }, + "response_key_fields": [ + "." + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/carts/:cartId/items", + "auth": "admin_bearer_token", + "path_params": { + "cartId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".[].item_id", + ".[].sku", + ".[].qty" + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/carts/:quoteId/items", + "auth": "admin_bearer_token", + "path_params": { + "quoteId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": { + "cartItem": { + "type": "object", + "source": "STATIC", + "notes": "CartItemInterface with quote_id, sku, qty" + } + }, + "response_key_fields": [ + ".item_id" + ] + }, + { + "api_type": "rest", + "endpoint": "PUT /rest/V1/carts/:cartId/items/:itemId", + "auth": "admin_bearer_token", + "path_params": { + "cartId": { + "type": "integer", + "source": "STATIC" + }, + "itemId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": { + "cartItem": { + "type": "object", + "source": "STATIC" + } + }, + "response_key_fields": [ + ".item_id" + ] + }, + { + "api_type": "rest", + "endpoint": "DELETE /rest/V1/carts/:cartId/items/:itemId", + "auth": "admin_bearer_token", + "path_params": { + "cartId": { + "type": "integer", + "source": "STATIC" + }, + "itemId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/carts/mine/items", + "auth": "bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".[].item_id", + ".[].sku", + ".[].qty" + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/carts/mine/items", + "auth": "bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": { + "cartItem": { + "type": "object", + "source": "STATIC", + "notes": "CartItemInterface; quote_id is auto-filled from token" + } + }, + "response_key_fields": [ + ".item_id" + ] + }, + { + "api_type": "rest", + "endpoint": "PUT /rest/V1/carts/mine/items/:itemId", + "auth": "bearer_token", + "path_params": { + "itemId": { + "type": "integer", + "source": "PREV_CALL", + "from_endpoint": "GET /rest/V1/carts/mine/items", + "from_field": ".[].item_id" + } + }, + "query_params": {}, + "body_params": { + "cartItem": { + "type": "object", + "source": "STATIC" + } + }, + "response_key_fields": [ + ".item_id" + ] + }, + { + "api_type": "rest", + "endpoint": "DELETE /rest/V1/carts/mine/items/:itemId", + "auth": "bearer_token", + "path_params": { + "itemId": { + "type": "integer", + "source": "PREV_CALL", + "from_endpoint": "GET /rest/V1/carts/mine/items", + "from_field": ".[].item_id" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/guest-carts/:cartId/items", + "auth": "none", + "path_params": { + "cartId": { + "type": "string", + "source": "PREV_CALL", + "from_endpoint": "POST /rest/V1/guest-carts", + "from_field": "." + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".[].item_id", + ".[].sku", + ".[].qty" + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/guest-carts/:cartId/items", + "auth": "none", + "path_params": { + "cartId": { + "type": "string", + "source": "PREV_CALL", + "from_endpoint": "POST /rest/V1/guest-carts", + "from_field": "." + } + }, + "query_params": {}, + "body_params": { + "cartItem": { + "type": "object", + "source": "STATIC", + "notes": "CartItemInterface; quote_id (DERIVED) equals cartId" + } + }, + "response_key_fields": [ + ".item_id" + ] + }, + { + "api_type": "rest", + "endpoint": "PUT /rest/V1/guest-carts/:cartId/items/:itemId", + "auth": "none", + "path_params": { + "cartId": { + "type": "string", + "source": "PREV_CALL", + "from_endpoint": "POST /rest/V1/guest-carts", + "from_field": "." + }, + "itemId": { + "type": "integer", + "source": "PREV_CALL", + "from_endpoint": "GET /rest/V1/guest-carts/:cartId/items", + "from_field": ".[].item_id" + } + }, + "query_params": {}, + "body_params": { + "cartItem": { + "type": "object", + "source": "STATIC" + } + }, + "response_key_fields": [ + ".item_id" + ] + }, + { + "api_type": "rest", + "endpoint": "DELETE /rest/V1/guest-carts/:cartId/items/:itemId", + "auth": "none", + "path_params": { + "cartId": { + "type": "string", + "source": "PREV_CALL", + "from_endpoint": "POST /rest/V1/guest-carts", + "from_field": "." + }, + "itemId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/carts/:cartId/shipping-methods", + "auth": "admin_bearer_token", + "path_params": { + "cartId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".[].carrier_code", + ".[].method_code", + ".[].amount" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/carts/mine/shipping-methods", + "auth": "bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".[].carrier_code", + ".[].method_code", + ".[].amount" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/guest-carts/:cartId/shipping-methods", + "auth": "none", + "path_params": { + "cartId": { + "type": "string", + "source": "PREV_CALL", + "from_endpoint": "POST /rest/V1/guest-carts", + "from_field": "." + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".[].carrier_code", + ".[].method_code" + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/carts/:cartId/estimate-shipping-methods", + "auth": "admin_bearer_token", + "path_params": { + "cartId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": { + "address": { + "type": "object", + "source": "STATIC", + "notes": "AddressInterface with country_id, postcode" + } + }, + "response_key_fields": [ + ".[].carrier_code", + ".[].method_code", + ".[].amount" + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/carts/mine/estimate-shipping-methods", + "auth": "bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": { + "address": { + "type": "object", + "source": "STATIC" + } + }, + "response_key_fields": [ + ".[].carrier_code", + ".[].method_code", + ".[].amount" + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/guest-carts/:cartId/estimate-shipping-methods", + "auth": "none", + "path_params": { + "cartId": { + "type": "string", + "source": "PREV_CALL", + "from_endpoint": "POST /rest/V1/guest-carts", + "from_field": "." + } + }, + "query_params": {}, + "body_params": { + "address": { + "type": "object", + "source": "STATIC" + } + }, + "response_key_fields": [ + ".[].carrier_code", + ".[].method_code", + ".[].amount" + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/carts/:cartId/estimate-shipping-methods-by-address-id", + "auth": "admin_bearer_token", + "path_params": { + "cartId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": { + "addressId": { + "type": "integer", + "source": "PREV_CALL", + "from_endpoint": "GET /rest/V1/customers/me", + "from_field": ".addresses[].id" + } + }, + "response_key_fields": [ + ".[].carrier_code", + ".[].method_code" + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/carts/mine/estimate-shipping-methods-by-address-id", + "auth": "bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": { + "addressId": { + "type": "integer", + "source": "PREV_CALL", + "from_endpoint": "GET /rest/V1/customers/me", + "from_field": ".addresses[].id" + } + }, + "response_key_fields": [ + ".[].carrier_code", + ".[].method_code" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/carts/:cartId/payment-methods", + "auth": "admin_bearer_token", + "path_params": { + "cartId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".[].code", + ".[].title" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/carts/mine/payment-methods", + "auth": "bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".[].code", + ".[].title" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/guest-carts/:cartId/payment-methods", + "auth": "none", + "path_params": { + "cartId": { + "type": "string", + "source": "PREV_CALL", + "from_endpoint": "POST /rest/V1/guest-carts", + "from_field": "." + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".[].code", + ".[].title" + ] + }, + { + "api_type": "rest", + "endpoint": "PUT /rest/V1/carts/:cartId/selected-payment-method", + "auth": "admin_bearer_token", + "path_params": { + "cartId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": { + "method": { + "type": "object", + "source": "STATIC", + "notes": "PaymentInterface with method code" + } + }, + "response_key_fields": [ + "." + ] + }, + { + "api_type": "rest", + "endpoint": "PUT /rest/V1/carts/mine/selected-payment-method", + "auth": "bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": { + "method": { + "type": "object", + "source": "STATIC" + } + }, + "response_key_fields": [ + "." + ] + }, + { + "api_type": "rest", + "endpoint": "PUT /rest/V1/guest-carts/:cartId/selected-payment-method", + "auth": "none", + "path_params": { + "cartId": { + "type": "string", + "source": "PREV_CALL", + "from_endpoint": "POST /rest/V1/guest-carts", + "from_field": "." + } + }, + "query_params": {}, + "body_params": { + "method": { + "type": "object", + "source": "STATIC" + } + }, + "response_key_fields": [ + "." + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/carts/:cartId/billing-address", + "auth": "admin_bearer_token", + "path_params": { + "cartId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".firstname", + ".lastname", + ".street", + ".city" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/carts/mine/billing-address", + "auth": "bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".firstname", + ".lastname", + ".street", + ".city" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/guest-carts/:cartId/billing-address", + "auth": "none", + "path_params": { + "cartId": { + "type": "string", + "source": "PREV_CALL", + "from_endpoint": "POST /rest/V1/guest-carts", + "from_field": "." + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".firstname", + ".lastname" + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/carts/:cartId/billing-address", + "auth": "admin_bearer_token", + "path_params": { + "cartId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": { + "address": { + "type": "object", + "source": "STATIC", + "notes": "AddressInterface" + } + }, + "response_key_fields": [ + "." + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/carts/mine/billing-address", + "auth": "bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": { + "address": { + "type": "object", + "source": "STATIC" + } + }, + "response_key_fields": [ + "." + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/guest-carts/:cartId/billing-address", + "auth": "none", + "path_params": { + "cartId": { + "type": "string", + "source": "PREV_CALL", + "from_endpoint": "POST /rest/V1/guest-carts", + "from_field": "." + } + }, + "query_params": {}, + "body_params": { + "address": { + "type": "object", + "source": "STATIC" + } + }, + "response_key_fields": [ + "." + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/carts/:cartId/coupons", + "auth": "admin_bearer_token", + "path_params": { + "cartId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + "." + ] + }, + { + "api_type": "rest", + "endpoint": "PUT /rest/V1/carts/:cartId/coupons/:couponCode", + "auth": "admin_bearer_token", + "path_params": { + "cartId": { + "type": "integer", + "source": "STATIC" + }, + "couponCode": { + "type": "string", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "DELETE /rest/V1/carts/:cartId/coupons", + "auth": "admin_bearer_token", + "path_params": { + "cartId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/carts/mine/coupons", + "auth": "bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + "." + ] + }, + { + "api_type": "rest", + "endpoint": "PUT /rest/V1/carts/mine/coupons/:couponCode", + "auth": "bearer_token", + "path_params": { + "couponCode": { + "type": "string", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "DELETE /rest/V1/carts/mine/coupons", + "auth": "bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": {}, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/guest-carts/:cartId/coupons", + "auth": "none", + "path_params": { + "cartId": { + "type": "string", + "source": "PREV_CALL", + "from_endpoint": "POST /rest/V1/guest-carts", + "from_field": "." + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + "." + ] + }, + { + "api_type": "rest", + "endpoint": "PUT /rest/V1/guest-carts/:cartId/coupons/:couponCode", + "auth": "none", + "path_params": { + "cartId": { + "type": "string", + "source": "PREV_CALL", + "from_endpoint": "POST /rest/V1/guest-carts", + "from_field": "." + }, + "couponCode": { + "type": "string", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "DELETE /rest/V1/guest-carts/:cartId/coupons", + "auth": "none", + "path_params": { + "cartId": { + "type": "string", + "source": "PREV_CALL", + "from_endpoint": "POST /rest/V1/guest-carts", + "from_field": "." + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/carts/:cartId/totals", + "auth": "admin_bearer_token", + "path_params": { + "cartId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".grand_total", + ".subtotal", + ".items_qty" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/carts/mine/totals", + "auth": "bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".grand_total", + ".subtotal", + ".discount_amount" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/guest-carts/:cartId/totals", + "auth": "none", + "path_params": { + "cartId": { + "type": "string", + "source": "PREV_CALL", + "from_endpoint": "POST /rest/V1/guest-carts", + "from_field": "." + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".grand_total", + ".subtotal" + ] + }, + { + "api_type": "rest", + "endpoint": "PUT /rest/V1/guest-carts/:cartId/collect-totals", + "auth": "none", + "path_params": { + "cartId": { + "type": "string", + "source": "PREV_CALL", + "from_endpoint": "POST /rest/V1/guest-carts", + "from_field": "." + } + }, + "query_params": {}, + "body_params": { + "paymentMethod": { + "type": "object", + "source": "STATIC" + }, + "shippingCarrierCode": { + "type": "string", + "source": "STATIC" + }, + "shippingMethodCode": { + "type": "string", + "source": "STATIC" + } + }, + "response_key_fields": [ + ".grand_total" + ] + }, + { + "api_type": "rest", + "endpoint": "PUT /rest/V1/carts/mine/collect-totals", + "auth": "bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": { + "paymentMethod": { + "type": "object", + "source": "STATIC" + }, + "shippingCarrierCode": { + "type": "string", + "source": "STATIC" + }, + "shippingMethodCode": { + "type": "string", + "source": "STATIC" + } + }, + "response_key_fields": [ + ".grand_total" + ] + }, + { + "api_type": "rest", + "endpoint": "PUT /rest/V1/carts/:cartId/order", + "auth": "admin_bearer_token", + "path_params": { + "cartId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": { + "paymentMethod": { + "type": "object", + "source": "STATIC" + } + }, + "response_key_fields": [ + "." + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/guest-carts/:cartId/shipping-information", + "auth": "none", + "path_params": { + "cartId": { + "type": "string", + "source": "PREV_CALL", + "from_endpoint": "POST /rest/V1/guest-carts", + "from_field": "." + } + }, + "query_params": {}, + "body_params": { + "addressInformation": { + "type": "object", + "source": "STATIC", + "notes": "ShippingInformationInterface with shipping_address, billing_address, shipping_carrier_code, shipping_method_code" + } + }, + "response_key_fields": [ + ".payment_methods[].code", + ".totals.grand_total" + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/carts/mine/shipping-information", + "auth": "bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": { + "addressInformation": { + "type": "object", + "source": "STATIC" + } + }, + "response_key_fields": [ + ".payment_methods[].code", + ".totals.grand_total" + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/carts/:cartId/shipping-information", + "auth": "admin_bearer_token", + "path_params": { + "cartId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": { + "addressInformation": { + "type": "object", + "source": "STATIC" + } + }, + "response_key_fields": [ + ".payment_methods[].code", + ".totals.grand_total" + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/guest-carts/:cartId/totals-information", + "auth": "none", + "path_params": { + "cartId": { + "type": "string", + "source": "PREV_CALL", + "from_endpoint": "POST /rest/V1/guest-carts", + "from_field": "." + } + }, + "query_params": {}, + "body_params": { + "addressInformation": { + "type": "object", + "source": "STATIC" + } + }, + "response_key_fields": [ + ".grand_total", + ".subtotal" + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/carts/mine/totals-information", + "auth": "bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": { + "addressInformation": { + "type": "object", + "source": "STATIC" + } + }, + "response_key_fields": [ + ".grand_total", + ".subtotal" + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/carts/:cartId/totals-information", + "auth": "admin_bearer_token", + "path_params": { + "cartId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": { + "addressInformation": { + "type": "object", + "source": "STATIC" + } + }, + "response_key_fields": [ + ".grand_total", + ".subtotal" + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/guest-carts/:cartId/payment-information", + "auth": "none", + "path_params": { + "cartId": { + "type": "string", + "source": "PREV_CALL", + "from_endpoint": "POST /rest/V1/guest-carts", + "from_field": "." + } + }, + "query_params": {}, + "body_params": { + "email": { + "type": "string", + "source": "STATIC" + }, + "paymentMethod": { + "type": "object", + "source": "STATIC", + "notes": "PaymentInterface with method code" + }, + "billingAddress": { + "type": "object", + "source": "STATIC" + } + }, + "response_key_fields": [ + "." + ], + "_notes": "Returns orderId integer" + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/guest-carts/:cartId/payment-information", + "auth": "none", + "path_params": { + "cartId": { + "type": "string", + "source": "PREV_CALL", + "from_endpoint": "POST /rest/V1/guest-carts", + "from_field": "." + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".payment_methods[].code", + ".totals.grand_total" + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/carts/mine/payment-information", + "auth": "bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": { + "paymentMethod": { + "type": "object", + "source": "STATIC" + }, + "billingAddress": { + "type": "object", + "source": "STATIC" + } + }, + "response_key_fields": [ + "." + ], + "_notes": "Returns orderId integer" + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/carts/mine/payment-information", + "auth": "bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".payment_methods[].code", + ".totals.grand_total" + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/guest-carts/:cartId/set-payment-information", + "auth": "none", + "path_params": { + "cartId": { + "type": "string", + "source": "PREV_CALL", + "from_endpoint": "POST /rest/V1/guest-carts", + "from_field": "." + } + }, + "query_params": {}, + "body_params": { + "email": { + "type": "string", + "source": "STATIC" + }, + "paymentMethod": { + "type": "object", + "source": "STATIC" + }, + "billingAddress": { + "type": "object", + "source": "STATIC" + } + }, + "response_key_fields": [ + "." + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/carts/mine/set-payment-information", + "auth": "bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": { + "paymentMethod": { + "type": "object", + "source": "STATIC" + }, + "billingAddress": { + "type": "object", + "source": "STATIC" + } + }, + "response_key_fields": [ + "." + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/carts/licence", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".[].agreement_id", + ".[].name", + ".[].content" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/carts/licence/list", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".[].agreement_id", + ".[].name" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/carts/:cartId/gift-message", + "auth": "admin_bearer_token", + "path_params": { + "cartId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".sender", + ".recipient", + ".message" + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/carts/:cartId/gift-message", + "auth": "admin_bearer_token", + "path_params": { + "cartId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": { + "giftMessage": { + "type": "object", + "source": "STATIC", + "notes": "GiftMessageInterface with sender, recipient, message" + } + }, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/carts/:cartId/gift-message/:itemId", + "auth": "admin_bearer_token", + "path_params": { + "cartId": { + "type": "integer", + "source": "STATIC" + }, + "itemId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".sender", + ".recipient", + ".message" + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/carts/:cartId/gift-message/:itemId", + "auth": "admin_bearer_token", + "path_params": { + "cartId": { + "type": "integer", + "source": "STATIC" + }, + "itemId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": { + "giftMessage": { + "type": "object", + "source": "STATIC" + } + }, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/carts/mine/gift-message", + "auth": "bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".sender", + ".recipient", + ".message" + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/carts/mine/gift-message", + "auth": "bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": { + "giftMessage": { + "type": "object", + "source": "STATIC" + } + }, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/carts/mine/gift-message/:itemId", + "auth": "bearer_token", + "path_params": { + "itemId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".sender", + ".recipient", + ".message" + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/carts/mine/gift-message/:itemId", + "auth": "bearer_token", + "path_params": { + "itemId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": { + "giftMessage": { + "type": "object", + "source": "STATIC" + } + }, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/guest-carts/:cartId/gift-message", + "auth": "none", + "path_params": { + "cartId": { + "type": "string", + "source": "PREV_CALL", + "from_endpoint": "POST /rest/V1/guest-carts", + "from_field": "." + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".sender", + ".recipient", + ".message" + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/guest-carts/:cartId/gift-message", + "auth": "none", + "path_params": { + "cartId": { + "type": "string", + "source": "PREV_CALL", + "from_endpoint": "POST /rest/V1/guest-carts", + "from_field": "." + } + }, + "query_params": {}, + "body_params": { + "giftMessage": { + "type": "object", + "source": "STATIC" + } + }, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/guest-carts/:cartId/gift-message/:itemId", + "auth": "none", + "path_params": { + "cartId": { + "type": "string", + "source": "PREV_CALL", + "from_endpoint": "POST /rest/V1/guest-carts", + "from_field": "." + }, + "itemId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".sender", + ".recipient", + ".message" + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/guest-carts/:cartId/gift-message/:itemId", + "auth": "none", + "path_params": { + "cartId": { + "type": "string", + "source": "PREV_CALL", + "from_endpoint": "POST /rest/V1/guest-carts", + "from_field": "." + }, + "itemId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": { + "giftMessage": { + "type": "object", + "source": "STATIC" + } + }, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/orders/:id", + "auth": "admin_bearer_token", + "path_params": { + "id": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".entity_id", + ".increment_id", + ".status", + ".grand_total", + ".customer_email" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/orders", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": { + "searchCriteria[filterGroups][0][filters][0][field]": { + "type": "string", + "source": "STATIC" + }, + "searchCriteria[filterGroups][0][filters][0][value]": { + "type": "string", + "source": "STATIC" + }, + "searchCriteria[pageSize]": { + "type": "integer", + "source": "STATIC" + } + }, + "body_params": {}, + "response_key_fields": [ + ".items[].entity_id", + ".items[].increment_id", + ".items[].status", + ".total_count" + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/orders", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": { + "entity": { + "type": "object", + "source": "STATIC", + "notes": "OrderInterface" + } + }, + "response_key_fields": [ + ".entity_id" + ] + }, + { + "api_type": "rest", + "endpoint": "PUT /rest/V1/orders/create", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": { + "entity": { + "type": "object", + "source": "STATIC" + } + }, + "response_key_fields": [ + ".entity_id" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/orders/:id/statuses", + "auth": "admin_bearer_token", + "path_params": { + "id": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + "." + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/orders/:id/cancel", + "auth": "admin_bearer_token", + "path_params": { + "id": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + "." + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/orders/:id/hold", + "auth": "admin_bearer_token", + "path_params": { + "id": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + "." + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/orders/:id/unhold", + "auth": "admin_bearer_token", + "path_params": { + "id": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + "." + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/orders/:id/emails", + "auth": "admin_bearer_token", + "path_params": { + "id": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + "." + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/orders/:id/comments", + "auth": "admin_bearer_token", + "path_params": { + "id": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": { + "statusHistory": { + "type": "object", + "source": "STATIC", + "notes": "OrderStatusHistoryInterface with comment, status" + } + }, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/orders/:id/comments", + "auth": "admin_bearer_token", + "path_params": { + "id": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".[].comment", + ".[].status" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/orders/items/:id", + "auth": "admin_bearer_token", + "path_params": { + "id": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".item_id", + ".sku", + ".qty_ordered" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/orders/items", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": { + "searchCriteria[pageSize]": { + "type": "integer", + "source": "STATIC" + } + }, + "body_params": {}, + "response_key_fields": [ + ".items[].item_id", + ".items[].sku" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/invoices/:id", + "auth": "admin_bearer_token", + "path_params": { + "id": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".entity_id", + ".order_id", + ".grand_total" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/invoices", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": { + "searchCriteria[pageSize]": { + "type": "integer", + "source": "STATIC" + } + }, + "body_params": {}, + "response_key_fields": [ + ".items[].entity_id", + ".total_count" + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/invoices/", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": { + "entity": { + "type": "object", + "source": "STATIC" + } + }, + "response_key_fields": [ + ".entity_id" + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/invoices/comments", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": { + "entity": { + "type": "object", + "source": "STATIC" + } + }, + "response_key_fields": [ + ".entity_id" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/invoices/:id/comments", + "auth": "admin_bearer_token", + "path_params": { + "id": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".[].comment" + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/invoices/:id/emails", + "auth": "admin_bearer_token", + "path_params": { + "id": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/invoices/:id/void", + "auth": "admin_bearer_token", + "path_params": { + "id": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + "." + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/invoices/:id/capture", + "auth": "admin_bearer_token", + "path_params": { + "id": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + "." + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/order/:orderId/invoice", + "auth": "admin_bearer_token", + "path_params": { + "orderId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": { + "capture": { + "type": "boolean", + "source": "STATIC" + }, + "items": { + "type": "array", + "source": "STATIC" + }, + "notify": { + "type": "boolean", + "source": "STATIC" + } + }, + "response_key_fields": [ + "." + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/invoice/:invoiceId/refund", + "auth": "admin_bearer_token", + "path_params": { + "invoiceId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": { + "items": { + "type": "array", + "source": "STATIC" + }, + "notify": { + "type": "boolean", + "source": "STATIC" + } + }, + "response_key_fields": [ + "." + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/creditmemo/:id", + "auth": "admin_bearer_token", + "path_params": { + "id": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".entity_id", + ".order_id", + ".grand_total" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/creditmemos", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": { + "searchCriteria[pageSize]": { + "type": "integer", + "source": "STATIC" + } + }, + "body_params": {}, + "response_key_fields": [ + ".items[].entity_id", + ".total_count" + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/creditmemo", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": { + "entity": { + "type": "object", + "source": "STATIC" + } + }, + "response_key_fields": [ + ".entity_id" + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/creditmemo/refund", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": { + "creditmemo": { + "type": "object", + "source": "STATIC" + }, + "offlineRequested": { + "type": "boolean", + "source": "STATIC" + } + }, + "response_key_fields": [ + "." + ] + }, + { + "api_type": "rest", + "endpoint": "PUT /rest/V1/creditmemo/:id", + "auth": "admin_bearer_token", + "path_params": { + "id": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/creditmemo/:id/comments", + "auth": "admin_bearer_token", + "path_params": { + "id": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".[].comment" + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/creditmemo/:id/comments", + "auth": "admin_bearer_token", + "path_params": { + "id": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": { + "entity": { + "type": "object", + "source": "STATIC" + } + }, + "response_key_fields": [ + ".entity_id" + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/creditmemo/:id/emails", + "auth": "admin_bearer_token", + "path_params": { + "id": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/order/:orderId/refund", + "auth": "admin_bearer_token", + "path_params": { + "orderId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": { + "items": { + "type": "array", + "source": "STATIC" + }, + "notify": { + "type": "boolean", + "source": "STATIC" + }, + "appendComment": { + "type": "boolean", + "source": "STATIC" + } + }, + "response_key_fields": [ + "." + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/shipment/:id", + "auth": "admin_bearer_token", + "path_params": { + "id": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".entity_id", + ".order_id", + ".items[].sku" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/shipments", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": { + "searchCriteria[pageSize]": { + "type": "integer", + "source": "STATIC" + } + }, + "body_params": {}, + "response_key_fields": [ + ".items[].entity_id", + ".total_count" + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/shipment/", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": { + "entity": { + "type": "object", + "source": "STATIC" + } + }, + "response_key_fields": [ + ".entity_id" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/shipment/:id/comments", + "auth": "admin_bearer_token", + "path_params": { + "id": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".[].comment" + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/shipment/:id/comments", + "auth": "admin_bearer_token", + "path_params": { + "id": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": { + "entity": { + "type": "object", + "source": "STATIC" + } + }, + "response_key_fields": [ + ".entity_id" + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/shipment/:id/emails", + "auth": "admin_bearer_token", + "path_params": { + "id": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/shipment/track", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": { + "entity": { + "type": "object", + "source": "STATIC", + "notes": "ShipmentTrackInterface with order_id, carrier_code, title, track_number" + } + }, + "response_key_fields": [ + ".entity_id" + ] + }, + { + "api_type": "rest", + "endpoint": "DELETE /rest/V1/shipment/track/:id", + "auth": "admin_bearer_token", + "path_params": { + "id": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/shipment/:id/label", + "auth": "admin_bearer_token", + "path_params": { + "id": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + "." + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/order/:orderId/ship", + "auth": "admin_bearer_token", + "path_params": { + "orderId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": { + "items": { + "type": "array", + "source": "STATIC" + }, + "notify": { + "type": "boolean", + "source": "STATIC" + }, + "tracks": { + "type": "array", + "source": "STATIC" + } + }, + "response_key_fields": [ + "." + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/transactions/:id", + "auth": "admin_bearer_token", + "path_params": { + "id": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".transaction_id", + ".txn_type", + ".txn_id" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/transactions", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": { + "searchCriteria[pageSize]": { + "type": "integer", + "source": "STATIC" + } + }, + "body_params": {}, + "response_key_fields": [ + ".items[].transaction_id", + ".total_count" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/salesRules/:ruleId", + "auth": "admin_bearer_token", + "path_params": { + "ruleId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".rule_id", + ".name", + ".coupon_type" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/salesRules/search", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": { + "searchCriteria[pageSize]": { + "type": "integer", + "source": "STATIC" + } + }, + "body_params": {}, + "response_key_fields": [ + ".items[].rule_id", + ".items[].name" + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/salesRules", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": { + "rule": { + "type": "object", + "source": "STATIC", + "notes": "RuleInterface" + } + }, + "response_key_fields": [ + ".rule_id" + ] + }, + { + "api_type": "rest", + "endpoint": "PUT /rest/V1/salesRules/:ruleId", + "auth": "admin_bearer_token", + "path_params": { + "ruleId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": { + "rule": { + "type": "object", + "source": "STATIC" + } + }, + "response_key_fields": [ + ".rule_id" + ] + }, + { + "api_type": "rest", + "endpoint": "DELETE /rest/V1/salesRules/:ruleId", + "auth": "admin_bearer_token", + "path_params": { + "ruleId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/coupons/:couponId", + "auth": "admin_bearer_token", + "path_params": { + "couponId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".coupon_id", + ".code", + ".rule_id" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/coupons/search", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": { + "searchCriteria[pageSize]": { + "type": "integer", + "source": "STATIC" + } + }, + "body_params": {}, + "response_key_fields": [ + ".items[].coupon_id", + ".items[].code" + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/coupons", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": { + "coupon": { + "type": "object", + "source": "STATIC", + "notes": "CouponInterface with rule_id, code" + } + }, + "response_key_fields": [ + ".coupon_id" + ] + }, + { + "api_type": "rest", + "endpoint": "PUT /rest/V1/coupons/:couponId", + "auth": "admin_bearer_token", + "path_params": { + "couponId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": { + "coupon": { + "type": "object", + "source": "STATIC" + } + }, + "response_key_fields": [ + ".coupon_id" + ] + }, + { + "api_type": "rest", + "endpoint": "DELETE /rest/V1/coupons/:couponId", + "auth": "admin_bearer_token", + "path_params": { + "couponId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/coupons/generate", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": { + "couponSpec": { + "type": "object", + "source": "STATIC", + "notes": "CouponGenerationSpecInterface" + } + }, + "response_key_fields": [ + ".[].code" + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/coupons/deleteByIds", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": { + "ids": { + "type": "array", + "source": "STATIC" + } + }, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/coupons/deleteByCodes", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": { + "codes": { + "type": "array", + "source": "STATIC" + } + }, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/taxRates", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": { + "taxRate": { + "type": "object", + "source": "STATIC", + "notes": "TaxRateInterface with code, rate, tax_country_id" + } + }, + "response_key_fields": [ + ".id" + ] + }, + { + "api_type": "rest", + "endpoint": "PUT /rest/V1/taxRates", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": { + "taxRate": { + "type": "object", + "source": "STATIC" + } + }, + "response_key_fields": [ + ".id" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/taxRates/:rateId", + "auth": "admin_bearer_token", + "path_params": { + "rateId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".id", + ".code", + ".rate" + ] + }, + { + "api_type": "rest", + "endpoint": "DELETE /rest/V1/taxRates/:rateId", + "auth": "admin_bearer_token", + "path_params": { + "rateId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/taxRates/search", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": { + "searchCriteria[pageSize]": { + "type": "integer", + "source": "STATIC" + } + }, + "body_params": {}, + "response_key_fields": [ + ".items[].id", + ".items[].code" + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/taxRules", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": { + "rule": { + "type": "object", + "source": "STATIC" + } + }, + "response_key_fields": [ + ".id" + ] + }, + { + "api_type": "rest", + "endpoint": "PUT /rest/V1/taxRules", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": { + "rule": { + "type": "object", + "source": "STATIC" + } + }, + "response_key_fields": [ + ".id" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/taxRules/:ruleId", + "auth": "admin_bearer_token", + "path_params": { + "ruleId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".id", + ".code" + ] + }, + { + "api_type": "rest", + "endpoint": "DELETE /rest/V1/taxRules/:ruleId", + "auth": "admin_bearer_token", + "path_params": { + "ruleId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/taxRules/search", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": { + "searchCriteria[pageSize]": { + "type": "integer", + "source": "STATIC" + } + }, + "body_params": {}, + "response_key_fields": [ + ".items[].id" + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/taxClasses", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": { + "taxClass": { + "type": "object", + "source": "STATIC" + } + }, + "response_key_fields": [ + "." + ] + }, + { + "api_type": "rest", + "endpoint": "PUT /rest/V1/taxClasses/:classId", + "auth": "admin_bearer_token", + "path_params": { + "classId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": { + "taxClass": { + "type": "object", + "source": "STATIC" + } + }, + "response_key_fields": [ + "." + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/taxClasses/:taxClassId", + "auth": "admin_bearer_token", + "path_params": { + "taxClassId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".class_id", + ".class_name" + ] + }, + { + "api_type": "rest", + "endpoint": "DELETE /rest/V1/taxClasses/:taxClassId", + "auth": "admin_bearer_token", + "path_params": { + "taxClassId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/taxClasses/search", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": { + "searchCriteria[pageSize]": { + "type": "integer", + "source": "STATIC" + } + }, + "body_params": {}, + "response_key_fields": [ + ".items[].class_id", + ".items[].class_name" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/cmsPage/:pageId", + "auth": "admin_bearer_token", + "path_params": { + "pageId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".id", + ".title", + ".identifier" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/cmsPage/search", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": { + "searchCriteria[pageSize]": { + "type": "integer", + "source": "STATIC" + } + }, + "body_params": {}, + "response_key_fields": [ + ".items[].id", + ".items[].identifier" + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/cmsPage", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": { + "page": { + "type": "object", + "source": "STATIC", + "notes": "PageInterface with title, identifier, content" + } + }, + "response_key_fields": [ + ".id" + ] + }, + { + "api_type": "rest", + "endpoint": "PUT /rest/V1/cmsPage/:id", + "auth": "admin_bearer_token", + "path_params": { + "id": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": { + "page": { + "type": "object", + "source": "STATIC" + } + }, + "response_key_fields": [ + ".id" + ] + }, + { + "api_type": "rest", + "endpoint": "DELETE /rest/V1/cmsPage/:pageId", + "auth": "admin_bearer_token", + "path_params": { + "pageId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/cmsBlock/:blockId", + "auth": "admin_bearer_token", + "path_params": { + "blockId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".id", + ".title", + ".identifier" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/cmsBlock/search", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": { + "searchCriteria[pageSize]": { + "type": "integer", + "source": "STATIC" + } + }, + "body_params": {}, + "response_key_fields": [ + ".items[].id", + ".items[].identifier" + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/cmsBlock", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": { + "block": { + "type": "object", + "source": "STATIC" + } + }, + "response_key_fields": [ + ".id" + ] + }, + { + "api_type": "rest", + "endpoint": "PUT /rest/V1/cmsBlock/:id", + "auth": "admin_bearer_token", + "path_params": { + "id": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": { + "block": { + "type": "object", + "source": "STATIC" + } + }, + "response_key_fields": [ + ".id" + ] + }, + { + "api_type": "rest", + "endpoint": "DELETE /rest/V1/cmsBlock/:blockId", + "auth": "admin_bearer_token", + "path_params": { + "blockId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/search", + "auth": "none", + "path_params": {}, + "query_params": { + "searchCriteria[requestName]": { + "type": "string", + "source": "STATIC", + "notes": "quick_search_container or advanced_search_container" + }, + "searchCriteria[filterGroups][0][filters][0][field]": { + "type": "string", + "source": "STATIC", + "notes": "search_term" + }, + "searchCriteria[filterGroups][0][filters][0][value]": { + "type": "string", + "source": "STATIC" + }, + "searchCriteria[pageSize]": { + "type": "integer", + "source": "STATIC" + } + }, + "body_params": {}, + "response_key_fields": [ + ".items[].id", + ".items[].custom_attributes", + ".total_count" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/directory/currency", + "auth": "none", + "path_params": {}, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".base_currency_code", + ".default_display_currency_code", + ".available_currency_codes" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/directory/countries", + "auth": "none", + "path_params": {}, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".[].id", + ".[].two_letter_abbreviation", + ".[].full_name_english" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/directory/countries/:countryId", + "auth": "none", + "path_params": { + "countryId": { + "type": "string", + "source": "STATIC", + "notes": "Two-letter ISO code e.g. US" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".id", + ".available_regions[].id", + ".available_regions[].name" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/store/storeViews", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".[].id", + ".[].code", + ".[].name" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/store/storeGroups", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".[].id", + ".[].name" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/store/websites", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".[].id", + ".[].code", + ".[].name" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/store/storeConfigs", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": { + "storeCodes": { + "type": "array", + "source": "STATIC" + } + }, + "body_params": {}, + "response_key_fields": [ + ".[].id", + ".[].code", + ".[].base_url" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/modules", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".[]." + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/analytics/link", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".url", + ".initialization_vector" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/eav/attribute-sets/list", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": { + "searchCriteria[pageSize]": { + "type": "integer", + "source": "STATIC" + } + }, + "body_params": {}, + "response_key_fields": [ + ".items[].attribute_set_id", + ".items[].attribute_set_name" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/eav/attribute-sets/:attributeSetId", + "auth": "admin_bearer_token", + "path_params": { + "attributeSetId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".attribute_set_id", + ".attribute_set_name" + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/eav/attribute-sets", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": { + "attributeSet": { + "type": "object", + "source": "STATIC" + }, + "skeletonId": { + "type": "integer", + "source": "STATIC" + } + }, + "response_key_fields": [ + ".attribute_set_id" + ] + }, + { + "api_type": "rest", + "endpoint": "PUT /rest/V1/eav/attribute-sets/:attributeSetId", + "auth": "admin_bearer_token", + "path_params": { + "attributeSetId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": { + "attributeSet": { + "type": "object", + "source": "STATIC" + } + }, + "response_key_fields": [ + ".attribute_set_id" + ] + }, + { + "api_type": "rest", + "endpoint": "DELETE /rest/V1/eav/attribute-sets/:attributeSetId", + "auth": "admin_bearer_token", + "path_params": { + "attributeSetId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/stockItems/:productSku", + "auth": "admin_bearer_token", + "path_params": { + "productSku": { + "type": "string", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".item_id", + ".qty", + ".is_in_stock" + ] + }, + { + "api_type": "rest", + "endpoint": "PUT /rest/V1/products/:productSku/stockItems/:itemId", + "auth": "admin_bearer_token", + "path_params": { + "productSku": { + "type": "string", + "source": "STATIC" + }, + "itemId": { + "type": "integer", + "source": "PREV_CALL", + "from_endpoint": "GET /rest/V1/stockItems/:productSku", + "from_field": ".item_id" + } + }, + "query_params": {}, + "body_params": { + "stockItem": { + "type": "object", + "source": "STATIC", + "notes": "StockItemInterface with qty, is_in_stock" + } + }, + "response_key_fields": [ + "." + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/stockItems/lowStock/", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": { + "scopeId": { + "type": "integer", + "source": "STATIC" + }, + "qty": { + "type": "number", + "source": "STATIC" + }, + "pageSize": { + "type": "integer", + "source": "STATIC" + }, + "currentPage": { + "type": "integer", + "source": "STATIC" + } + }, + "body_params": {}, + "response_key_fields": [ + ".items[].sku", + ".items[].qty" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/stockStatuses/:productSku", + "auth": "admin_bearer_token", + "path_params": { + "productSku": { + "type": "string", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".stock_item.qty", + ".stock_status" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/bulk", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": { + "searchCriteria[pageSize]": { + "type": "integer", + "source": "STATIC" + } + }, + "body_params": {}, + "response_key_fields": [ + ".items[].uuid", + ".items[].status" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/bulk/:bulkUuid/status", + "auth": "admin_bearer_token", + "path_params": { + "bulkUuid": { + "type": "string", + "source": "PREV_CALL", + "from_endpoint": "GET /rest/V1/bulk", + "from_field": ".items[].uuid" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".operations_count", + ".failed_operations_count" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/bulk/:bulkUuid/detailed-status", + "auth": "admin_bearer_token", + "path_params": { + "bulkUuid": { + "type": "string", + "source": "PREV_CALL", + "from_endpoint": "GET /rest/V1/bulk", + "from_field": ".items[].uuid" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".operations_list[].status", + ".operations_list[].result_message" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/bulk/:bulkUuid/operation-status/:status", + "auth": "admin_bearer_token", + "path_params": { + "bulkUuid": { + "type": "string", + "source": "PREV_CALL", + "from_endpoint": "GET /rest/V1/bulk", + "from_field": ".items[].uuid" + }, + "status": { + "type": "integer", + "source": "STATIC", + "notes": "1=complete 2=failed 3=open 4=retriable_failed" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + "." + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/bundle-products/:productSku/children", + "auth": "admin_bearer_token", + "path_params": { + "productSku": { + "type": "string", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".[].sku" + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/bundle-products/:sku/links/:optionId", + "auth": "admin_bearer_token", + "path_params": { + "sku": { + "type": "string", + "source": "STATIC" + }, + "optionId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": { + "linkedProduct": { + "type": "object", + "source": "STATIC" + } + }, + "response_key_fields": [ + "." + ] + }, + { + "api_type": "rest", + "endpoint": "PUT /rest/V1/bundle-products/:sku/links/:id", + "auth": "admin_bearer_token", + "path_params": { + "sku": { + "type": "string", + "source": "STATIC" + }, + "id": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": { + "linkedProduct": { + "type": "object", + "source": "STATIC" + } + }, + "response_key_fields": [ + "." + ] + }, + { + "api_type": "rest", + "endpoint": "DELETE /rest/V1/bundle-products/:sku/options/:optionId/children/:childSku", + "auth": "admin_bearer_token", + "path_params": { + "sku": { + "type": "string", + "source": "STATIC" + }, + "optionId": { + "type": "integer", + "source": "STATIC" + }, + "childSku": { + "type": "string", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/bundle-products/:sku/options/all", + "auth": "admin_bearer_token", + "path_params": { + "sku": { + "type": "string", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".[].option_id", + ".[].type" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/bundle-products/options/types", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".[].code", + ".[].label" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/bundle-products/:sku/options/:optionId", + "auth": "admin_bearer_token", + "path_params": { + "sku": { + "type": "string", + "source": "STATIC" + }, + "optionId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".option_id" + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/bundle-products/options/add", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": { + "option": { + "type": "object", + "source": "STATIC" + } + }, + "response_key_fields": [ + ".option_id" + ] + }, + { + "api_type": "rest", + "endpoint": "PUT /rest/V1/bundle-products/options/:optionId", + "auth": "admin_bearer_token", + "path_params": { + "optionId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": { + "option": { + "type": "object", + "source": "STATIC" + } + }, + "response_key_fields": [ + ".option_id" + ] + }, + { + "api_type": "rest", + "endpoint": "DELETE /rest/V1/bundle-products/:sku/options/:optionId", + "auth": "admin_bearer_token", + "path_params": { + "sku": { + "type": "string", + "source": "STATIC" + }, + "optionId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/configurable-products/:sku/children", + "auth": "admin_bearer_token", + "path_params": { + "sku": { + "type": "string", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".[].sku" + ] + }, + { + "api_type": "rest", + "endpoint": "DELETE /rest/V1/configurable-products/:sku/children/:childSku", + "auth": "admin_bearer_token", + "path_params": { + "sku": { + "type": "string", + "source": "STATIC" + }, + "childSku": { + "type": "string", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/configurable-products/:sku/child", + "auth": "admin_bearer_token", + "path_params": { + "sku": { + "type": "string", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": { + "childSku": { + "type": "string", + "source": "STATIC" + } + }, + "response_key_fields": [ + "." + ] + }, + { + "api_type": "rest", + "endpoint": "PUT /rest/V1/configurable-products/variation", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": { + "product": { + "type": "object", + "source": "STATIC" + }, + "options": { + "type": "array", + "source": "STATIC" + } + }, + "response_key_fields": [ + ".[].sku" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/configurable-products/:sku/options/all", + "auth": "admin_bearer_token", + "path_params": { + "sku": { + "type": "string", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".[].id", + ".[].attribute_id" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/configurable-products/:sku/options/:id", + "auth": "admin_bearer_token", + "path_params": { + "sku": { + "type": "string", + "source": "STATIC" + }, + "id": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".id", + ".attribute_id" + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/configurable-products/:sku/options", + "auth": "admin_bearer_token", + "path_params": { + "sku": { + "type": "string", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": { + "option": { + "type": "object", + "source": "STATIC" + } + }, + "response_key_fields": [ + ".id" + ] + }, + { + "api_type": "rest", + "endpoint": "PUT /rest/V1/configurable-products/:sku/options/:id", + "auth": "admin_bearer_token", + "path_params": { + "sku": { + "type": "string", + "source": "STATIC" + }, + "id": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": { + "option": { + "type": "object", + "source": "STATIC" + } + }, + "response_key_fields": [ + ".id" + ] + }, + { + "api_type": "rest", + "endpoint": "DELETE /rest/V1/configurable-products/:sku/options/:id", + "auth": "admin_bearer_token", + "path_params": { + "sku": { + "type": "string", + "source": "STATIC" + }, + "id": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/products/:sku/downloadable-links", + "auth": "admin_bearer_token", + "path_params": { + "sku": { + "type": "string", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".[].id", + ".[].title" + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/products/:sku/downloadable-links", + "auth": "admin_bearer_token", + "path_params": { + "sku": { + "type": "string", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": { + "link": { + "type": "object", + "source": "STATIC" + } + }, + "response_key_fields": [ + "." + ] + }, + { + "api_type": "rest", + "endpoint": "PUT /rest/V1/products/:sku/downloadable-links/:id", + "auth": "admin_bearer_token", + "path_params": { + "sku": { + "type": "string", + "source": "STATIC" + }, + "id": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": { + "link": { + "type": "object", + "source": "STATIC" + } + }, + "response_key_fields": [ + "." + ] + }, + { + "api_type": "rest", + "endpoint": "DELETE /rest/V1/products/downloadable-links/:id", + "auth": "admin_bearer_token", + "path_params": { + "id": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/products/:sku/downloadable-links/samples", + "auth": "admin_bearer_token", + "path_params": { + "sku": { + "type": "string", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".[].id", + ".[].title" + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/products/:sku/downloadable-links/samples", + "auth": "admin_bearer_token", + "path_params": { + "sku": { + "type": "string", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": { + "sample": { + "type": "object", + "source": "STATIC" + } + }, + "response_key_fields": [ + "." + ] + }, + { + "api_type": "rest", + "endpoint": "PUT /rest/V1/products/:sku/downloadable-links/samples/:id", + "auth": "admin_bearer_token", + "path_params": { + "sku": { + "type": "string", + "source": "STATIC" + }, + "id": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": { + "sample": { + "type": "object", + "source": "STATIC" + } + }, + "response_key_fields": [ + "." + ] + }, + { + "api_type": "rest", + "endpoint": "DELETE /rest/V1/products/downloadable-links/samples/:id", + "auth": "admin_bearer_token", + "path_params": { + "id": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/inventory/sources", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": { + "searchCriteria[pageSize]": { + "type": "integer", + "source": "STATIC" + } + }, + "body_params": {}, + "response_key_fields": [ + ".items[].source_code", + ".items[].name" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/inventory/sources/:sourceCode", + "auth": "admin_bearer_token", + "path_params": { + "sourceCode": { + "type": "string", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".source_code", + ".name", + ".enabled" + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/inventory/sources", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": { + "source": { + "type": "object", + "source": "STATIC", + "notes": "SourceInterface with source_code, name" + } + }, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "PUT /rest/V1/inventory/sources/:sourceCode", + "auth": "admin_bearer_token", + "path_params": { + "sourceCode": { + "type": "string", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": { + "source": { + "type": "object", + "source": "STATIC" + } + }, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/inventory/stocks", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": { + "searchCriteria[pageSize]": { + "type": "integer", + "source": "STATIC" + } + }, + "body_params": {}, + "response_key_fields": [ + ".items[].stock_id", + ".items[].name" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/inventory/stocks/:stockId", + "auth": "admin_bearer_token", + "path_params": { + "stockId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".stock_id", + ".name" + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/inventory/stocks", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": { + "stock": { + "type": "object", + "source": "STATIC" + } + }, + "response_key_fields": [ + ".stock_id" + ] + }, + { + "api_type": "rest", + "endpoint": "PUT /rest/V1/inventory/stocks/:stockId", + "auth": "admin_bearer_token", + "path_params": { + "stockId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": { + "stock": { + "type": "object", + "source": "STATIC" + } + }, + "response_key_fields": [ + ".stock_id" + ] + }, + { + "api_type": "rest", + "endpoint": "DELETE /rest/V1/inventory/stocks/:stockId", + "auth": "admin_bearer_token", + "path_params": { + "stockId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/inventory/stock-source-links", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": { + "searchCriteria[pageSize]": { + "type": "integer", + "source": "STATIC" + } + }, + "body_params": {}, + "response_key_fields": [ + ".items[].source_code", + ".items[].stock_id" + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/inventory/stock-source-links", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": { + "links": { + "type": "array", + "source": "STATIC", + "notes": "Array of StockSourceLinkInterface" + } + }, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/inventory/stock-source-links-delete", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": { + "links": { + "type": "array", + "source": "STATIC" + } + }, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/inventory/source-items", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": { + "searchCriteria[filterGroups][0][filters][0][field]": { + "type": "string", + "source": "STATIC" + }, + "searchCriteria[filterGroups][0][filters][0][value]": { + "type": "string", + "source": "STATIC" + } + }, + "body_params": {}, + "response_key_fields": [ + ".items[].sku", + ".items[].source_code", + ".items[].quantity" + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/inventory/source-items", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": { + "sourceItems": { + "type": "array", + "source": "STATIC", + "notes": "Array of SourceItemInterface" + } + }, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/inventory/source-items-delete", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": { + "sourceItems": { + "type": "array", + "source": "STATIC" + } + }, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/inventory/get-sources-assigned-to-stock-ordered-by-priority/:stockId", + "auth": "admin_bearer_token", + "path_params": { + "stockId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".[].source_code" + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/inventory/bulk-product-source-assign", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": { + "skus": { + "type": "array", + "source": "STATIC" + }, + "sourceCodes": { + "type": "array", + "source": "STATIC" + } + }, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/inventory/bulk-product-source-unassign", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": { + "skus": { + "type": "array", + "source": "STATIC" + }, + "sourceCodes": { + "type": "array", + "source": "STATIC" + } + }, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/inventory/bulk-product-source-transfer", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": { + "skus": { + "type": "array", + "source": "STATIC" + }, + "originSource": { + "type": "string", + "source": "STATIC" + }, + "destinationSource": { + "type": "string", + "source": "STATIC" + } + }, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/inventory/bulk-partial-source-transfer", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": { + "originSourceCode": { + "type": "string", + "source": "STATIC" + }, + "destinationSourceCode": { + "type": "string", + "source": "STATIC" + }, + "items": { + "type": "array", + "source": "STATIC" + } + }, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/inventory/get-distance-provider-code", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + "." + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/inventory/get-latlng-from-address", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": { + "country": { + "type": "string", + "source": "STATIC" + }, + "postcode": { + "type": "string", + "source": "STATIC" + }, + "region": { + "type": "string", + "source": "STATIC" + }, + "city": { + "type": "string", + "source": "STATIC" + } + }, + "body_params": {}, + "response_key_fields": [ + ".lat", + ".lng" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/inventory/get-latslngs-from-address", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": {}, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/inventory/get-distance", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": { + "source": { + "type": "string", + "source": "STATIC" + }, + "destination": { + "type": "string", + "source": "STATIC" + } + }, + "body_params": {}, + "response_key_fields": [ + "." + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/inventory/export-stock-salable-qty/:salesChannelType/:salesChannelCode", + "auth": "admin_bearer_token", + "path_params": { + "salesChannelType": { + "type": "string", + "source": "STATIC", + "notes": "website" + }, + "salesChannelCode": { + "type": "string", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".[].sku", + ".[].qty" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/inventory/dump-stock-index-data/:salesChannelType/:salesChannelCode", + "auth": "admin_bearer_token", + "path_params": { + "salesChannelType": { + "type": "string", + "source": "STATIC" + }, + "salesChannelCode": { + "type": "string", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".[].sku", + ".[].qty" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/inventory/in-store-pickup/pickup-locations/", + "auth": "none", + "path_params": {}, + "query_params": { + "searchRequest[area][radius]": { + "type": "integer", + "source": "STATIC" + }, + "searchRequest[area][search_term]": { + "type": "string", + "source": "STATIC" + }, + "searchRequest[pageSize]": { + "type": "integer", + "source": "STATIC" + } + }, + "body_params": {}, + "response_key_fields": [ + ".items[].pickup_location_code", + ".items[].name" + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/order/notify-orders-are-ready-for-pickup", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": { + "orderIds": { + "type": "array", + "source": "STATIC" + } + }, + "response_key_fields": [ + ".failed", + ".successful" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/inventory/get-product-salable-quantity/:sku/:stockId", + "auth": "admin_bearer_token", + "path_params": { + "sku": { + "type": "string", + "source": "STATIC" + }, + "stockId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + "." + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/inventory/is-product-salable/:sku/:stockId", + "auth": "admin_bearer_token", + "path_params": { + "sku": { + "type": "string", + "source": "STATIC" + }, + "stockId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + "." + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/inventory/are-products-salable", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": { + "skus": { + "type": "array", + "source": "STATIC" + }, + "stockId": { + "type": "integer", + "source": "STATIC" + } + }, + "body_params": {}, + "response_key_fields": [ + ".[].sku", + ".[].salable" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/inventory/is-product-salable-for-requested-qty/:sku/:stockId/:requestedQty", + "auth": "admin_bearer_token", + "path_params": { + "sku": { + "type": "string", + "source": "STATIC" + }, + "stockId": { + "type": "integer", + "source": "STATIC" + }, + "requestedQty": { + "type": "number", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".salable" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/inventory/are-product-salable-for-requested-qty/", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": { + "requests": { + "type": "array", + "source": "STATIC" + } + }, + "body_params": {}, + "response_key_fields": [ + ".[].salable" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/inventory/stock-resolver/:type/:code", + "auth": "admin_bearer_token", + "path_params": { + "type": { + "type": "string", + "source": "STATIC", + "notes": "website" + }, + "code": { + "type": "string", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".stock_id", + ".name" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/inventory/source-selection-algorithm-list", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".[].code", + ".[].title" + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/inventory/source-selection-algorithm-result", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": { + "inventoryRequest": { + "type": "object", + "source": "STATIC", + "notes": "InventoryRequestInterface" + }, + "algorithmCode": { + "type": "string", + "source": "STATIC" + } + }, + "response_key_fields": [ + ".source_selection_items[].source_code", + ".source_selection_items[].sku" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/inventory/low-quantity-notification/:sourceCode/:sku", + "auth": "admin_bearer_token", + "path_params": { + "sourceCode": { + "type": "string", + "source": "STATIC" + }, + "sku": { + "type": "string", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".notify_stock_qty" + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/inventory/low-quantity-notification", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": { + "sourceItemsConfigurations": { + "type": "array", + "source": "STATIC" + } + }, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/inventory/low-quantity-notifications-delete", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": { + "sourceItems": { + "type": "array", + "source": "STATIC" + } + }, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/adobestock/asset/:id", + "auth": "admin_bearer_token", + "path_params": { + "id": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".id", + ".media_gallery_id" + ] + }, + { + "api_type": "rest", + "endpoint": "DELETE /rest/V1/adobestock/asset/:id", + "auth": "admin_bearer_token", + "path_params": { + "id": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/adobestock/asset/search", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": { + "searchCriteria[pageSize]": { + "type": "integer", + "source": "STATIC" + } + }, + "body_params": {}, + "response_key_fields": [ + ".items[].id", + ".total_count" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/adobestock/asset/list", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": { + "searchCriteria[pageSize]": { + "type": "integer", + "source": "STATIC" + } + }, + "body_params": {}, + "response_key_fields": [ + ".items[].id", + ".total_count" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/adobestock/search", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": { + "searchCriteria[filterGroups][0][filters][0][field]": { + "type": "string", + "source": "STATIC" + }, + "searchCriteria[filterGroups][0][filters][0][value]": { + "type": "string", + "source": "STATIC" + } + }, + "body_params": {}, + "response_key_fields": [ + ".items[].id", + ".total_count" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/applepay/auth", + "auth": "none", + "path_params": {}, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".clientToken" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/products/:sku/reviews", + "auth": "admin_bearer_token", + "path_params": { + "sku": { + "type": "string", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".[].id", + ".[].title", + ".[].detail", + ".[].nickname" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/reviews/:reviewId", + "auth": "admin_bearer_token", + "path_params": { + "reviewId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [ + ".id", + ".title", + ".detail", + ".status_id" + ] + }, + { + "api_type": "rest", + "endpoint": "GET /rest/V1/reviews", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": { + "searchCriteria[pageSize]": { + "type": "integer", + "source": "STATIC" + } + }, + "body_params": {}, + "response_key_fields": [ + ".items[].id", + ".total_count" + ] + }, + { + "api_type": "rest", + "endpoint": "POST /rest/V1/reviews", + "auth": "admin_bearer_token", + "path_params": {}, + "query_params": {}, + "body_params": { + "review": { + "type": "object", + "source": "STATIC", + "notes": "ReviewInterface with title, detail, nickname, entity_pk_value (product_id)" + } + }, + "response_key_fields": [ + ".id" + ] + }, + { + "api_type": "rest", + "endpoint": "PUT /rest/V1/reviews/:id", + "auth": "admin_bearer_token", + "path_params": { + "id": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": { + "review": { + "type": "object", + "source": "STATIC" + } + }, + "response_key_fields": [ + ".id" + ] + }, + { + "api_type": "rest", + "endpoint": "DELETE /rest/V1/reviews/:reviewId", + "auth": "admin_bearer_token", + "path_params": { + "reviewId": { + "type": "integer", + "source": "STATIC" + } + }, + "query_params": {}, + "body_params": {}, + "response_key_fields": [] + }, + { + "api_type": "graphql", + "endpoint": "POST /graphql", + "operation_name": "products", + "operation_type": "query", + "auth": "none", + "variables": { + "search": { + "type": "String", + "source": "STATIC", + "notes": "Full-text search term" + }, + "filter": { + "type": "ProductAttributeFilterInput", + "source": "STATIC", + "notes": "e.g. {sku:{eq:\"24-MB01\"}} or {category_id:{eq:\"3\"}}" + }, + "pageSize": { + "type": "Int", + "source": "STATIC" + }, + "currentPage": { + "type": "Int", + "source": "STATIC" + }, + "sort": { + "type": "ProductAttributeSortInput", + "source": "STATIC" + } + }, + "response_key_fields": [ + "products.items[].sku", + "products.items[].name", + "products.items[].uid", + "products.items[].price_range.minimum_price.final_price.value", + "products.total_count" + ] + }, + { + "api_type": "graphql", + "endpoint": "POST /graphql", + "operation_name": "categories", + "operation_type": "query", + "auth": "none", + "variables": { + "filters": { + "type": "CategoryFilterInput", + "source": "STATIC", + "notes": "e.g. {ids:{in:[\"3\",\"4\"]}}" + }, + "pageSize": { + "type": "Int", + "source": "STATIC" + }, + "currentPage": { + "type": "Int", + "source": "STATIC" + } + }, + "response_key_fields": [ + "categories.items[].uid", + "categories.items[].name", + "categories.items[].url_key", + "categories.total_count" + ] + }, + { + "api_type": "graphql", + "endpoint": "POST /graphql", + "operation_name": "category", + "operation_type": "query", + "auth": "none", + "variables": { + "id": { + "type": "Int", + "source": "STATIC", + "notes": "Deprecated \u2014 use categories instead" + } + }, + "response_key_fields": [ + "category.uid", + "category.name", + "category.children[].uid" + ] + }, + { + "api_type": "graphql", + "endpoint": "POST /graphql", + "operation_name": "categoryList", + "operation_type": "query", + "auth": "none", + "variables": { + "filters": { + "type": "CategoryFilterInput", + "source": "STATIC" + } + }, + "response_key_fields": [ + "categoryList[].uid", + "categoryList[].name" + ] + }, + { + "api_type": "graphql", + "endpoint": "POST /graphql", + "operation_name": "productReviewRatingsMetadata", + "operation_type": "query", + "auth": "none", + "variables": {}, + "response_key_fields": [ + "productReviewRatingsMetadata.items[].id", + "productReviewRatingsMetadata.items[].name", + "productReviewRatingsMetadata.items[].values[].value_id" + ] + }, + { + "api_type": "graphql", + "endpoint": "POST /graphql", + "operation_name": "customAttributeMetadata", + "operation_type": "query", + "auth": "none", + "variables": { + "attributes": { + "type": "[AttributeInput!]!", + "source": "STATIC", + "notes": "e.g. [{attribute_code:\"color\",entity_type:\"catalog_product\"}]" + } + }, + "response_key_fields": [ + "customAttributeMetadata.items[].attribute_code", + "customAttributeMetadata.items[].attribute_type" + ] + }, + { + "api_type": "graphql", + "endpoint": "POST /graphql", + "operation_name": "urlResolver", + "operation_type": "query", + "auth": "none", + "variables": { + "url": { + "type": "String!", + "source": "STATIC" + } + }, + "response_key_fields": [ + "urlResolver.entity_uid", + "urlResolver.type", + "urlResolver.relative_url" + ] + }, + { + "api_type": "graphql", + "endpoint": "POST /graphql", + "operation_name": "route", + "operation_type": "query", + "auth": "none", + "variables": { + "url": { + "type": "String!", + "source": "STATIC" + } + }, + "response_key_fields": [ + "route.relative_url", + "route.type", + "route.redirect_code" + ] + }, + { + "api_type": "graphql", + "endpoint": "POST /graphql", + "operation_name": "cmsPage", + "operation_type": "query", + "auth": "none", + "variables": { + "identifier": { + "type": "String", + "source": "STATIC", + "notes": "CMS page URL key" + } + }, + "response_key_fields": [ + "cmsPage.identifier", + "cmsPage.title", + "cmsPage.content" + ] + }, + { + "api_type": "graphql", + "endpoint": "POST /graphql", + "operation_name": "cmsBlocks", + "operation_type": "query", + "auth": "none", + "variables": { + "identifiers": { + "type": "[String]", + "source": "STATIC", + "notes": "Array of block identifiers" + } + }, + "response_key_fields": [ + "cmsBlocks.items[].identifier", + "cmsBlocks.items[].content" + ] + }, + { + "api_type": "graphql", + "endpoint": "POST /graphql", + "operation_name": "storeConfig", + "operation_type": "query", + "auth": "none", + "variables": {}, + "response_key_fields": [ + "storeConfig.store_code", + "storeConfig.base_url", + "storeConfig.base_currency_code", + "storeConfig.locale" + ] + }, + { + "api_type": "graphql", + "endpoint": "POST /graphql", + "operation_name": "availableStores", + "operation_type": "query", + "auth": "none", + "variables": { + "useCurrentGroup": { + "type": "Boolean", + "source": "STATIC" + } + }, + "response_key_fields": [ + "availableStores[].store_code", + "availableStores[].store_name" + ] + }, + { + "api_type": "graphql", + "endpoint": "POST /graphql", + "operation_name": "currency", + "operation_type": "query", + "auth": "none", + "variables": {}, + "response_key_fields": [ + "currency.base_currency_code", + "currency.default_display_currency_code", + "currency.available_currency_codes" + ] + }, + { + "api_type": "graphql", + "endpoint": "POST /graphql", + "operation_name": "countries", + "operation_type": "query", + "auth": "none", + "variables": {}, + "response_key_fields": [ + "countries[].id", + "countries[].two_letter_abbreviation", + "countries[].available_regions[].code" + ] + }, + { + "api_type": "graphql", + "endpoint": "POST /graphql", + "operation_name": "country", + "operation_type": "query", + "auth": "none", + "variables": { + "id": { + "type": "String", + "source": "STATIC", + "notes": "Two-letter country code e.g. US" + } + }, + "response_key_fields": [ + "country.id", + "country.full_name_english", + "country.available_regions[].id" + ] + }, + { + "api_type": "graphql", + "endpoint": "POST /graphql", + "operation_name": "customer", + "operation_type": "query", + "auth": "bearer_token", + "variables": {}, + "response_key_fields": [ + "customer.id", + "customer.email", + "customer.firstname", + "customer.lastname", + "customer.addresses[].id" + ] + }, + { + "api_type": "graphql", + "endpoint": "POST /graphql", + "operation_name": "isEmailAvailable", + "operation_type": "query", + "auth": "none", + "variables": { + "email": { + "type": "String!", + "source": "STATIC" + } + }, + "response_key_fields": [ + "isEmailAvailable.is_email_available" + ] + }, + { + "api_type": "graphql", + "endpoint": "POST /graphql", + "operation_name": "generateCustomerToken", + "operation_type": "mutation", + "auth": "none", + "variables": { + "email": { + "type": "String!", + "source": "STATIC" + }, + "password": { + "type": "String!", + "source": "STATIC" + } + }, + "response_key_fields": [ + "generateCustomerToken.token" + ] + }, + { + "api_type": "graphql", + "endpoint": "POST /graphql", + "operation_name": "createCustomer", + "operation_type": "mutation", + "auth": "none", + "variables": { + "input": { + "type": "CustomerInput!", + "source": "STATIC", + "notes": "Deprecated - use createCustomerV2" + } + }, + "response_key_fields": [ + "createCustomer.customer.id", + "createCustomer.customer.email" + ] + }, + { + "api_type": "graphql", + "endpoint": "POST /graphql", + "operation_name": "createCustomerV2", + "operation_type": "mutation", + "auth": "none", + "variables": { + "input": { + "type": "CustomerCreateInput!", + "source": "STATIC", + "notes": "firstname, lastname, email, password required" + } + }, + "response_key_fields": [ + "createCustomerV2.customer.id", + "createCustomerV2.customer.email" + ] + }, + { + "api_type": "graphql", + "endpoint": "POST /graphql", + "operation_name": "updateCustomer", + "operation_type": "mutation", + "auth": "bearer_token", + "variables": { + "input": { + "type": "CustomerInput!", + "source": "STATIC", + "notes": "Deprecated - use updateCustomerV2" + } + }, + "response_key_fields": [ + "updateCustomer.customer.id" + ] + }, + { + "api_type": "graphql", + "endpoint": "POST /graphql", + "operation_name": "updateCustomerV2", + "operation_type": "mutation", + "auth": "bearer_token", + "variables": { + "input": { + "type": "CustomerUpdateInput!", + "source": "STATIC" + } + }, + "response_key_fields": [ + "updateCustomerV2.customer.id" + ] + }, + { + "api_type": "graphql", + "endpoint": "POST /graphql", + "operation_name": "deleteCustomer", + "operation_type": "mutation", + "auth": "bearer_token", + "variables": {}, + "response_key_fields": [ + "deleteCustomer" + ] + }, + { + "api_type": "graphql", + "endpoint": "POST /graphql", + "operation_name": "revokeCustomerToken", + "operation_type": "mutation", + "auth": "bearer_token", + "variables": {}, + "response_key_fields": [ + "revokeCustomerToken.result" + ] + }, + { + "api_type": "graphql", + "endpoint": "POST /graphql", + "operation_name": "changeCustomerPassword", + "operation_type": "mutation", + "auth": "bearer_token", + "variables": { + "currentPassword": { + "type": "String!", + "source": "STATIC" + }, + "newPassword": { + "type": "String!", + "source": "STATIC" + } + }, + "response_key_fields": [ + "changeCustomerPassword.email" + ] + }, + { + "api_type": "graphql", + "endpoint": "POST /graphql", + "operation_name": "createCustomerAddress", + "operation_type": "mutation", + "auth": "bearer_token", + "variables": { + "input": { + "type": "CustomerAddressInput!", + "source": "STATIC" + } + }, + "response_key_fields": [ + "createCustomerAddress.id" + ] + }, + { + "api_type": "graphql", + "endpoint": "POST /graphql", + "operation_name": "updateCustomerAddress", + "operation_type": "mutation", + "auth": "bearer_token", + "variables": { + "id": { + "type": "Int!", + "source": "PREV_CALL", + "from_endpoint": "customer", + "from_field": "customer.addresses[].id" + }, + "input": { + "type": "CustomerAddressInput", + "source": "STATIC" + } + }, + "response_key_fields": [ + "updateCustomerAddress.id" + ] + }, + { + "api_type": "graphql", + "endpoint": "POST /graphql", + "operation_name": "deleteCustomerAddress", + "operation_type": "mutation", + "auth": "bearer_token", + "variables": { + "id": { + "type": "Int!", + "source": "PREV_CALL", + "from_endpoint": "customer", + "from_field": "customer.addresses[].id" + } + }, + "response_key_fields": [ + "deleteCustomerAddress" + ] + }, + { + "api_type": "graphql", + "endpoint": "POST /graphql", + "operation_name": "requestPasswordResetEmail", + "operation_type": "mutation", + "auth": "none", + "variables": { + "email": { + "type": "String!", + "source": "STATIC" + } + }, + "response_key_fields": [ + "requestPasswordResetEmail" + ] + }, + { + "api_type": "graphql", + "endpoint": "POST /graphql", + "operation_name": "resetPassword", + "operation_type": "mutation", + "auth": "none", + "variables": { + "email": { + "type": "String!", + "source": "STATIC" + }, + "resetPasswordToken": { + "type": "String!", + "source": "AUTH_FLOW" + }, + "newPassword": { + "type": "String!", + "source": "STATIC" + } + }, + "response_key_fields": [ + "resetPassword" + ] + }, + { + "api_type": "graphql", + "endpoint": "POST /graphql", + "operation_name": "updateCustomerEmail", + "operation_type": "mutation", + "auth": "bearer_token", + "variables": { + "email": { + "type": "String!", + "source": "STATIC" + }, + "password": { + "type": "String!", + "source": "STATIC" + } + }, + "response_key_fields": [ + "updateCustomerEmail.customer.email" + ] + }, + { + "api_type": "graphql", + "endpoint": "POST /graphql", + "operation_name": "customerDownloadableProducts", + "operation_type": "query", + "auth": "bearer_token", + "variables": {}, + "response_key_fields": [ + "customerDownloadableProducts.items[].order_increment_id", + "customerDownloadableProducts.items[].download_url" + ] + }, + { + "api_type": "graphql", + "endpoint": "POST /graphql", + "operation_name": "customerPaymentTokens", + "operation_type": "query", + "auth": "bearer_token", + "variables": {}, + "response_key_fields": [ + "customerPaymentTokens.items[].public_hash", + "customerPaymentTokens.items[].payment_method_code" + ] + }, + { + "api_type": "graphql", + "endpoint": "POST /graphql", + "operation_name": "deletePaymentToken", + "operation_type": "mutation", + "auth": "bearer_token", + "variables": { + "public_hash": { + "type": "String!", + "source": "PREV_CALL", + "from_endpoint": "customerPaymentTokens", + "from_field": "customerPaymentTokens.items[].public_hash" + } + }, + "response_key_fields": [ + "deletePaymentToken.result" + ] + }, + { + "api_type": "graphql", + "endpoint": "POST /graphql", + "operation_name": "generateCustomerTokenAsAdmin", + "operation_type": "mutation", + "auth": "admin_bearer_token", + "variables": { + "input": { + "type": "GenerateCustomerTokenAsAdminInput!", + "source": "STATIC", + "notes": "{customer_email: \"...\"}" + } + }, + "response_key_fields": [ + "generateCustomerTokenAsAdmin.customer_token" + ] + }, + { + "api_type": "graphql", + "endpoint": "POST /graphql", + "operation_name": "cart", + "operation_type": "query", + "auth": "none", + "variables": { + "cart_id": { + "type": "String!", + "source": "PREV_CALL", + "from_endpoint": "createEmptyCart", + "from_field": "createEmptyCart" + } + }, + "response_key_fields": [ + "cart.id", + "cart.items[].uid", + "cart.items[].quantity", + "cart.items[].product.sku", + "cart.prices.grand_total.value" + ] + }, + { + "api_type": "graphql", + "endpoint": "POST /graphql", + "operation_name": "customerCart", + "operation_type": "query", + "auth": "bearer_token", + "variables": {}, + "response_key_fields": [ + "customerCart.id", + "customerCart.items[].uid", + "customerCart.prices.grand_total.value" + ] + }, + { + "api_type": "graphql", + "endpoint": "POST /graphql", + "operation_name": "createEmptyCart", + "operation_type": "mutation", + "auth": "none", + "variables": { + "input": { + "type": "createEmptyCartInput", + "source": "STATIC", + "notes": "Optional; include cart_id to use specific ID" + } + }, + "response_key_fields": [ + "createEmptyCart" + ] + }, + { + "api_type": "graphql", + "endpoint": "POST /graphql", + "operation_name": "addProductsToCart", + "operation_type": "mutation", + "auth": "none", + "variables": { + "cartId": { + "type": "String!", + "source": "PREV_CALL", + "from_endpoint": "createEmptyCart", + "from_field": "createEmptyCart" + }, + "cartItems": { + "type": "[CartItemInput!]!", + "source": "STATIC", + "notes": "[{sku,quantity,selected_options,entered_options}]" + } + }, + "response_key_fields": [ + "addProductsToCart.cart.id", + "addProductsToCart.user_errors" + ] + }, + { + "api_type": "graphql", + "endpoint": "POST /graphql", + "operation_name": "addSimpleProductsToCart", + "operation_type": "mutation", + "auth": "none", + "variables": { + "input": { + "type": "AddSimpleProductsToCartInput", + "source": "STATIC", + "notes": "Deprecated - use addProductsToCart" + } + }, + "response_key_fields": [ + "addSimpleProductsToCart.cart.id" + ] + }, + { + "api_type": "graphql", + "endpoint": "POST /graphql", + "operation_name": "addVirtualProductsToCart", + "operation_type": "mutation", + "auth": "none", + "variables": { + "input": { + "type": "AddVirtualProductsToCartInput", + "source": "STATIC" + } + }, + "response_key_fields": [ + "addVirtualProductsToCart.cart.id" + ] + }, + { + "api_type": "graphql", + "endpoint": "POST /graphql", + "operation_name": "addBundleProductsToCart", + "operation_type": "mutation", + "auth": "none", + "variables": { + "input": { + "type": "AddBundleProductsToCartInput", + "source": "STATIC" + } + }, + "response_key_fields": [ + "addBundleProductsToCart.cart.id" + ] + }, + { + "api_type": "graphql", + "endpoint": "POST /graphql", + "operation_name": "addDownloadableProductsToCart", + "operation_type": "mutation", + "auth": "none", + "variables": { + "input": { + "type": "AddDownloadableProductsToCartInput", + "source": "STATIC" + } + }, + "response_key_fields": [ + "addDownloadableProductsToCart.cart.id" + ] + }, + { + "api_type": "graphql", + "endpoint": "POST /graphql", + "operation_name": "updateCartItems", + "operation_type": "mutation", + "auth": "none", + "variables": { + "input": { + "type": "UpdateCartItemsInput", + "source": "STATIC", + "notes": "{cart_id, cart_items:[{cart_item_uid, quantity}]}" + } + }, + "response_key_fields": [ + "updateCartItems.cart.id" + ] + }, + { + "api_type": "graphql", + "endpoint": "POST /graphql", + "operation_name": "removeItemFromCart", + "operation_type": "mutation", + "auth": "none", + "variables": { + "input": { + "type": "RemoveItemFromCartInput", + "source": "STATIC", + "notes": "{cart_id, cart_item_uid}" + } + }, + "response_key_fields": [ + "removeItemFromCart.cart.id" + ] + }, + { + "api_type": "graphql", + "endpoint": "POST /graphql", + "operation_name": "applyCouponToCart", + "operation_type": "mutation", + "auth": "none", + "variables": { + "input": { + "type": "ApplyCouponToCartInput", + "source": "STATIC", + "notes": "{cart_id, coupon_code}" + } + }, + "response_key_fields": [ + "applyCouponToCart.cart.applied_coupons[].code" + ] + }, + { + "api_type": "graphql", + "endpoint": "POST /graphql", + "operation_name": "removeCouponFromCart", + "operation_type": "mutation", + "auth": "none", + "variables": { + "input": { + "type": "RemoveCouponFromCartInput", + "source": "STATIC", + "notes": "{cart_id}" + } + }, + "response_key_fields": [ + "removeCouponFromCart.cart.id" + ] + }, + { + "api_type": "graphql", + "endpoint": "POST /graphql", + "operation_name": "setShippingAddressesOnCart", + "operation_type": "mutation", + "auth": "none", + "variables": { + "input": { + "type": "SetShippingAddressesOnCartInput", + "source": "STATIC", + "notes": "{cart_id, shipping_addresses:[{address}]}" + } + }, + "response_key_fields": [ + "setShippingAddressesOnCart.cart.shipping_addresses[].available_shipping_methods[].carrier_code" + ] + }, + { + "api_type": "graphql", + "endpoint": "POST /graphql", + "operation_name": "setBillingAddressOnCart", + "operation_type": "mutation", + "auth": "none", + "variables": { + "input": { + "type": "SetBillingAddressOnCartInput", + "source": "STATIC" + } + }, + "response_key_fields": [ + "setBillingAddressOnCart.cart.billing_address.city" + ] + }, + { + "api_type": "graphql", + "endpoint": "POST /graphql", + "operation_name": "setShippingMethodsOnCart", + "operation_type": "mutation", + "auth": "none", + "variables": { + "input": { + "type": "SetShippingMethodsOnCartInput", + "source": "STATIC", + "notes": "{cart_id, shipping_methods:[{carrier_code,method_code}]}" + } + }, + "response_key_fields": [ + "setShippingMethodsOnCart.cart.prices.grand_total.value" + ] + }, + { + "api_type": "graphql", + "endpoint": "POST /graphql", + "operation_name": "setPaymentMethodOnCart", + "operation_type": "mutation", + "auth": "none", + "variables": { + "input": { + "type": "SetPaymentMethodOnCartInput", + "source": "STATIC", + "notes": "{cart_id, payment_method:{code}}" + } + }, + "response_key_fields": [ + "setPaymentMethodOnCart.cart.selected_payment_method.code" + ] + }, + { + "api_type": "graphql", + "endpoint": "POST /graphql", + "operation_name": "setGuestEmailOnCart", + "operation_type": "mutation", + "auth": "none", + "variables": { + "input": { + "type": "SetGuestEmailOnCartInput", + "source": "STATIC", + "notes": "{cart_id, email}" + } + }, + "response_key_fields": [ + "setGuestEmailOnCart.cart.id" + ] + }, + { + "api_type": "graphql", + "endpoint": "POST /graphql", + "operation_name": "placeOrder", + "operation_type": "mutation", + "auth": "none", + "variables": { + "input": { + "type": "PlaceOrderInput", + "source": "STATIC", + "notes": "{cart_id}" + } + }, + "response_key_fields": [ + "placeOrder.order.order_number" + ] + }, + { + "api_type": "graphql", + "endpoint": "POST /graphql", + "operation_name": "mergeCarts", + "operation_type": "mutation", + "auth": "bearer_token", + "variables": { + "source_cart_id": { + "type": "String!", + "source": "PREV_CALL", + "from_endpoint": "createEmptyCart", + "from_field": "createEmptyCart" + }, + "destination_cart_id": { + "type": "String", + "source": "PREV_CALL", + "from_endpoint": "customerCart", + "from_field": "customerCart.id" + } + }, + "response_key_fields": [ + "mergeCarts.id" + ] + }, + { + "api_type": "graphql", + "endpoint": "POST /graphql", + "operation_name": "assignCustomerToGuestCart", + "operation_type": "mutation", + "auth": "bearer_token", + "variables": { + "cart_id": { + "type": "String!", + "source": "PREV_CALL", + "from_endpoint": "createEmptyCart", + "from_field": "createEmptyCart" + } + }, + "response_key_fields": [ + "assignCustomerToGuestCart.id" + ] + }, + { + "api_type": "graphql", + "endpoint": "POST /graphql", + "operation_name": "checkoutAgreements", + "operation_type": "query", + "auth": "none", + "variables": {}, + "response_key_fields": [ + "checkoutAgreements[].agreement_id", + "checkoutAgreements[].checkbox_text" + ] + }, + { + "api_type": "graphql", + "endpoint": "POST /graphql", + "operation_name": "customerOrders", + "operation_type": "query", + "auth": "bearer_token", + "variables": {}, + "response_key_fields": [ + "customerOrders.items[].number", + "customerOrders.items[].status" + ] + }, + { + "api_type": "graphql", + "endpoint": "POST /graphql", + "operation_name": "reorderItems", + "operation_type": "mutation", + "auth": "bearer_token", + "variables": { + "orderNumber": { + "type": "String!", + "source": "PREV_CALL", + "from_endpoint": "customerOrders", + "from_field": "customerOrders.items[].number" + } + }, + "response_key_fields": [ + "reorderItems.cart.id", + "reorderItems.userInputErrors" + ] + }, + { + "api_type": "graphql", + "endpoint": "POST /graphql", + "operation_name": "addProductsToWishlist", + "operation_type": "mutation", + "auth": "bearer_token", + "variables": { + "wishlistId": { + "type": "ID!", + "source": "PREV_CALL", + "from_endpoint": "customer", + "from_field": "customer.wishlists[].id" + }, + "wishlistItems": { + "type": "[WishlistItemInput!]!", + "source": "STATIC" + } + }, + "response_key_fields": [ + "addProductsToWishlist.wishlist.id", + "addProductsToWishlist.user_errors" + ] + }, + { + "api_type": "graphql", + "endpoint": "POST /graphql", + "operation_name": "removeProductsFromWishlist", + "operation_type": "mutation", + "auth": "bearer_token", + "variables": { + "wishlistId": { + "type": "ID!", + "source": "PREV_CALL", + "from_endpoint": "customer", + "from_field": "customer.wishlists[].id" + }, + "wishlistItemsIds": { + "type": "[ID!]!", + "source": "PREV_CALL", + "from_endpoint": "customer", + "from_field": "customer.wishlists[].items_v2.items[].id" + } + }, + "response_key_fields": [ + "removeProductsFromWishlist.wishlist.id" + ] + }, + { + "api_type": "graphql", + "endpoint": "POST /graphql", + "operation_name": "updateProductsInWishlist", + "operation_type": "mutation", + "auth": "bearer_token", + "variables": { + "wishlistId": { + "type": "ID!", + "source": "PREV_CALL", + "from_endpoint": "customer", + "from_field": "customer.wishlists[].id" + }, + "wishlistItems": { + "type": "[WishlistItemUpdateInput!]!", + "source": "STATIC" + } + }, + "response_key_fields": [ + "updateProductsInWishlist.wishlist.id" + ] + }, + { + "api_type": "graphql", + "endpoint": "POST /graphql", + "operation_name": "addWishlistItemsToCart", + "operation_type": "mutation", + "auth": "bearer_token", + "variables": { + "wishlistId": { + "type": "ID!", + "source": "PREV_CALL", + "from_endpoint": "customer", + "from_field": "customer.wishlists[].id" + }, + "wishlistItemIds": { + "type": "[ID!]", + "source": "PREV_CALL", + "from_endpoint": "customer", + "from_field": "customer.wishlists[].items_v2.items[].id" + } + }, + "response_key_fields": [ + "addWishlistItemsToCart.status", + "addWishlistItemsToCart.wishlist.id" + ] + }, + { + "api_type": "graphql", + "endpoint": "POST /graphql", + "operation_name": "createProductReview", + "operation_type": "mutation", + "auth": "bearer_token", + "variables": { + "input": { + "type": "CreateProductReviewInput!", + "source": "STATIC", + "notes": "{sku, nickname, summary, text, ratings:[{id,value_id}]}" + } + }, + "response_key_fields": [ + "createProductReview.review.summary", + "createProductReview.review.average_rating" + ] + }, + { + "api_type": "graphql", + "endpoint": "POST /graphql", + "operation_name": "compareList", + "operation_type": "query", + "auth": "none", + "variables": { + "uid": { + "type": "ID!", + "source": "PREV_CALL", + "from_endpoint": "createCompareList", + "from_field": "createCompareList.uid" + } + }, + "response_key_fields": [ + "compareList.uid", + "compareList.items[].uid", + "compareList.item_count" + ] + }, + { + "api_type": "graphql", + "endpoint": "POST /graphql", + "operation_name": "createCompareList", + "operation_type": "mutation", + "auth": "none", + "variables": { + "input": { + "type": "CreateCompareListInput", + "source": "STATIC", + "notes": "{products:[uid,...]}" + } + }, + "response_key_fields": [ + "createCompareList.uid", + "createCompareList.item_count" + ] + }, + { + "api_type": "graphql", + "endpoint": "POST /graphql", + "operation_name": "addProductsToCompareList", + "operation_type": "mutation", + "auth": "none", + "variables": { + "input": { + "type": "AddProductsToCompareListInput", + "source": "STATIC", + "notes": "{uid, products:[...]}" + } + }, + "response_key_fields": [ + "addProductsToCompareList.uid" + ] + }, + { + "api_type": "graphql", + "endpoint": "POST /graphql", + "operation_name": "removeProductsFromCompareList", + "operation_type": "mutation", + "auth": "none", + "variables": { + "input": { + "type": "RemoveProductsFromCompareListInput", + "source": "STATIC" + } + }, + "response_key_fields": [ + "removeProductsFromCompareList.uid" + ] + }, + { + "api_type": "graphql", + "endpoint": "POST /graphql", + "operation_name": "assignCompareListToCustomer", + "operation_type": "mutation", + "auth": "bearer_token", + "variables": { + "uid": { + "type": "ID!", + "source": "PREV_CALL", + "from_endpoint": "createCompareList", + "from_field": "createCompareList.uid" + } + }, + "response_key_fields": [ + "assignCompareListToCustomer.result" + ] + }, + { + "api_type": "graphql", + "endpoint": "POST /graphql", + "operation_name": "deleteCompareList", + "operation_type": "mutation", + "auth": "none", + "variables": { + "uid": { + "type": "ID!", + "source": "PREV_CALL", + "from_endpoint": "createCompareList", + "from_field": "createCompareList.uid" + } + }, + "response_key_fields": [ + "deleteCompareList.result" + ] + }, + { + "api_type": "graphql", + "endpoint": "POST /graphql", + "operation_name": "subscribeEmailToNewsletter", + "operation_type": "mutation", + "auth": "none", + "variables": { + "email": { + "type": "String!", + "source": "STATIC" + } + }, + "response_key_fields": [ + "subscribeEmailToNewsletter.status" + ] + }, + { + "api_type": "graphql", + "endpoint": "POST /graphql", + "operation_name": "sendEmailToFriend", + "operation_type": "mutation", + "auth": "none", + "variables": { + "input": { + "type": "SendEmailToFriendInput", + "source": "STATIC", + "notes": "{product_id, sender:{name,email,message}, recipients:[{name,email}]}" + } + }, + "response_key_fields": [ + "sendEmailToFriend.sender.name" + ] + }, + { + "api_type": "graphql", + "endpoint": "POST /graphql", + "operation_name": "createPaypalExpressToken", + "operation_type": "mutation", + "auth": "none", + "variables": { + "input": { + "type": "PaypalExpressTokenInput!", + "source": "STATIC", + "notes": "{cart_id, code, urls:{return_url,cancel_url}}" + } + }, + "response_key_fields": [ + "createPaypalExpressToken.token", + "createPaypalExpressToken.paypal_urls.start" + ] + }, + { + "api_type": "graphql", + "endpoint": "POST /graphql", + "operation_name": "createPayflowProToken", + "operation_type": "mutation", + "auth": "none", + "variables": { + "input": { + "type": "PayflowProTokenInput!", + "source": "STATIC", + "notes": "{cart_id, urls:{return_url,cancel_url,error_url}}" + } + }, + "response_key_fields": [ + "createPayflowProToken.secure_token", + "createPayflowProToken.secure_token_id" + ] + }, + { + "api_type": "graphql", + "endpoint": "POST /graphql", + "operation_name": "handlePayflowProResponse", + "operation_type": "mutation", + "auth": "none", + "variables": { + "input": { + "type": "PayflowProResponseInput!", + "source": "STATIC", + "notes": "{cart_id, paypal_payload}" + } + }, + "response_key_fields": [ + "handlePayflowProResponse.cart.id" + ] + }, + { + "api_type": "graphql", + "endpoint": "POST /graphql", + "operation_name": "getPayflowLinkToken", + "operation_type": "query", + "auth": "none", + "variables": { + "input": { + "type": "PayflowLinkTokenInput!", + "source": "STATIC", + "notes": "{cart_id}" + } + }, + "response_key_fields": [ + "getPayflowLinkToken.secure_token", + "getPayflowLinkToken.secure_token_id", + "getPayflowLinkToken.paypal_url" + ] + }, + { + "api_type": "graphql", + "endpoint": "POST /graphql", + "operation_name": "getHostedProUrl", + "operation_type": "query", + "auth": "none", + "variables": { + "input": { + "type": "HostedProUrlInput!", + "source": "STATIC", + "notes": "{cart_id}" + } + }, + "response_key_fields": [ + "getHostedProUrl.secure_form_url" + ] + }, + { + "api_type": "graphql", + "endpoint": "POST /graphql", + "operation_name": "createBraintreeClientToken", + "operation_type": "mutation", + "auth": "none", + "variables": {}, + "response_key_fields": [ + "createBraintreeClientToken" + ] + }, + { + "api_type": "graphql", + "endpoint": "POST /graphql", + "operation_name": "pickupLocations", + "operation_type": "query", + "auth": "none", + "variables": { + "area": { + "type": "AreaInput", + "source": "STATIC", + "notes": "{radius:Int!, search_term:String!}" + }, + "filters": { + "type": "PickupLocationFilterInput", + "source": "STATIC" + }, + "sort": { + "type": "PickupLocationSortInput", + "source": "STATIC" + }, + "pageSize": { + "type": "Int", + "source": "STATIC" + }, + "currentPage": { + "type": "Int", + "source": "STATIC" + }, + "productsInfo": { + "type": "[ProductInfoInput]", + "source": "STATIC" + } + }, + "response_key_fields": [ + "pickupLocations.items[].pickup_location_code", + "pickupLocations.items[].name", + "pickupLocations.total_count" + ] + }, + { + "api_type": "admin_ajax", + "endpoint": "POST /admin/customer/index/inlineEdit", + "auth": "session_cookie", + "path_params": {}, + "query_params": {}, + "body_params": { + "items": { + "type": "array", + "source": "STATIC", + "notes": "Array of customer records to inline-edit" + }, + "form_key": { + "type": "string", + "source": "AUTH_FLOW" + } + }, + "response_key_fields": [ + ".messages", + ".error" + ] + }, + { + "api_type": "admin_ajax", + "endpoint": "POST /admin/catalog/product/inlineEdit", + "auth": "session_cookie", + "path_params": {}, + "query_params": {}, + "body_params": { + "items": { + "type": "array", + "source": "STATIC" + }, + "form_key": { + "type": "string", + "source": "AUTH_FLOW" + } + }, + "response_key_fields": [ + ".messages", + ".error" + ] + }, + { + "api_type": "admin_ajax", + "endpoint": "POST /admin/cms_page/inlineEdit", + "auth": "session_cookie", + "path_params": {}, + "query_params": {}, + "body_params": { + "items": { + "type": "array", + "source": "STATIC" + }, + "form_key": { + "type": "string", + "source": "AUTH_FLOW" + } + }, + "response_key_fields": [ + ".messages", + ".error" + ] + }, + { + "api_type": "admin_ajax", + "endpoint": "POST /admin/cms_block/inlineEdit", + "auth": "session_cookie", + "path_params": {}, + "query_params": {}, + "body_params": { + "items": { + "type": "array", + "source": "STATIC" + }, + "form_key": { + "type": "string", + "source": "AUTH_FLOW" + } + }, + "response_key_fields": [ + ".messages", + ".error" + ] + }, + { + "api_type": "admin_ajax", + "endpoint": "POST /admin/sales_order/inlineEdit", + "auth": "session_cookie", + "path_params": {}, + "query_params": {}, + "body_params": { + "items": { + "type": "array", + "source": "STATIC" + }, + "form_key": { + "type": "string", + "source": "AUTH_FLOW" + } + }, + "response_key_fields": [ + ".messages", + ".error" + ] + }, + { + "api_type": "admin_ajax", + "endpoint": "POST /admin/review/product/inlineEdit", + "auth": "session_cookie", + "path_params": {}, + "query_params": {}, + "body_params": { + "items": { + "type": "array", + "source": "STATIC" + }, + "form_key": { + "type": "string", + "source": "AUTH_FLOW" + } + }, + "response_key_fields": [ + ".messages", + ".error" + ] + }, + { + "api_type": "admin_ajax", + "endpoint": "POST /admin/catalog_rule/promo_catalog/inlineEdit", + "auth": "session_cookie", + "path_params": {}, + "query_params": {}, + "body_params": { + "items": { + "type": "array", + "source": "STATIC" + }, + "form_key": { + "type": "string", + "source": "AUTH_FLOW" + } + }, + "response_key_fields": [ + ".messages", + ".error" + ] + }, + { + "api_type": "admin_ajax", + "endpoint": "POST /admin/customer/index/validate", + "auth": "session_cookie", + "path_params": {}, + "query_params": {}, + "body_params": { + "customer": { + "type": "object", + "source": "STATIC" + }, + "form_key": { + "type": "string", + "source": "AUTH_FLOW" + } + }, + "response_key_fields": [ + ".valid", + ".message" + ] + }, + { + "api_type": "admin_ajax", + "endpoint": "POST /admin/catalog/product/validate", + "auth": "session_cookie", + "path_params": {}, + "query_params": {}, + "body_params": { + "product": { + "type": "object", + "source": "STATIC" + }, + "form_key": { + "type": "string", + "source": "AUTH_FLOW" + } + }, + "response_key_fields": [ + ".error", + ".messages" + ] + }, + { + "api_type": "admin_ajax", + "endpoint": "POST /admin/catalog/product/massDelete", + "auth": "session_cookie", + "path_params": {}, + "query_params": {}, + "body_params": { + "selected": { + "type": "array", + "source": "STATIC", + "notes": "Array of product IDs" + }, + "form_key": { + "type": "string", + "source": "AUTH_FLOW" + } + }, + "response_key_fields": [] + }, + { + "api_type": "admin_ajax", + "endpoint": "POST /admin/catalog/product/massStatus", + "auth": "session_cookie", + "path_params": {}, + "query_params": {}, + "body_params": { + "selected": { + "type": "array", + "source": "STATIC" + }, + "status": { + "type": "integer", + "source": "STATIC", + "notes": "1=enable, 2=disable" + }, + "form_key": { + "type": "string", + "source": "AUTH_FLOW" + } + }, + "response_key_fields": [] + }, + { + "api_type": "admin_ajax", + "endpoint": "POST /admin/customer/index/massDelete", + "auth": "session_cookie", + "path_params": {}, + "query_params": {}, + "body_params": { + "selected": { + "type": "array", + "source": "STATIC" + }, + "form_key": { + "type": "string", + "source": "AUTH_FLOW" + } + }, + "response_key_fields": [] + }, + { + "api_type": "admin_ajax", + "endpoint": "POST /admin/catalog/category/suggestCategories", + "auth": "session_cookie", + "path_params": {}, + "query_params": { + "label_part": { + "type": "string", + "source": "STATIC" + }, + "form_key": { + "type": "string", + "source": "AUTH_FLOW" + } + }, + "body_params": {}, + "response_key_fields": [ + ".[].id", + ".[].label" + ] + }, + { + "api_type": "admin_ajax", + "endpoint": "GET /admin/mui/index/render", + "auth": "session_cookie", + "path_params": {}, + "query_params": { + "namespace": { + "type": "string", + "source": "STATIC", + "notes": "UI component namespace e.g. product_listing" + } + }, + "body_params": {}, + "response_key_fields": [ + ".components", + ".items" + ] + }, + { + "api_type": "admin_ajax", + "endpoint": "POST /admin/mui/index/inlineEdit", + "auth": "session_cookie", + "path_params": {}, + "query_params": {}, + "body_params": { + "items": { + "type": "array", + "source": "STATIC" + }, + "form_key": { + "type": "string", + "source": "AUTH_FLOW" + } + }, + "response_key_fields": [ + ".messages" + ] + } + ] +} \ No newline at end of file