CLcloudkitchens
orders_endpoints

Update order delivery information

Updates the delivery information for the order identified by orderId — courier details, destination address, vehicle, last known location, and dropoff instructions. Use it to keep delivery state current as the courier progresses. The update is processed asynchronously and returns 202 Accepted. Rate limit: 8 requests per minute.

put/v1/orders/{orderId}/delivery

Request

Path parameters

orderIdstring required

The external order identifier supplied by your app in externalIdentifiers.id when the order was created.

Example:295f76b4-5725-4bf5-a8ab-97943dbdc3b4

Headers

X-Store-Idstring required

The unique identifier of the store in your app. This ID, along with the Application ID, will be used to match the correct store when performing operations. It cannot be longer than 255 characters and must only contain printable ASCII characters. During on-boarding, this ID will be similar to onboarding:905bb725-b141-4a9b-832a-1f254f772c94 (where the UUID is the Internal Store ID). During off-boarding, this field will be filled with the last known Store ID, or with an empty string, in case none is found. In that case, please fall back to the provided internalStoreId (a.k.a. Sku-Sku ID).

Example:partner-store-unique-identifier

Request body

Example request

{
  "deliveryInfo": {
    "courier": {
      "name": "Jane Doe",
      "phone": "+1-555-555-5555",
      "phoneCode": "111 11 111",
      "email": "email@email.com",
      "personalIdentifiers": {
        "serviceProviderId": "12345ba6-789e-123f-4e56-d78db90d123b"
      }
    },
    "destination": {
      "fullAddress": "123 Sample Street Ste 100, San Francisco, CA 94103",
      "postalCode": "20500",
      "city": "Washington",
      "state": "DC",
      "countryCode": "US",
      "addressLines": [
        "1600 Pennsylvania Avenue NW",
        "123 Sample Street Ste 100, San Francisco, CA 94103"
      ],
      "linesOfAddress": [
        "1600 Pennsylvania Avenue NW",
        "123 Sample Street Ste 100, San Francisco, CA 94103"
      ],
      "location": {
        "latitude": 38.8977,
        "longitude": 77.0365
      }
    },
    "licensePlate": "ABC 123",
    "makeModel": "Honda CR-V",
    "lastKnownLocation": {
      "latitude": 38.8977,
      "longitude": 77.0365
    },
    "dropoffInstructions": {
      "verificationRequirements": {
        "signatureRequirement": {
          "enabled": true,
          "collectSignerName": true,
          "collectSignerRelationship": true
        },
        "pictureRequirement": {
          "enabled": true
        }
      }
    },
    "note": "Gate code 123"
  }
}

Response

The order delivery information was successfully accepted.

Changes

No recorded changes to this operation across all 1 revision of this API.