List Pickups

Obtains a list of pickups that match the specified criteria. Unless the start_date or end_date is specified will default to only show the future pickups.

HTTP Request

GET /api/v1/pickups/

Parameters

Attribute	Required	Type	Specification
per_page	`optional`	integer	Requested page size. Max value is 500. Defaults to 100
page	`optional`	integer	Page Number
start_date	`optional`	string	Returns Pickups that were created after the specified date
end_date	`optional`	string	Returns Pickups that were created before the specified date

Example

  {
      per_page: 20
      page: 5
      start_date: 2021-10-02
      end_date: 2021-10-04
  }

  {
    "data": [
      {
        "id": 1324,
        "confirmation_number": "YKZA-131",
        "courier": "FedEx",
        "service": "FEDEX_2_DAY",
        "number_of_boxes": 1,
        "total_weight": 1,
        "weight_unit": "LB",
        "pickup_location": {
          "company": "LABELNSHIP CORP",
          "name": "LABELNSHIP CORP",
          "street_address": "22 ATLAS AVE",
          "street_address2": null,
          "city": "YORK",
          "province": "ON",
          "postal_code": "L4J3J8",
          "country": "CA",
          "phone": "514-555-5555",
          "pickup_instructions": "Please use side door"
        },
        "pickup_window": {
          "min": "2021-10-19 12:00:00",
          "max": "2021-10-19 17:00:00"
        },
        "created_at": "2021-10-18 16:27:53",
        "updated_at": "2021-10-18 16:27:53"
      }
    ],
    "links": {
      "first": "/api/v1/pickups?page=1",
      "last": "/api/v1/pickups?page=1",
      "prev": null,
      "next": null
    },
    "meta": {
      "current_page": 1,
      "from": 1,
      "last_page": 1,
      "links": [
        {
          "url": null,
          "label": "&laquo; Previous",
          "active": false
        },
        {
          "url": "/api/v1/pickups?page=1",
          "label": "1",
          "active": true
        },
        {
          "url": null,
          "label": "Next &raquo;",
          "active": false
        }
      ],
      "path": "/api/v1/pickups",
      "per_page": 100,
      "to": 1,
      "total": 1
    }
  }