Update the DoorDash courier tip

PUT /locations/{locationId}/carts/{cartId}/courier-tip

Update the DoorDash courier tip

cURL

curl --request PUT \
  --url https://api.craveup.com/api/v1/storefront/locations/{locationId}/carts/{cartId}/courier-tip \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --header 'If-Match: <if-match>' \
  --header 'X-Cart-Token: <api-key>' \
  --data '
{
  "amount": "<string>"
}
'

200

{
  "id": "<string>",
  "locationId": "<string>",
  "merchantId": "<string>",
  "status": "OPEN",
  "revision": 4503599627370495,
  "expiresAt": "2023-11-07T05:31:56Z",
  "authorityContext": {
    "version": 1,
    "organizationId": "<string>",
    "locationId": "<string>",
    "profile": "crave_commerce",
    "cartId": "<string>",
    "cartRevision": 4503599627370495,
    "catalogPublicationRevision": 4503599627370496,
    "resolvedCatalogSnapshotRevision": 4503599627370496,
    "commercePolicyRevision": 4503599627370495,
    "providerBindingRevision": 4503599627370496,
    "authority": {
      "operationalCatalog": "crave",
      "quote": "crave",
      "payment": "stripe",
      "refund": "stripe",
      "benefits": "crave_lip",
      "orderRouting": "crave",
      "fulfillment": "crave"
    }
  },
  "quoteFingerprint": "<string>",
  "quoteExpiresAt": "2023-11-07T05:31:56Z",
  "catalogRevalidation": {
    "required": true,
    "reasonCodes": [
      "ITEM_SOLD_OUT"
    ],
    "changeSet": {
      "version": 1,
      "previous": {
        "cartRevision": 4503599627370495,
        "catalogPublicationRevision": 4503599627370496,
        "resolvedCatalogSnapshotRevision": 4503599627370496,
        "commercePolicyRevision": 4503599627370495,
        "providerBindingRevision": 4503599627370496
      },
      "current": {
        "cartRevision": 4503599627370495,
        "catalogPublicationRevision": 4503599627370496,
        "resolvedCatalogSnapshotRevision": 4503599627370496,
        "commercePolicyRevision": 4503599627370495,
        "providerBindingRevision": 4503599627370496
      },
      "reasonCodes": [
        "ITEM_SOLD_OUT"
      ],
      "changes": [
        {
          "reason": "ITEM_SOLD_OUT",
          "cartItemId": "<string>",
          "canonicalEntityId": "<string>",
          "path": "<string>",
          "before": "<string>",
          "after": "<string>",
          "permittedActions": [
            "ACCEPT_CHANGES"
          ]
        }
      ],
      "blocking": true,
      "reconfirmationRequired": true,
      "invalidatedEvidence": {
        "quote": true,
        "benefits": true,
        "paymentAuthorization": true
      }
    },
    "checkedAt": "2023-11-07T05:31:56Z",
    "acknowledgedAt": "2023-11-07T05:31:56Z"
  },
  "restaurantDisplayName": "<string>",
  "fulfilmentMethod": "takeout",
  "fulfillmentIdentifier": "<string>",
  "pickupType": "ASAP",
  "orderDate": "<string>",
  "orderTime": "<string>",
  "currency": "usd",
  "subTotal": "<string>",
  "subTotalFormatted": "<string>",
  "discountTotal": "<string>",
  "discountTotalFormatted": "<string>",
  "waiterTipTotal": "<string>",
  "waiterTipTotalFormatted": "<string>",
  "taxTotal": "<string>",
  "taxTotalFormatted": "<string>",
  "taxAndFeeTotal": "<string>",
  "taxAndFeeTotalFormatted": "<string>",
  "serviceFeeTotal": "<string>",
  "serviceFeeTotalFormatted": "<string>",
  "paymentProcessingFeeTotal": "<string>",
  "paymentProcessingFeeTotalFormatted": "<string>",
  "applicationFeeTotal": "<string>",
  "applicationFeeTotalFormatted": "<string>",
  "netSalesTotal": "<string>",
  "netSalesTotalFormatted": "<string>",
  "fulfillmentMethodFeeTotal": "<string>",
  "fulfillmentMethodFeeTotalFormatted": "<string>",
  "orderTotal": "<string>",
  "orderTotalFormatted": "<string>",
  "orderTotalWithServiceFee": "<string>",
  "orderTotalWithServiceFeeFormatted": "<string>",
  "orderTotalWithServiceFeeAmount": 4503599627370495,
  "enterpriseFeeTotal": "<string>",
  "enterpriseFeeTotalFormatted": "<string>",
  "subTotalWithoutDiscount": "<string>",
  "subTotalWithoutDiscountFormatted": "<string>",
  "statementDescriptor": "<string>",
  "totalQuantity": 4503599627370495,
  "items": [
    {
      "id": "<string>",
      "productId": "<string>",
      "name": "<string>",
      "description": "<string>",
      "imageUrl": "<string>",
      "price": "<string>",
      "priceFormatted": "<string>",
      "quantity": 4503599627370495,
      "total": "<string>",
      "totalFormatted": "<string>",
      "discount": "<string>",
      "discountFormatted": "<string>",
      "categoryId": "<string>",
      "itemUnavailableAction": "remove_item",
      "selections": [
        "<unknown>"
      ],
      "specialInstructions": "<string>",
      "product": {
        "id": "<string>",
        "name": "<string>",
        "price": "<string>"
      }
    }
  ],
  "fees": {
    "enterpriseFeeRate": "<string>",
    "enterpriseFeeFix": "<string>",
    "serviceFeeRate": "<string>",
    "serviceFeeFix": "<string>",
    "taxRate": "<string>",
    "tipRate": "<string>",
    "fulfillmentMethodFeeFix": "<string>",
    "fulfillmentMethodFeeRate": "<string>",
    "paymentProcessingFeeRate": "<string>",
    "paymentProcessingFeeFix": "<string>"
  },
  "lockedAt": "2023-11-07T05:31:56Z",
  "metadata": {},
  "courierTipTotal": "<string>",
  "courierTipTotalFormatted": "<string>",
  "discountCode": "<string>",
  "deliveryInfo": {
    "addressString": "<string>",
    "addressData": {
      "street": "<string>",
      "city": "<string>",
      "state": "<string>",
      "zipCode": "<string>",
      "country": "United States",
      "lat": 0,
      "lng": 0,
      "streetOptional": ""
    }
  },
  "deliveryQuote": {
    "provider": "DOORDASH_DRIVE",
    "externalDeliveryId": "<string>",
    "quoteFingerprint": "<string>",
    "feeMinor": 4503599627370495,
    "taxMinor": 4503599627370495,
    "courierTipMinor": 4503599627370495,
    "currency": "<string>",
    "quotedAt": "2023-11-07T05:31:56Z",
    "expiresAt": "2023-11-07T05:31:56Z",
    "pickupEstimatedAt": "2023-11-07T05:31:56Z",
    "dropoffEstimatedAt": "2023-11-07T05:31:56Z",
    "status": "<string>",
    "trackingUrl": "<string>",
    "supportReference": "<string>"
  },
  "tableServiceInfo": {
    "tableNumber": "<string>"
  },
  "roomServiceInfo": {
    "lastName": "<string>",
    "roomNumber": "<string>"
  }
}

