List Pickup Methods

GET

https://api.bigcommerce.com/stores/:store_hash/v3/pickup/methods

GET

/stores/:store_hash/v3/pickup/methods

curl -G https://api.bigcommerce.com/stores/store_hash/v3/pickup/methods \
     -H "Accept: application/json" \
     -H "X-Auth-Token: <apiKey>" \
     --data-urlencode date_created=2023-09-07T06:23:13Z \
     --data-urlencode date_created:max=2023-09-07T06:23:13Z \
     --data-urlencode date_created:min=2023-09-07T06:23:13Z \
     --data-urlencode date_modified=2023-09-07T06:23:13Z \
     --data-urlencode date_modified:max=2023-09-07T06:23:13Z \
     --data-urlencode date_modified:min=2023-09-07T06:23:13Z

200Retrieved

{
  "data": [
    {
      "id": 1,
      "location_id": 2,
      "display_name": "Office Pickup!",
      "collection_instructions": "Bring your ID!",
      "collection_time_description": "Collect during our opening hours of 0900 - 1700",
      "date_created": "2023-06-06T00:00:20Z",
      "date_modified": "2023-06-08T00:00:20Z",
      "location_identity": 2
    }
  ],
  "meta": {
    "pagination": {
      "total": 123,
      "count": 100,
      "per_page": 100,
      "current_page": 1,
      "total_pages": 2,
      "links": {
        "previous": "string",
        "current": "string",
        "next": "string"
      }
    }
  }
}

Retrieves a list of pickup methods.

Examples

You can filter this list to return pickup method objects specific to a list of requested pickup method IDs. This is achieved by appending the query string ?id:in=1,3,5 to the resource /pickup/methods.

GET /pickup/methods?id:in=1,3,5

Authentication

X-Auth-Tokenstring

OAuth scopes

UI Name	Permission	Parameter
Order Fulfillment	read-only	`store_order_fulfillment_read_only`
Order Fulfillment	modify	`store_order_fulfillment_manage`

Authentication header

Header	Argument	Description
`X-Auth-Token`	`access_token`	For more about API accounts that generate `access_token`s, see API Accounts and OAuth Scopes.

Path parameters

store_hashstringRequired

Permanent ID of the BigCommerce store.

Query parameters

id:inlongOptional

Comma separated list of pickup method IDs.

limitlongOptional

Maximum number of results per page.

pagelongOptional

The number of the page to be fetched.

date_createddatetimeOptional

Filter pickup methods by the date created. Return methods created on the provided date.

For example, date_created=2023-09-07T06:23:13Z.

date_created:mindatetimeOptional

Filter pickup methods by minimum date created. Return methods created after the provided date.

For example, date_created:min=2023-09-07T06:23:13Z.

date_created:maxdatetimeOptional

Filter pickup methods by maximum date created. Return methods created before the provided date.

For example, date_created:max=2023-09-07T06:23:13Z.

date_modifieddatetimeOptional

Filter pickup methods by date modified. Return methods modified on the provided date.

For example, date_modified=2023-09-07T06:23:13Z.

date_modified:mindatetimeOptional

Filter pickup methods by minimum date modified. Return methods modified after the provided date.

For example, date_modified:min=2023-09-07T06:23:13Z.

date_modified:maxdatetimeOptional

Filter pickup methods by maximum date modified. Return methods modified before the provided date.

For example, date_modified:max=2023-09-07T06:23:13Z.

sortenumOptional

Sort pickup methods by date_modified:* or name:* ; for example, sort=name:asc.

date_modified:asc - sort by date modified in ascending order
date_modified:desc - sort by date modified in descending order
name:asc - sort by name in ascending order
name:desc - sort by name in descending order

Allowed values:

Response

The request has been processed and a list of pickup methods has been returned successfully.

datalist of objectsOptional

metaobjectOptional