We will sunset v2 of the Content API on March 29th, 2021. To avoid disruptions with your integration, please migrate to v2.1 as soon as possible. For more information, see Migrating to v2.1.

Using Pickup/Collection Points

This guide explains the details of pickup-point orders, how they differ from home delivery orders, and what pickup-specific information needs to be processed.

Order details

The orders.list or orders.get method return order information. For example, the URL to call Orders.list would be:

GET https://www.googleapis.com/content/v2.1/{merchantId}/orders

Below is a sample JSON response showing the details of an order with pickup as the delivery option.

Fields to note

Field Description
shippingDetails.type The delivery type: delivery for home delivery orders or pickup for pickup-point orders.
shippingDetails.carrier The pickup-point network used for the order.
pickupDetails.collectors The name(s) and contact telephone number(s) of the person(s) authorized to collect the package from the pickup point. These are provided by the customer at the time of the order.
pickupDetails.locationId The ID of the pickup-point location, as specified by the pickup-point provider.
pickupDetails.address The address of the pickup-point location. For pickup orders, the recipient name is the name of the business that houses the pickup point.

Sample response

"kind": "content#order",
"id": "foo",
"merchantId": 123,
"merchantOrderId": "bar",
"customer": {
  "fullName": "John Doe"
},
"lineItems": [
  {
    "id": "sample_line_item_1",
    "shippingDetails": {
      "method": {
        "type": "pickup",
        "methodName": "Standard",
        "carrier": "Colissimo",
        "minDaysInTransit": 1,
        "maxDaysInTransit": 2
      },
      "shipByDate": 2019-01-01,
      "deliverByDate": 2019-01-03
    }
  }
],
"pickupDetails": {
  "collectors": [
    {
      "name": Jane Doe,
      "phoneNumber": +XX XX XXX XX XX
    }
  ],
  "locationId": “qwerty”,
  "address": {
    "recipientName": "Pickup Point Name",
    "streetAddress": ["8 Rue de Londres"],
    "locality": "Paris",
    "region": "Ile-de-France",
    "country": "France",
    "postalCode": "75009",
    "isPostOfficeBox": false,
    "fullAddress": [
      "Pickup Point Name",
      "8 Rue de Londres",
      "75009 Paris",
      "France"
  }
},

Updating pickup-point order shipping status

You can update the status of pickup-point orders using the same methods as for home delivery orders: shiplineitems and updateshipment. For more information, see Using the Orders API.

When working with pickup-point orders, please keep the following points in mind:

  • Make sure that the trackingID and carrier for the shipment are set correctly. The value of trackingID should be the value provided by the pickup-point network.
  • Google will update the shipment status to readyForPickup once the order is delivered to the pickup point. This status is returned when calling orders.list or orders.get.
  • Once the item has been collected by the customer Google will update the shipment status to delivered. This status is returned when calling order.list or orders.get.