Authorizations

StorefrontCartCapabilityStorefrontCustomerAuth

X-Cart-Token · string · header · required

Purpose-limited capability returned for a guest cart.

Headers

Idempotency-Key · string · required

Caller-stable key reused only for retries of this exact request.

Required string length: 16 - 128

Pattern: ^[A-Za-z0-9._:-]{16,128}$

If-Match · string · required

Current cart ETag returned by the API.

Pattern: ^(?:W/)?"cart-(?:0|[1-9][0-9]*)"$

Path Parameters

locationId · string · required

Required string length: 1 - 128

cartId · string · required

Required string length: 1 - 128

Body

application/json

amount · string · required

Pattern: ^\d+(?:\.\d+)?$

Response

200

application/json

Updated cart.

id · string · required

Required string length: 1 - 128

locationId · string · required

Required string length: 1 - 128

merchantId · string · required

Required string length: 1 - 128

status · enum<string> · required

Available options: OPEN, LOCKED, COMPLETED, EXPIRED

revision · integer · required

Required range: 0 <= x <= 9007199254740991

expiresAt · string<date-time> · required

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$

authorityContext · object | null · required

Show child attributes

quoteFingerprint · string | null · required

Pattern: ^[a-f0-9]{64}$

quoteExpiresAt · string<date-time> | null · required

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$

