{ "opencollection": "1.0.0", "info": { "name": "BigCommerce Abandoned Cart Emails Addresses API", "version": "3.0.0" }, "request": { "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "items": [ { "info": { "name": "Addresses", "type": "folder" }, "items": [ { "info": { "name": "BigCommerce Get All Customer Addresses", "type": "http" }, "http": { "method": "GET", "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/customers/addresses", "headers": [ { "name": "Accept", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "page", "value": "", "type": "query", "description": "Page number. `page=1`" }, { "name": "limit", "value": "", "type": "query", "description": "Items count per page. `limit=50`" }, { "name": "company:in", "value": "", "type": "query", "description": "Filter items by company. `company:in=bigcommerce,commongood`" }, { "name": "name:in", "value": "", "type": "query", "description": "Filter items by first_name and last_name. `name:in=James+Moriarty`" }, { "name": "customer_id:in", "value": "", "type": "query", "description": "Filter by the ID of the customer. Also accepts comma-separated IDs to filter for multiple customers. `customer_id:in=23,24,55`" }, { "name": "include", "value": "", "type": "query", "description": "Indicates whether to include customer address sub-resources:\n* `formfields` - address form fields\n`include=formfields`" }, { "name": "id:in", "value": "", "type": "query", "description": "Filter items by ID.\n`id:in=4,5,6`" } ] }, "docs": "Returns a list of Customer Addresses. Optional filter parameters can be passed in." }, { "info": { "name": "BigCommerce Create a Customer Address", "type": "http" }, "http": { "method": "POST", "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/customers/addresses", "headers": [ { "name": "Accept", "value": "" }, { "name": "Content-Type", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a Customer Address. Multiple customer addresses can be created in one call.\n\n**Required Fields**\n* **customer_id**\n* **first_name**\n* **last_name**\n* **city**\n* **country_code**\n* **address1**\n\n**Notes**\n* A unique customer address is a combination of the following core address fields:\n * **customer_id**\n * **first_name**\n * **last_name**\n * **company**\n * **phone**\n * **address_type**\n * **address1**\n * **address2**\n * **city**\n * **country_code**\n * **state_or_province**\n *" }, { "info": { "name": "BigCommerce Update a Customer Address", "type": "http" }, "http": { "method": "PUT", "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/customers/addresses", "headers": [ { "name": "Accept", "value": "" }, { "name": "Content-Type", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a Customer Address. Multiple customer addresses can be updated in one call.\n\n**Required Fields**\n* **id** -- ID of the *Customer Address*\n\n**Limits**\n* Limit of **3** concurrent requests.\n\n**Notes**\n* A unique customer address is a combination of the following core address fields:\n * **first_name**\n * **last_name**\n * **company**\n * **phone**\n * **address_type**\n * **address1**\n * **address2**\n * **city**\n * **country_code**\n * **state_or_province**\n * **postal_code**\n* An att" }, { "info": { "name": "BigCommerce Delete a Customer Address", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/customers/addresses", "headers": [ { "name": "Accept", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "id:in", "value": "", "type": "query", "description": "Filter items by ID.\n`id:in=4,5,6`" } ] }, "docs": "Deletes a Customer Address.\n\n**Required Query**\n* id:in -- ID of the *Customer Address*" } ] } ], "bundled": true }