Docs
Management API
Pickup

Pickup

This API endpoint enables you to manage pickups.

Get Pickups

GET /orders/pickups

Request

Retrieves a list of pickups.

Examples

You can filter the list to return pickup objects specific to a list of requested pickup or order IDs. This is achieved by appending the query string ?order_id:in=100,103,202 or pickup_id:in=1,4 to the resource /orders/pickups.

GET /orders/pickups?order_id:in=100,300,500

or http GET /orders/pickups?pickup_id:in=7,13,17

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.
  • order_id:in in query - integer
    Comma separated list of order IDs.
  • pickup_id:in in query - integer
    Comma separated list of pickup IDs.

example

Response

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

Body

object | application/json

  • data    array[object]

example

Create Pickups

POST /orders/pickups

Request

Creates one or many pickups.

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

Limits

  • Limit of creating 100 pickup 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

  • pickup_method_id    integer
    required

    ID of pickup method.
    Min: 1
    Example: 2

  • order_id    integer
    required

    ID of order.
    Min: 1
    Example: 103

  • ready_at    string
    required

    Can be provided as two inputs. Unix: Represents the time in seconds that has elapsed since Unix epoch (00:00:00 UTC on 1 January 1970) ISO-8601: Represents the time in ISO format.

    Example: '1660555844' or '2022-06-11T00:00:20Z'

  • collected_at    string

    Can be provided as two inputs. Unix: Represents the time in seconds that has elapsed since Unix epoch (00:00:00 UTC on 1 January 1970). ISO-8601: Represents the time in ISO format. If this value is not supplied, the pickup item collected_at property will be null.

    Example: '1660831392' or '2022-06-18T00:00:30Z'

  • pickup_items    array[object]
    required

example

Response

The request has been successfully processed.

Body

object | application/json

  • data    array[object]

  • meta    object

example

Delete Pickups

DELETE /orders/pickups

Request

Delete pickups by providing a list of pickup_ids.

Examples

You can use the list of pickup_ids to delete the pickup items. This is achieved by appending the query string ?id:in=1,2,3 to the resource /pickup.

DELETE /pickup?id:in=1,2,3

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 IDs.

example

Response

No Content

Update Pickups

PUT /orders/pickups

Request

Update pickups by providing pickup_id, collected_at, and ready_at in the input.

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
    required
    deprecated

    Min: 1
    Example: 2

  • pickup_id    integer
    required

    The ID of pickup.
    Min: 1
    Example: 2

  • ready_at    string

    Can be provided as two inputs. Unix: Represents the time in seconds that has elapsed since Unix epoch (00:00:00 UTC on 1 January 1970) ISO-8601: Represents the time in ISO format.

    Example: '1660555844' or '2022-06-11T00:00:20Z'

  • collected_at    string

    Can be provided as two inputs. Unix: Represents the time in seconds that has elapsed since Unix epoch (00:00:00 UTC on 1 January 1970). ISO-8601: Represents the time in ISO format. If this value is not supplied, the pickup item collected_at property will be null.

    Example: '1660831392' or '2022-06-18T00:00:30Z'

example

Response

The request has been successfully processed.

Body

object | application/json

  • data    array[object]

  • meta    object

example

See something you can improve? Edit this file on GitHub

Did you find what you were looking for?
Get All RefundsGet Pickups