catalogRevalidation · object | null · required

Show child attributes

restaurantDisplayName · string · required

fulfilmentMethod · enum<string> · required

Available options: takeout, table_side, room_service, delivery

fulfillmentIdentifier · string · required

pickupType · enum<string> · required

Available options: ASAP, LATER

orderDate · string · required

orderTime · string · required

currency · enum<string> · required

Available options: usd, gbp, aed, aud

subTotal · string · required

Pattern: ^-?\d+(?:\.\d+)?$

subTotalFormatted · string · required

discountTotal · string · required

Pattern: ^-?\d+(?:\.\d+)?$

discountTotalFormatted · string · required

waiterTipTotal · string · required

Pattern: ^-?\d+(?:\.\d+)?$

waiterTipTotalFormatted · string · required

taxTotal · string · required

Pattern: ^-?\d+(?:\.\d+)?$

taxTotalFormatted · string · required

taxAndFeeTotal · string · required

Pattern: ^-?\d+(?:\.\d+)?$

taxAndFeeTotalFormatted · string · required

serviceFeeTotal · string · required

Pattern: ^-?\d+(?:\.\d+)?$

serviceFeeTotalFormatted · string · required

paymentProcessingFeeTotal · string · required

Pattern: ^-?\d+(?:\.\d+)?$

paymentProcessingFeeTotalFormatted · string · required

applicationFeeTotal · string · required

Pattern: ^-?\d+(?:\.\d+)?$

applicationFeeTotalFormatted · string · required

netSalesTotal · string · required

Pattern: ^-?\d+(?:\.\d+)?$

netSalesTotalFormatted · string · required

fulfillmentMethodFeeTotal · string · required

Pattern: ^-?\d+(?:\.\d+)?$

fulfillmentMethodFeeTotalFormatted · string · required

orderTotal · string · required

Pattern: ^-?\d+(?:\.\d+)?$

orderTotalFormatted · string · required

orderTotalWithServiceFee · string · required

Pattern: ^-?\d+(?:\.\d+)?$

orderTotalWithServiceFeeFormatted · string · required

orderTotalWithServiceFeeAmount · integer · required

Required range: 0 <= x <= 9007199254740991

enterpriseFeeTotal · string · required

Pattern: ^-?\d+(?:\.\d+)?$

enterpriseFeeTotalFormatted · string · required

subTotalWithoutDiscount · string · required

Pattern: ^-?\d+(?:\.\d+)?$

subTotalWithoutDiscountFormatted · string · required

statementDescriptor · string · required

totalQuantity · integer · required

Required range: 0 <= x <= 9007199254740991

items · object[] · required

Show child attributes

fees · object · required

Show child attributes

lockedAt · string<date-time> | null

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$

metadata · object

Show child attributes

courierTipTotal · string

Pattern: ^-?\d+(?:\.\d+)?$

courierTipTotalFormatted · string

discountCode · string

deliveryInfo · object | null

Show child attributes

deliveryQuote · object | null

Show child attributes

tableServiceInfo · object | null

Show child attributes

roomServiceInfo · object | null

Show child attributes