Docs
Management API
Pickup methods

Pickup Methods

This API endpoint enables you to manage pickup methods.

Get Pickup Methods

GET /pickup/methods

Request

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-Token in header

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string
    required
    The MIME type of the response body.
  • id:in in query - integer
    Comma separated list of pickup method IDs.
  • limit in query - integer
    Maximum number of results per page.
  • page in query - integer
    The number of the page to be fetched.
  • date_created in query - string

    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:min in query - string

    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:max in query - string

    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_modified in query - string

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

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

  • date_modified:min in query - string

    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:max in query - string

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

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

  • sort in query - string

    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: date_modified:asc | date_modified:desc | name:asc | name:desc

example

curl --request GET \
--url 'https://api.bigcommerce.com/stores/[store_hash]/v3/pickup/methods' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: {{token}}'

Response

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

Body

object | application/json

  • data    array[object]

  • meta    object

example

{
"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",
"location_identity": 2,
"date_created": "2023-06-06T00:00:20Z",
"date_modified": "2023-06-08T00:00:20Z"
}
],
"meta": {
"pagination": {
"total": 123,
"count": 100,
"per_page": 100,
"current_page": 1,
"total_pages": 2,
"links": {
"previous": "string",
"current": "string",
"next": "string"
}
}
}

Create Pickup Methods

POST /pickup/methods

Request

Creates one or many pickup methods.

This is a batch operation that can create up to 100 pickup methods objects in one request.

Limits

  • Limit of creating 100 pickup method objects per POST request.

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string
    required
    The MIME type of the response body.
  • Content-Type in header with default of application/json - string
    required
    The MIME type of the request body.

Body

array | application/json

  • location_id    integer

    The ID of the location.
    Example: 2

  • display_name    string

    Title of the pickup method.
    >= 0 characters<= 250 characters
    Example: Office Pickup!

  • collection_instructions    string

    Instructions for picking up items.
    >= 0 characters<= 250 characters
    Example: Bring your ID!

  • collection_time_description    string

    The description of collection time.
    >= 0 characters<= 250 characters
    Example: Collect during our opening hours of 0900 - 1700

  • location_identity    integer
    deprecated

    Example: 2

example

[
{
"location_id": 2,
"display_name": "Office Pickup!",
"collection_instructions": "Bring your ID!",
"collection_time_description": "Collect during our opening hours of 0900 - 1700",
"location_identity": 2
}
]

Response

The request has been successfully processed.

Body

object | application/json

  • data    array[object]

  • meta    object

example

{
"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",
"location_identity": 2,
"date_created": "2023-06-06T00:00:20Z",
"date_modified": "2023-06-08T00:00:20Z"
}
],
"meta": {}
}

Update Pickup Methods

PUT /pickup/methods

Request

Update existing pickup methods.

This batch operation can update 10 pickup method objects in one request.

Only the id property of the pickup method object is required as part of the request. Pickup method properties that are not provided will maintain their existing values.

Limits

  • Limit of updating 10 pickup method objects per PUT request.

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string
    required
    The MIME type of the response body.
  • Content-Type in header with default of application/json - string
    required
    The MIME type of the request body.

Body

array | application/json

  • id    integer

    The ID of the pickup method.
    Example: 1

  • location_id    integer

    The ID of the location.
    Example: 2

  • display_name    string

    Title of the pickup method.
    >= 0 characters<= 250 characters
    Example: Office Pickup!

  • collection_instructions    string

    Instructions for picking up items.
    >= 0 characters<= 250 characters
    Example: Bring your ID!

  • collection_time_description    string

    The description of collection time.
    >= 0 characters<= 250 characters
    Example: Collect during our opening hours of 0900 - 1700

  • location_identity    integer
    deprecated

    Example: 2

example

[
{
"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",
"location_identity": 2
}
]

Response

The request has been successfully processed.

Body

object | application/json

  • data    array[object]

  • meta    object

example

{
"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",
"location_identity": 2,
"date_created": "2023-06-06T00:00:20Z",
"date_modified": "2023-06-08T00:00:20Z"
}
],
"meta": {}
}

Delete Pickup Methods

DELETE /pickup/methods

Request

Delete existing pickup methods.

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string
    required
    The MIME type of the response body.
  • id:in in query - integer
    required
    Comma separated list of pickup method IDs.

example

curl --request DELETE \
--url 'https://api.bigcommerce.com/stores/[store_hash]/v3/pickup/methods' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: {{token}}'

Response

No Content

See something you can improve? Edit this file on GitHub

Did you find what you were looking for?
Update PickupsGet Pickup Methods