Expire a cart

Expire a cart

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

import requests

url = "https://api.craveup.com/api/v1/storefront/locations/{locationId}/carts/{cartId}"

payload = {}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "If-Match": "<if-match>",
    "X-Cart-Token": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.delete(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'DELETE',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    'If-Match': '<if-match>',
    'X-Cart-Token': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({})
};

fetch('https://api.craveup.com/api/v1/storefront/locations/{locationId}/carts/{cartId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.craveup.com/api/v1/storefront/locations/{locationId}/carts/{cartId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_POSTFIELDS => json_encode([
    
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>",
    "If-Match: <if-match>",
    "X-Cart-Token: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.craveup.com/api/v1/storefront/locations/{locationId}/carts/{cartId}"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("DELETE", url, payload)

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	req.Header.Add("If-Match", "<if-match>")
	req.Header.Add("X-Cart-Token", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.delete("https://api.craveup.com/api/v1/storefront/locations/{locationId}/carts/{cartId}")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("If-Match", "<if-match>")
  .header("X-Cart-Token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.craveup.com/api/v1/storefront/locations/{locationId}/carts/{cartId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["If-Match"] = '<if-match>'
request["X-Cart-Token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "locationId": "<string>",
  "merchantId": "<string>",
  "revision": 4503599627370495,
  "expiresAt": "2023-11-07T05:31:56Z",
  "restaurantDisplayName": "<string>",
  "fulfillmentIdentifier": "<string>",
  "orderDate": "<string>",
  "orderTime": "<string>",
  "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>",
      "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": {},
  "discountCode": "<string>",
  "deliveryInfo": {
    "addressString": "<string>",
    "addressData": {
      "street": "<string>",
      "city": "<string>",
      "state": "<string>",
      "zipCode": "<string>",
      "lat": 0,
      "lng": 0,
      "streetOptional": ""
    }
  },
  "tableServiceInfo": {
    "tableNumber": "<string>"
  },
  "roomServiceInfo": {
    "lastName": "<string>",
    "roomNumber": "<string>"
  }
}

{
  "message": "<string>",
  "requestId": "<string>",
  "details": {}
}

{
  "message": "<string>",
  "requestId": "<string>",
  "details": {}
}

{
  "message": "<string>",
  "requestId": "<string>",
  "details": {}
}

{
  "message": "<string>",
  "requestId": "<string>",
  "details": {}
}

{
  "message": "<string>",
  "requestId": "<string>",
  "details": {}
}

{
  "message": "<string>",
  "requestId": "<string>",
  "details": {}
}

{
  "message": "<string>",
  "requestId": "<string>",
  "details": {}
}

{
  "message": "<string>",
  "requestId": "<string>",
  "details": {}
}

{
  "message": "<string>",
  "requestId": "<string>",
  "details": {}
}

DELETE

locations

{locationId}

carts

{cartId}

Expire a cart

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

import requests

url = "https://api.craveup.com/api/v1/storefront/locations/{locationId}/carts/{cartId}"

payload = {}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "If-Match": "<if-match>",
    "X-Cart-Token": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.delete(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'DELETE',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    'If-Match': '<if-match>',
    'X-Cart-Token': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({})
};

fetch('https://api.craveup.com/api/v1/storefront/locations/{locationId}/carts/{cartId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.craveup.com/api/v1/storefront/locations/{locationId}/carts/{cartId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_POSTFIELDS => json_encode([
    
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>",
    "If-Match: <if-match>",
    "X-Cart-Token: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.craveup.com/api/v1/storefront/locations/{locationId}/carts/{cartId}"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("DELETE", url, payload)

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	req.Header.Add("If-Match", "<if-match>")
	req.Header.Add("X-Cart-Token", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.delete("https://api.craveup.com/api/v1/storefront/locations/{locationId}/carts/{cartId}")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("If-Match", "<if-match>")
  .header("X-Cart-Token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.craveup.com/api/v1/storefront/locations/{locationId}/carts/{cartId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["If-Match"] = '<if-match>'
request["X-Cart-Token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "locationId": "<string>",
  "merchantId": "<string>",
  "revision": 4503599627370495,
  "expiresAt": "2023-11-07T05:31:56Z",
  "restaurantDisplayName": "<string>",
  "fulfillmentIdentifier": "<string>",
  "orderDate": "<string>",
  "orderTime": "<string>",
  "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>",
      "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": {},
  "discountCode": "<string>",
  "deliveryInfo": {
    "addressString": "<string>",
    "addressData": {
      "street": "<string>",
      "city": "<string>",
      "state": "<string>",
      "zipCode": "<string>",
      "lat": 0,
      "lng": 0,
      "streetOptional": ""
    }
  },
  "tableServiceInfo": {
    "tableNumber": "<string>"
  },
  "roomServiceInfo": {
    "lastName": "<string>",
    "roomNumber": "<string>"
  }
}

{
  "message": "<string>",
  "requestId": "<string>",
  "details": {}
}

{
  "message": "<string>",
  "requestId": "<string>",
  "details": {}
}

{
  "message": "<string>",
  "requestId": "<string>",
  "details": {}
}

{
  "message": "<string>",
  "requestId": "<string>",
  "details": {}
}

{
  "message": "<string>",
  "requestId": "<string>",
  "details": {}
}

{
  "message": "<string>",
  "requestId": "<string>",
  "details": {}
}

{
  "message": "<string>",
  "requestId": "<string>",
  "details": {}
}

{
  "message": "<string>",
  "requestId": "<string>",
  "details": {}
}

{
  "message": "<string>",
  "requestId": "<string>",
  "details": {}
}

Authorizations

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

The body is of type object.

Response

Expired cart.

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)))$

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

discountCode

string

deliveryInfo

object | null

Show child attributes

tableServiceInfo

object | null

Show child attributes

roomServiceInfo

object | null

Show child attributes

SDK Reference

API Endpoints

Error Codes

Authorizations

Headers

Path Parameters

Body

Response