{ "opencollection": "1.0.0", "info": { "name": "Shopify Admin REST About Customers API", "version": "2025-01" }, "request": { "auth": { "type": "apikey", "key": "X-Shopify-Access-Token", "value": "{{X-Shopify-Access-Token}}", "placement": "header" } }, "items": [ { "info": { "name": "Customers", "type": "folder" }, "items": [ { "info": { "name": "Shopify Retrieve a list of customers", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/customers.json", "params": [ { "name": "ids", "value": "", "type": "query", "description": "Comma-separated list of customer IDs" }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of results (max 250, default 50)" }, { "name": "since_id", "value": "", "type": "query", "description": "Return customers after the specified ID" }, { "name": "created_at_min", "value": "", "type": "query", "description": "Show customers created after this date" }, { "name": "created_at_max", "value": "", "type": "query", "description": "Show customers created before this date" }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Show customers updated after this date" }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Show customers updated before this date" }, { "name": "fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include" } ] }, "docs": "Retrieves a list of customers. Results can be filtered by creation date, update date, and other criteria. Returns up to 250 customers." }, { "info": { "name": "Shopify Create a customer", "type": "http" }, "http": { "method": "POST", "url": "https://{store}.myshopify.com/admin/api/2025-01/customers.json", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new customer record. Sends a welcome email if send_email_welcome is true." }, { "info": { "name": "Shopify Retrieve a count of customers", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/customers/count.json" }, "docs": "Retrieves a count of all customers." }, { "info": { "name": "Shopify Search for customers", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/customers/search.json", "params": [ { "name": "query", "value": "", "type": "query", "description": "Search query (e.g. email:user@example.com)" }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of results (max 250, default 50)" }, { "name": "fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include" } ] }, "docs": "Searches for customers matching a supplied query. Supports searching by name, email, phone, and other fields." }, { "info": { "name": "Shopify Retrieve a single customer", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/customers/:customer_id.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "The ID of the customer" }, { "name": "fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include" } ] }, "docs": "Retrieves a single customer by ID." }, { "info": { "name": "Shopify Update a customer", "type": "http" }, "http": { "method": "PUT", "url": "https://{store}.myshopify.com/admin/api/2025-01/customers/:customer_id.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "The ID of the customer" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing customer record." }, { "info": { "name": "Shopify Retrieve orders for a customer", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/customers/:customer_id/orders.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "The ID of the customer" }, { "name": "status", "value": "", "type": "query", "description": "Filter by order status" } ] }, "docs": "Retrieves all orders belonging to a specific customer." }, { "info": { "name": "Shopify Retrieves A List Of Customers", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/customers.json", "params": [ { "name": "ids", "value": "", "type": "query", "description": "Restrict results to customers specified by a comma-separated list of IDs." }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to those after the specified ID." }, { "name": "created_at_min", "value": "", "type": "query", "description": "Show customers created after a specified date.(format: 2014-04-25T16:15:47-04:00)" }, { "name": "created_at_max", "value": "", "type": "query", "description": "Show customers created before a specified date.(format: 2014-04-25T16:15:47-04:00)" }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Show customers last updated after a specified date.(format: 2014-04-25T16:15:47-04:00)" }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Show customers last updated before a specified date.(format: 2014-04-25T16:15:47-04:00)" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to show.\n (default: 50, maximum: 250)" }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer#index-2020-01" }, { "info": { "name": "Shopify Searches For Customers That Match A Supplied Query", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/customers/search.json", "params": [ { "name": "order", "value": "", "type": "query", "description": "Set the field and direction by which to order results.\n (default: last_order_date DESC)" }, { "name": "query", "value": "", "type": "query", "description": "Text to search for in the shop's customer data." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to show.\n (default: 50, maximum: 250)" }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer#search-2020-01" }, { "info": { "name": "Shopify Retrieves A Count Of All Customers", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/customers/count.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer#count-2020-01" }, { "info": { "name": "Shopify Retrieves A List Of Customers", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/customers.json", "params": [ { "name": "ids", "value": "", "type": "query", "description": "Restrict results to customers specified by a comma-separated list of IDs." }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to those after the specified ID." }, { "name": "created_at_min", "value": "", "type": "query", "description": "Show customers created after a specified date.(format: 2014-04-25T16:15:47-04:00)" }, { "name": "created_at_max", "value": "", "type": "query", "description": "Show customers created before a specified date.(format: 2014-04-25T16:15:47-04:00)" }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Show customers last updated after a specified date.(format: 2014-04-25T16:15:47-04:00)" }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Show customers last updated before a specified date.(format: 2014-04-25T16:15:47-04:00)" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to show.\n (default: 50, maximum: 250)" }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer#index-2020-04" }, { "info": { "name": "Shopify Searches For Customers That Match A Supplied Query", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/customers/search.json", "params": [ { "name": "order", "value": "", "type": "query", "description": "Set the field and direction by which to order results.\n (default: last_order_date DESC)" }, { "name": "query", "value": "", "type": "query", "description": "Text to search for in the shop's customer data." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to show.\n (default: 50, maximum: 250)" }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer#search-2020-04" }, { "info": { "name": "Shopify Retrieves A Count Of All Customers", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/customers/count.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer#count-2020-04" }, { "info": { "name": "Shopify Retrieves A List Of Customers", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/customers.json", "params": [ { "name": "ids", "value": "", "type": "query", "description": "Restrict results to customers specified by a comma-separated list of IDs." }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to those after the specified ID." }, { "name": "created_at_min", "value": "", "type": "query", "description": "Show customers created after a specified date.(format: 2014-04-25T16:15:47-04:00)" }, { "name": "created_at_max", "value": "", "type": "query", "description": "Show customers created before a specified date.(format: 2014-04-25T16:15:47-04:00)" }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Show customers last updated after a specified date.(format: 2014-04-25T16:15:47-04:00)" }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Show customers last updated before a specified date.(format: 2014-04-25T16:15:47-04:00)" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to show.\n (default: 50, maximum: 250)" }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer#index-2020-07" }, { "info": { "name": "Shopify Searches For Customers That Match A Supplied Query", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/customers/search.json", "params": [ { "name": "order", "value": "", "type": "query", "description": "Set the field and direction by which to order results.\n (default: last_order_date DESC)" }, { "name": "query", "value": "", "type": "query", "description": "Text to search for in the shop's customer data." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to show.\n (default: 50, maximum: 250)" }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer#search-2020-07" }, { "info": { "name": "Shopify Retrieves A Count Of All Customers", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/customers/count.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer#count-2020-07" }, { "info": { "name": "Shopify Retrieves A List Of Customers", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/customers.json", "params": [ { "name": "ids", "value": "", "type": "query", "description": "Restrict results to customers specified by a comma-separated list of IDs." }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to those after the specified ID." }, { "name": "created_at_min", "value": "", "type": "query", "description": "Show customers created after a specified date.(format: 2014-04-25T16:15:47-04:00)" }, { "name": "created_at_max", "value": "", "type": "query", "description": "Show customers created before a specified date.(format: 2014-04-25T16:15:47-04:00)" }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Show customers last updated after a specified date.(format: 2014-04-25T16:15:47-04:00)" }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Show customers last updated before a specified date.(format: 2014-04-25T16:15:47-04:00)" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to show.\n (default: 50, maximum: 250)" }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer#index-2020-10" }, { "info": { "name": "Shopify Searches For Customers That Match A Supplied Query", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/customers/search.json", "params": [ { "name": "order", "value": "", "type": "query", "description": "Set the field and direction by which to order results.\n (default: last_order_date DESC)" }, { "name": "query", "value": "", "type": "query", "description": "Text to search for in the shop's customer data." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to show.\n (default: 50, maximum: 250)" }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer#search-2020-10" }, { "info": { "name": "Shopify Retrieves A Count Of All Customers", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/customers/count.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer#count-2020-10" }, { "info": { "name": "Shopify Retrieves A List Of Customers", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/customers.json", "params": [ { "name": "ids", "value": "", "type": "query", "description": "Restrict results to customers specified by a comma-separated list of IDs." }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to those after the specified ID." }, { "name": "created_at_min", "value": "", "type": "query", "description": "Show customers created after a specified date.(format: 2014-04-25T16:15:47-04:00)" }, { "name": "created_at_max", "value": "", "type": "query", "description": "Show customers created before a specified date.(format: 2014-04-25T16:15:47-04:00)" }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Show customers last updated after a specified date.(format: 2014-04-25T16:15:47-04:00)" }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Show customers last updated before a specified date.(format: 2014-04-25T16:15:47-04:00)" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to show.\n (default: 50, maximum: 250)" }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer#index-2021-01" }, { "info": { "name": "Shopify Searches For Customers That Match A Supplied Query", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/customers/search.json", "params": [ { "name": "order", "value": "", "type": "query", "description": "Set the field and direction by which to order results.\n (default: last_order_date DESC)" }, { "name": "query", "value": "", "type": "query", "description": "Text to search for in the shop's customer data." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to show.\n (default: 50, maximum: 250)" }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer#search-2021-01" }, { "info": { "name": "Shopify Retrieves A Count Of All Customers", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/customers/count.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer#count-2021-01" }, { "info": { "name": "Shopify Retrieves A List Of Customers", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/customers.json", "params": [ { "name": "ids", "value": "", "type": "query", "description": "Restrict results to customers specified by a comma-separated list of IDs." }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to those after the specified ID." }, { "name": "created_at_min", "value": "", "type": "query", "description": "Show customers created after a specified date.(format: 2014-04-25T16:15:47-04:00)" }, { "name": "created_at_max", "value": "", "type": "query", "description": "Show customers created before a specified date.(format: 2014-04-25T16:15:47-04:00)" }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Show customers last updated after a specified date.(format: 2014-04-25T16:15:47-04:00)" }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Show customers last updated before a specified date.(format: 2014-04-25T16:15:47-04:00)" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to show.\n (default: 50, maximum: 250)" }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer#index-unstable" }, { "info": { "name": "Shopify Searches For Customers That Match A Supplied Query", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/customers/search.json", "params": [ { "name": "order", "value": "", "type": "query", "description": "Set the field and direction by which to order results.\n (default: last_order_date DESC)" }, { "name": "query", "value": "", "type": "query", "description": "Text to search for in the shop's customer data." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to show.\n (default: 50, maximum: 250)" }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer#search-unstable" }, { "info": { "name": "Shopify Retrieves A Count Of All Customers", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/customers/count.json" }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer#count-unstable" }, { "info": { "name": "Shopify Retrieves A List Of Addresses For A Customer", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/customers/:customer_id/addresses.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#index-2020-01" }, { "info": { "name": "Shopify Creates A New Address For A Customer", "type": "http" }, "http": { "method": "POST", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/customers/:customer_id/addresses.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#create-2020-01" }, { "info": { "name": "Shopify Retrieves Details A Single Customer Address", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/customers/:customer_id/addresses/:address_id.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" }, { "name": "address_id", "value": "", "type": "path", "description": "address_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#show-2020-01" }, { "info": { "name": "Shopify Updates An Existing Customer Address", "type": "http" }, "http": { "method": "PUT", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/customers/:customer_id/addresses/:address_id.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" }, { "name": "address_id", "value": "", "type": "path", "description": "address_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#update-2020-01" }, { "info": { "name": "Shopify Performs Bulk Operations For Multiple Customer Addresses", "type": "http" }, "http": { "method": "PUT", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/customers/:customer_id/addresses/set.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" }, { "name": "address_ids[]", "value": "", "type": "query", "description": "address_ids[]" }, { "name": "operation", "value": "", "type": "query", "description": "operation" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#set-2020-01" }, { "info": { "name": "Shopify Sets The Default Address For A Customer", "type": "http" }, "http": { "method": "PUT", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/customers/:customer_id/addresses/:address_id/default.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" }, { "name": "address_id", "value": "", "type": "path", "description": "address_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#default-2020-01" }, { "info": { "name": "Shopify Retrieves A List Of Addresses For A Customer", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/customers/:customer_id/addresses.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#index-2020-04" }, { "info": { "name": "Shopify Creates A New Address For A Customer", "type": "http" }, "http": { "method": "POST", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/customers/:customer_id/addresses.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#create-2020-04" }, { "info": { "name": "Shopify Retrieves Details A Single Customer Address", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/customers/:customer_id/addresses/:address_id.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" }, { "name": "address_id", "value": "", "type": "path", "description": "address_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#show-2020-04" }, { "info": { "name": "Shopify Updates An Existing Customer Address", "type": "http" }, "http": { "method": "PUT", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/customers/:customer_id/addresses/:address_id.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" }, { "name": "address_id", "value": "", "type": "path", "description": "address_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#update-2020-04" }, { "info": { "name": "Shopify Performs Bulk Operations For Multiple Customer Addresses", "type": "http" }, "http": { "method": "PUT", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/customers/:customer_id/addresses/set.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" }, { "name": "address_ids[]", "value": "", "type": "query", "description": "address_ids[]" }, { "name": "operation", "value": "", "type": "query", "description": "operation" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#set-2020-04" }, { "info": { "name": "Shopify Sets The Default Address For A Customer", "type": "http" }, "http": { "method": "PUT", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/customers/:customer_id/addresses/:address_id/default.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" }, { "name": "address_id", "value": "", "type": "path", "description": "address_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#default-2020-04" }, { "info": { "name": "Shopify Retrieves A List Of Addresses For A Customer", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/customers/:customer_id/addresses.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#index-2020-07" }, { "info": { "name": "Shopify Creates A New Address For A Customer", "type": "http" }, "http": { "method": "POST", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/customers/:customer_id/addresses.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#create-2020-07" }, { "info": { "name": "Shopify Retrieves Details A Single Customer Address", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/customers/:customer_id/addresses/:address_id.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" }, { "name": "address_id", "value": "", "type": "path", "description": "address_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#show-2020-07" }, { "info": { "name": "Shopify Updates An Existing Customer Address", "type": "http" }, "http": { "method": "PUT", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/customers/:customer_id/addresses/:address_id.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" }, { "name": "address_id", "value": "", "type": "path", "description": "address_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#update-2020-07" }, { "info": { "name": "Shopify Performs Bulk Operations For Multiple Customer Addresses", "type": "http" }, "http": { "method": "PUT", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/customers/:customer_id/addresses/set.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" }, { "name": "address_ids[]", "value": "", "type": "query", "description": "address_ids[]" }, { "name": "operation", "value": "", "type": "query", "description": "operation" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#set-2020-07" }, { "info": { "name": "Shopify Sets The Default Address For A Customer", "type": "http" }, "http": { "method": "PUT", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/customers/:customer_id/addresses/:address_id/default.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" }, { "name": "address_id", "value": "", "type": "path", "description": "address_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#default-2020-07" }, { "info": { "name": "Shopify Retrieves A List Of Addresses For A Customer", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/customers/:customer_id/addresses.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#index-2020-10" }, { "info": { "name": "Shopify Creates A New Address For A Customer", "type": "http" }, "http": { "method": "POST", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/customers/:customer_id/addresses.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#create-2020-10" }, { "info": { "name": "Shopify Retrieves Details A Single Customer Address", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/customers/:customer_id/addresses/:address_id.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" }, { "name": "address_id", "value": "", "type": "path", "description": "address_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#show-2020-10" }, { "info": { "name": "Shopify Updates An Existing Customer Address", "type": "http" }, "http": { "method": "PUT", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/customers/:customer_id/addresses/:address_id.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" }, { "name": "address_id", "value": "", "type": "path", "description": "address_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#update-2020-10" }, { "info": { "name": "Shopify Performs Bulk Operations For Multiple Customer Addresses", "type": "http" }, "http": { "method": "PUT", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/customers/:customer_id/addresses/set.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" }, { "name": "address_ids[]", "value": "", "type": "query", "description": "address_ids[]" }, { "name": "operation", "value": "", "type": "query", "description": "operation" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#set-2020-10" }, { "info": { "name": "Shopify Sets The Default Address For A Customer", "type": "http" }, "http": { "method": "PUT", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/customers/:customer_id/addresses/:address_id/default.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" }, { "name": "address_id", "value": "", "type": "path", "description": "address_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#default-2020-10" }, { "info": { "name": "Shopify Retrieves A List Of Addresses For A Customer", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/customers/:customer_id/addresses.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#index-2021-01" }, { "info": { "name": "Shopify Creates A New Address For A Customer", "type": "http" }, "http": { "method": "POST", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/customers/:customer_id/addresses.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#create-2021-01" }, { "info": { "name": "Shopify Retrieves Details A Single Customer Address", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/customers/:customer_id/addresses/:address_id.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" }, { "name": "address_id", "value": "", "type": "path", "description": "address_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#show-2021-01" }, { "info": { "name": "Shopify Updates An Existing Customer Address", "type": "http" }, "http": { "method": "PUT", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/customers/:customer_id/addresses/:address_id.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" }, { "name": "address_id", "value": "", "type": "path", "description": "address_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#update-2021-01" }, { "info": { "name": "Shopify Performs Bulk Operations For Multiple Customer Addresses", "type": "http" }, "http": { "method": "PUT", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/customers/:customer_id/addresses/set.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" }, { "name": "address_ids[]", "value": "", "type": "query", "description": "address_ids[]" }, { "name": "operation", "value": "", "type": "query", "description": "operation" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#set-2021-01" }, { "info": { "name": "Shopify Sets The Default Address For A Customer", "type": "http" }, "http": { "method": "PUT", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/customers/:customer_id/addresses/:address_id/default.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" }, { "name": "address_id", "value": "", "type": "path", "description": "address_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#default-2021-01" }, { "info": { "name": "Shopify Retrieves A List Of Addresses For A Customer", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/customers/:customer_id/addresses.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#index-unstable" }, { "info": { "name": "Shopify Creates A New Address For A Customer", "type": "http" }, "http": { "method": "POST", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/customers/:customer_id/addresses.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#create-unstable" }, { "info": { "name": "Shopify Retrieves Details A Single Customer Address", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/customers/:customer_id/addresses/:address_id.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" }, { "name": "address_id", "value": "", "type": "path", "description": "address_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#show-unstable" }, { "info": { "name": "Shopify Updates An Existing Customer Address", "type": "http" }, "http": { "method": "PUT", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/customers/:customer_id/addresses/:address_id.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" }, { "name": "address_id", "value": "", "type": "path", "description": "address_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#update-unstable" }, { "info": { "name": "Shopify Performs Bulk Operations For Multiple Customer Addresses", "type": "http" }, "http": { "method": "PUT", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/customers/:customer_id/addresses/set.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" }, { "name": "address_ids[]", "value": "", "type": "query", "description": "address_ids[]" }, { "name": "operation", "value": "", "type": "query", "description": "operation" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#set-unstable" }, { "info": { "name": "Shopify Sets The Default Address For A Customer", "type": "http" }, "http": { "method": "PUT", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/customers/:customer_id/addresses/:address_id/default.json", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "customer_id" }, { "name": "address_id", "value": "", "type": "path", "description": "address_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#default-unstable" }, { "info": { "name": "Shopify Retrieves A List Of Customer Saved Searches", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/customer_saved_searches.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to show.\n (default: 50, maximum: 250)" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#index-2020-01" }, { "info": { "name": "Shopify Creates A Customer Saved Search", "type": "http" }, "http": { "method": "POST", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/customer_saved_searches.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#create-2020-01" }, { "info": { "name": "Shopify Retrieves A Count Of All Customer Saved Searches", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/customer_saved_searches/count.json", "params": [ { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#count-2020-01" }, { "info": { "name": "Shopify Retrieves A Single Customer Saved Search", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/customer_saved_searches/:customer_saved_search_id.json", "params": [ { "name": "customer_saved_search_id", "value": "", "type": "path", "description": "customer_saved_search_id" }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#show-2020-01" }, { "info": { "name": "Shopify Updates A Customer Saved Search", "type": "http" }, "http": { "method": "PUT", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/customer_saved_searches/:customer_saved_search_id.json", "params": [ { "name": "customer_saved_search_id", "value": "", "type": "path", "description": "customer_saved_search_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#update-2020-01" }, { "info": { "name": "Shopify Deletes A Customer Saved Search", "type": "http" }, "http": { "method": "DELETE", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/customer_saved_searches/:customer_saved_search_id.json", "params": [ { "name": "customer_saved_search_id", "value": "", "type": "path", "description": "customer_saved_search_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#destroy-2020-01" }, { "info": { "name": "Shopify Retrieves All Customers Returned By A Customer Saved Search", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/customer_saved_searches/:customer_saved_search_id/customers.json", "params": [ { "name": "customer_saved_search_id", "value": "", "type": "path", "description": "customer_saved_search_id" }, { "name": "order", "value": "", "type": "query", "description": "Set the field and direction by which to order results.\n (default: last_order_date DESC)" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to show.\n (default: 50, maximum: 250)" }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#other-2020-01" }, { "info": { "name": "Shopify Retrieves A List Of Customer Saved Searches", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/customer_saved_searches.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to show.\n (default: 50, maximum: 250)" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#index-2020-04" }, { "info": { "name": "Shopify Creates A Customer Saved Search", "type": "http" }, "http": { "method": "POST", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/customer_saved_searches.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#create-2020-04" }, { "info": { "name": "Shopify Retrieves A Count Of All Customer Saved Searches", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/customer_saved_searches/count.json", "params": [ { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#count-2020-04" }, { "info": { "name": "Shopify Retrieves A Single Customer Saved Search", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/customer_saved_searches/:customer_saved_search_id.json", "params": [ { "name": "customer_saved_search_id", "value": "", "type": "path", "description": "customer_saved_search_id" }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#show-2020-04" }, { "info": { "name": "Shopify Updates A Customer Saved Search", "type": "http" }, "http": { "method": "PUT", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/customer_saved_searches/:customer_saved_search_id.json", "params": [ { "name": "customer_saved_search_id", "value": "", "type": "path", "description": "customer_saved_search_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#update-2020-04" }, { "info": { "name": "Shopify Deletes A Customer Saved Search", "type": "http" }, "http": { "method": "DELETE", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/customer_saved_searches/:customer_saved_search_id.json", "params": [ { "name": "customer_saved_search_id", "value": "", "type": "path", "description": "customer_saved_search_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#destroy-2020-04" }, { "info": { "name": "Shopify Retrieves All Customers Returned By A Customer Saved Search", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/customer_saved_searches/:customer_saved_search_id/customers.json", "params": [ { "name": "customer_saved_search_id", "value": "", "type": "path", "description": "customer_saved_search_id" }, { "name": "order", "value": "", "type": "query", "description": "Set the field and direction by which to order results.\n (default: last_order_date DESC)" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to show.\n (default: 50, maximum: 250)" }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#other-2020-04" }, { "info": { "name": "Shopify Retrieves A List Of Customer Saved Searches", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/customer_saved_searches.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to show.\n (default: 50, maximum: 250)" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#index-2020-07" }, { "info": { "name": "Shopify Creates A Customer Saved Search", "type": "http" }, "http": { "method": "POST", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/customer_saved_searches.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#create-2020-07" }, { "info": { "name": "Shopify Retrieves A Count Of All Customer Saved Searches", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/customer_saved_searches/count.json", "params": [ { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#count-2020-07" }, { "info": { "name": "Shopify Retrieves A Single Customer Saved Search", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/customer_saved_searches/:customer_saved_search_id.json", "params": [ { "name": "customer_saved_search_id", "value": "", "type": "path", "description": "customer_saved_search_id" }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#show-2020-07" }, { "info": { "name": "Shopify Updates A Customer Saved Search", "type": "http" }, "http": { "method": "PUT", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/customer_saved_searches/:customer_saved_search_id.json", "params": [ { "name": "customer_saved_search_id", "value": "", "type": "path", "description": "customer_saved_search_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#update-2020-07" }, { "info": { "name": "Shopify Deletes A Customer Saved Search", "type": "http" }, "http": { "method": "DELETE", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/customer_saved_searches/:customer_saved_search_id.json", "params": [ { "name": "customer_saved_search_id", "value": "", "type": "path", "description": "customer_saved_search_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#destroy-2020-07" }, { "info": { "name": "Shopify Retrieves All Customers Returned By A Customer Saved Search", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/customer_saved_searches/:customer_saved_search_id/customers.json", "params": [ { "name": "customer_saved_search_id", "value": "", "type": "path", "description": "customer_saved_search_id" }, { "name": "order", "value": "", "type": "query", "description": "Set the field and direction by which to order results.\n (default: last_order_date DESC)" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to show.\n (default: 50, maximum: 250)" }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#other-2020-07" }, { "info": { "name": "Shopify Retrieves A List Of Customer Saved Searches", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/customer_saved_searches.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to show.\n (default: 50, maximum: 250)" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#index-2020-10" }, { "info": { "name": "Shopify Creates A Customer Saved Search", "type": "http" }, "http": { "method": "POST", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/customer_saved_searches.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#create-2020-10" }, { "info": { "name": "Shopify Retrieves A Count Of All Customer Saved Searches", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/customer_saved_searches/count.json", "params": [ { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#count-2020-10" }, { "info": { "name": "Shopify Retrieves A Single Customer Saved Search", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/customer_saved_searches/:customer_saved_search_id.json", "params": [ { "name": "customer_saved_search_id", "value": "", "type": "path", "description": "customer_saved_search_id" }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#show-2020-10" }, { "info": { "name": "Shopify Updates A Customer Saved Search", "type": "http" }, "http": { "method": "PUT", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/customer_saved_searches/:customer_saved_search_id.json", "params": [ { "name": "customer_saved_search_id", "value": "", "type": "path", "description": "customer_saved_search_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#update-2020-10" }, { "info": { "name": "Shopify Deletes A Customer Saved Search", "type": "http" }, "http": { "method": "DELETE", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/customer_saved_searches/:customer_saved_search_id.json", "params": [ { "name": "customer_saved_search_id", "value": "", "type": "path", "description": "customer_saved_search_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#destroy-2020-10" }, { "info": { "name": "Shopify Retrieves All Customers Returned By A Customer Saved Search", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/customer_saved_searches/:customer_saved_search_id/customers.json", "params": [ { "name": "customer_saved_search_id", "value": "", "type": "path", "description": "customer_saved_search_id" }, { "name": "order", "value": "", "type": "query", "description": "Set the field and direction by which to order results.\n (default: last_order_date DESC)" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to show.\n (default: 50, maximum: 250)" }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#other-2020-10" }, { "info": { "name": "Shopify Retrieves A List Of Customer Saved Searches", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/customer_saved_searches.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to show.\n (default: 50, maximum: 250)" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#index-2021-01" }, { "info": { "name": "Shopify Creates A Customer Saved Search", "type": "http" }, "http": { "method": "POST", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/customer_saved_searches.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#create-2021-01" }, { "info": { "name": "Shopify Retrieves A Count Of All Customer Saved Searches", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/customer_saved_searches/count.json", "params": [ { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#count-2021-01" }, { "info": { "name": "Shopify Retrieves A Single Customer Saved Search", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/customer_saved_searches/:customer_saved_search_id.json", "params": [ { "name": "customer_saved_search_id", "value": "", "type": "path", "description": "customer_saved_search_id" }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#show-2021-01" }, { "info": { "name": "Shopify Updates A Customer Saved Search", "type": "http" }, "http": { "method": "PUT", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/customer_saved_searches/:customer_saved_search_id.json", "params": [ { "name": "customer_saved_search_id", "value": "", "type": "path", "description": "customer_saved_search_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#update-2021-01" }, { "info": { "name": "Shopify Deletes A Customer Saved Search", "type": "http" }, "http": { "method": "DELETE", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/customer_saved_searches/:customer_saved_search_id.json", "params": [ { "name": "customer_saved_search_id", "value": "", "type": "path", "description": "customer_saved_search_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#destroy-2021-01" }, { "info": { "name": "Shopify Retrieves All Customers Returned By A Customer Saved Search", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/customer_saved_searches/:customer_saved_search_id/customers.json", "params": [ { "name": "customer_saved_search_id", "value": "", "type": "path", "description": "customer_saved_search_id" }, { "name": "order", "value": "", "type": "query", "description": "Set the field and direction by which to order results.\n (default: last_order_date DESC)" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to show.\n (default: 50, maximum: 250)" }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#other-2021-01" }, { "info": { "name": "Shopify Retrieves A List Of Customer Saved Searches", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/customer_saved_searches.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to show.\n (default: 50, maximum: 250)" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#index-unstable" }, { "info": { "name": "Shopify Creates A Customer Saved Search", "type": "http" }, "http": { "method": "POST", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/customer_saved_searches.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#create-unstable" }, { "info": { "name": "Shopify Retrieves A Count Of All Customer Saved Searches", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/customer_saved_searches/count.json", "params": [ { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#count-unstable" }, { "info": { "name": "Shopify Retrieves A Single Customer Saved Search", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/customer_saved_searches/:customer_saved_search_id.json", "params": [ { "name": "customer_saved_search_id", "value": "", "type": "path", "description": "customer_saved_search_id" }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#show-unstable" }, { "info": { "name": "Shopify Updates A Customer Saved Search", "type": "http" }, "http": { "method": "PUT", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/customer_saved_searches/:customer_saved_search_id.json", "params": [ { "name": "customer_saved_search_id", "value": "", "type": "path", "description": "customer_saved_search_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#update-unstable" }, { "info": { "name": "Shopify Deletes A Customer Saved Search", "type": "http" }, "http": { "method": "DELETE", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/customer_saved_searches/:customer_saved_search_id.json", "params": [ { "name": "customer_saved_search_id", "value": "", "type": "path", "description": "customer_saved_search_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#destroy-unstable" }, { "info": { "name": "Shopify Retrieves All Customers Returned By A Customer Saved Search", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/customer_saved_searches/:customer_saved_search_id/customers.json", "params": [ { "name": "customer_saved_search_id", "value": "", "type": "path", "description": "customer_saved_search_id" }, { "name": "order", "value": "", "type": "query", "description": "Set the field and direction by which to order results.\n (default: last_order_date DESC)" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to show.\n (default: 50, maximum: 250)" }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#other-unstable" } ] } ], "bundled": true }