> ## Documentation Index > Fetch the complete documentation index at: https://docs.craveup.com/llms.txt > Use this file to discover all available pages before exploring further. # Join the checkout's authoritative loyalty program ## OpenAPI ````yaml /generated/storefront.openapi.json post /locations/{locationId}/carts/{cartId}/loyalty/enrollment openapi: 3.0.3 info: title: Crave Storefront API version: 2.0.0 description: >- Direct public Storefront API. Anonymous catalog reads require no API key. Protected resources use purpose-limited cart, checkout, receipt, or customer credentials. contact: name: Crave Support email: hello@craveup.com servers: - url: https://api.craveup.com/api/v1/storefront description: Production Storefront API - url: https://dev-api-43233223.craveup.com/api/v1/storefront description: Sandbox Storefront API security: [] tags: - name: Merchants - name: Locations - name: Ordering Sessions - name: Menus - name: Products - name: Analytics - name: Carts - name: Checkout - name: Cart Items - name: Discounts - name: Loyalty - name: Customer Authentication - name: Customers - name: Orders paths: /locations/{locationId}/carts/{cartId}/loyalty/enrollment: post: tags: - Loyalty summary: Join the checkout's authoritative loyalty program operationId: storefrontEnrollLoyalty parameters: - name: locationId in: path required: true schema: type: string minLength: 1 maxLength: 128 - name: cartId in: path required: true schema: type: string minLength: 1 maxLength: 128 - name: Idempotency-Key in: header required: true description: Caller-stable key reused only for retries of this exact request. schema: type: string minLength: 16 maxLength: 128 pattern: ^[A-Za-z0-9._:-]{16,128}$ - name: If-Match in: header required: true description: Current cart ETag returned by the API. schema: type: string pattern: ^(?:W/)?"cart-(?:0|[1-9][0-9]*)"$ requestBody: required: true content: application/json: schema: type: object properties: consent: type: boolean enum: - true required: - consent additionalProperties: false responses: '200': description: Updated cart with the enrolled loyalty account. content: application/json: schema: $ref: '#/components/schemas/StorefrontCart' headers: ETag: description: >- Current resource revision tag. Send it in If-Match before mutation. schema: type: string Cache-Control: schema: type: string example: private, no-store '400': description: The request is invalid. headers: X-Request-Id: description: Opaque request identifier for support and telemetry correlation. schema: type: string content: application/json: schema: $ref: '#/components/schemas/CommerceErrorEnvelope' '401': description: Authentication or capability authorization is required. headers: X-Request-Id: description: Opaque request identifier for support and telemetry correlation. schema: type: string content: application/json: schema: $ref: '#/components/schemas/CommerceErrorEnvelope' '403': description: The authenticated principal does not own this resource. headers: X-Request-Id: description: Opaque request identifier for support and telemetry correlation. schema: type: string content: application/json: schema: $ref: '#/components/schemas/CommerceErrorEnvelope' '404': description: The requested resource was not found. headers: X-Request-Id: description: Opaque request identifier for support and telemetry correlation. schema: type: string content: application/json: schema: $ref: '#/components/schemas/CommerceErrorEnvelope' '409': description: The idempotency key or resource revision conflicts. headers: X-Request-Id: description: Opaque request identifier for support and telemetry correlation. schema: type: string content: application/json: schema: $ref: '#/components/schemas/CommerceErrorEnvelope' '428': description: A current If-Match resource revision is required. headers: X-Request-Id: description: Opaque request identifier for support and telemetry correlation. schema: type: string content: application/json: schema: $ref: '#/components/schemas/CommerceErrorEnvelope' '429': description: The request was rate limited. headers: X-Request-Id: description: Opaque request identifier for support and telemetry correlation. schema: type: string content: application/json: schema: $ref: '#/components/schemas/CommerceErrorEnvelope' '500': description: An unexpected error occurred. headers: X-Request-Id: description: Opaque request identifier for support and telemetry correlation. schema: type: string content: application/json: schema: $ref: '#/components/schemas/CommerceErrorEnvelope' '503': description: A required dependency is temporarily unavailable. headers: X-Request-Id: description: Opaque request identifier for support and telemetry correlation. schema: type: string content: application/json: schema: $ref: '#/components/schemas/CommerceErrorEnvelope' security: - StorefrontCustomerAuth: [] components: schemas: StorefrontCart: type: object properties: id: type: string minLength: 1 maxLength: 128 locationId: type: string minLength: 1 maxLength: 128 merchantId: type: string minLength: 1 maxLength: 128 status: type: string enum: - OPEN - LOCKED - COMPLETED - EXPIRED lockedAt: nullable: true type: string format: date-time 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)))$ revision: type: integer minimum: 0 maximum: 9007199254740991 expiresAt: type: string format: date-time 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: nullable: true type: object properties: version: type: number enum: - 1 organizationId: type: string minLength: 1 maxLength: 128 locationId: type: string minLength: 1 maxLength: 128 profile: type: string enum: - crave_commerce - pos_routed - provider_checkout cartId: type: string minLength: 1 maxLength: 128 cartRevision: type: integer minimum: 0 maximum: 9007199254740991 catalogPublicationRevision: nullable: true type: integer minimum: 1 maximum: 9007199254740991 resolvedCatalogSnapshotRevision: nullable: true type: integer minimum: 1 maximum: 9007199254740991 commercePolicyRevision: type: integer minimum: 0 maximum: 9007199254740991 providerBindingRevision: nullable: true type: integer minimum: 1 maximum: 9007199254740991 authority: type: object properties: operationalCatalog: type: string enum: - crave - provider quote: type: string enum: - crave - provider payment: type: string enum: - stripe - provider refund: type: string enum: - stripe - provider benefits: type: string enum: - crave_lip - provider - none orderRouting: type: string enum: - crave - provider fulfillment: type: string enum: - crave - provider required: - operationalCatalog - quote - payment - refund - benefits - orderRouting - fulfillment additionalProperties: false required: - version - organizationId - locationId - profile - cartId - cartRevision - catalogPublicationRevision - resolvedCatalogSnapshotRevision - commercePolicyRevision - providerBindingRevision - authority additionalProperties: false quoteFingerprint: nullable: true type: string pattern: ^[a-f0-9]{64}$ quoteExpiresAt: nullable: true type: string format: date-time 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: nullable: true type: object properties: required: type: boolean reasonCodes: type: array items: type: string enum: - ITEM_SOLD_OUT - ITEM_UNAVAILABLE - PRICE_CHANGED - MODIFIER_UNAVAILABLE - MODIFIER_RULE_CHANGED - QUANTITY_REDUCED - SCHEDULE_CLOSED - FULFILLMENT_UNAVAILABLE - MAPPING_MISSING - POLICY_CHANGED - QUOTE_EXPIRED changeSet: type: object properties: version: type: number enum: - 1 previous: type: object properties: cartRevision: type: integer minimum: 0 maximum: 9007199254740991 catalogPublicationRevision: nullable: true type: integer minimum: 1 maximum: 9007199254740991 resolvedCatalogSnapshotRevision: nullable: true type: integer minimum: 1 maximum: 9007199254740991 commercePolicyRevision: type: integer minimum: 0 maximum: 9007199254740991 providerBindingRevision: nullable: true type: integer minimum: 1 maximum: 9007199254740991 required: - cartRevision - catalogPublicationRevision - resolvedCatalogSnapshotRevision - commercePolicyRevision - providerBindingRevision additionalProperties: false current: type: object properties: cartRevision: type: integer minimum: 0 maximum: 9007199254740991 catalogPublicationRevision: nullable: true type: integer minimum: 1 maximum: 9007199254740991 resolvedCatalogSnapshotRevision: nullable: true type: integer minimum: 1 maximum: 9007199254740991 commercePolicyRevision: type: integer minimum: 0 maximum: 9007199254740991 providerBindingRevision: nullable: true type: integer minimum: 1 maximum: 9007199254740991 required: - cartRevision - catalogPublicationRevision - resolvedCatalogSnapshotRevision - commercePolicyRevision - providerBindingRevision additionalProperties: false reasonCodes: type: array items: type: string enum: - ITEM_SOLD_OUT - ITEM_UNAVAILABLE - PRICE_CHANGED - MODIFIER_UNAVAILABLE - MODIFIER_RULE_CHANGED - QUANTITY_REDUCED - SCHEDULE_CLOSED - FULFILLMENT_UNAVAILABLE - MAPPING_MISSING - POLICY_CHANGED - QUOTE_EXPIRED changes: type: array items: type: object properties: reason: type: string enum: - ITEM_SOLD_OUT - ITEM_UNAVAILABLE - PRICE_CHANGED - MODIFIER_UNAVAILABLE - MODIFIER_RULE_CHANGED - QUANTITY_REDUCED - SCHEDULE_CLOSED - FULFILLMENT_UNAVAILABLE - MAPPING_MISSING - POLICY_CHANGED - QUOTE_EXPIRED cartItemId: nullable: true type: string minLength: 1 maxLength: 128 canonicalEntityId: nullable: true type: string minLength: 1 maxLength: 128 path: type: string minLength: 1 before: nullable: true anyOf: - type: string - type: number - type: boolean after: nullable: true anyOf: - type: string - type: number - type: boolean permittedActions: type: array items: type: string enum: - ACCEPT_CHANGES - EDIT_ITEM - REMOVE_ITEM - RESELECT_MODIFIERS - CHANGE_FULFILLMENT - START_NEW_CART required: - reason - cartItemId - canonicalEntityId - path - before - after - permittedActions additionalProperties: false blocking: type: boolean reconfirmationRequired: type: boolean invalidatedEvidence: type: object properties: quote: type: boolean benefits: type: boolean paymentAuthorization: type: boolean required: - quote - benefits - paymentAuthorization additionalProperties: false required: - version - previous - current - reasonCodes - changes - blocking - reconfirmationRequired - invalidatedEvidence additionalProperties: false checkedAt: type: string format: date-time 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)))$ acknowledgedAt: nullable: true type: string format: date-time 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)))$ required: - required - reasonCodes - changeSet - checkedAt - acknowledgedAt additionalProperties: false restaurantDisplayName: type: string fulfilmentMethod: type: string enum: - takeout - table_side - room_service - delivery fulfillmentIdentifier: type: string metadata: type: object additionalProperties: {} pickupType: type: string enum: - ASAP - LATER orderDate: type: string orderTime: type: string currency: type: string enum: - usd - gbp - aed - aud subTotal: type: string pattern: ^-?\d+(?:\.\d+)?$ subTotalFormatted: type: string discountTotal: type: string pattern: ^-?\d+(?:\.\d+)?$ discountTotalFormatted: type: string waiterTipTotal: type: string pattern: ^-?\d+(?:\.\d+)?$ waiterTipTotalFormatted: type: string courierTipTotal: type: string pattern: ^-?\d+(?:\.\d+)?$ courierTipTotalFormatted: type: string taxTotal: type: string pattern: ^-?\d+(?:\.\d+)?$ taxTotalFormatted: type: string taxAndFeeTotal: type: string pattern: ^-?\d+(?:\.\d+)?$ taxAndFeeTotalFormatted: type: string serviceFeeTotal: type: string pattern: ^-?\d+(?:\.\d+)?$ serviceFeeTotalFormatted: type: string paymentProcessingFeeTotal: type: string pattern: ^-?\d+(?:\.\d+)?$ paymentProcessingFeeTotalFormatted: type: string applicationFeeTotal: type: string pattern: ^-?\d+(?:\.\d+)?$ applicationFeeTotalFormatted: type: string netSalesTotal: type: string pattern: ^-?\d+(?:\.\d+)?$ netSalesTotalFormatted: type: string fulfillmentMethodFeeTotal: type: string pattern: ^-?\d+(?:\.\d+)?$ fulfillmentMethodFeeTotalFormatted: type: string orderTotal: type: string pattern: ^-?\d+(?:\.\d+)?$ orderTotalFormatted: type: string orderTotalWithServiceFee: type: string pattern: ^-?\d+(?:\.\d+)?$ orderTotalWithServiceFeeFormatted: type: string orderTotalWithServiceFeeAmount: type: integer minimum: 0 maximum: 9007199254740991 enterpriseFeeTotal: type: string pattern: ^-?\d+(?:\.\d+)?$ enterpriseFeeTotalFormatted: type: string subTotalWithoutDiscount: type: string pattern: ^-?\d+(?:\.\d+)?$ subTotalWithoutDiscountFormatted: type: string discountCode: type: string statementDescriptor: type: string totalQuantity: type: integer minimum: 0 maximum: 9007199254740991 items: type: array items: $ref: '#/components/schemas/CartItem' fees: type: object properties: enterpriseFeeRate: type: string pattern: ^-?\d+(?:\.\d+)?$ enterpriseFeeFix: type: string pattern: ^-?\d+(?:\.\d+)?$ serviceFeeRate: type: string pattern: ^-?\d+(?:\.\d+)?$ serviceFeeFix: type: string pattern: ^-?\d+(?:\.\d+)?$ taxRate: type: string pattern: ^-?\d+(?:\.\d+)?$ tipRate: type: string pattern: ^-?\d+(?:\.\d+)?$ fulfillmentMethodFeeFix: type: string pattern: ^-?\d+(?:\.\d+)?$ fulfillmentMethodFeeRate: type: string pattern: ^-?\d+(?:\.\d+)?$ paymentProcessingFeeRate: type: string pattern: ^-?\d+(?:\.\d+)?$ paymentProcessingFeeFix: type: string pattern: ^-?\d+(?:\.\d+)?$ required: - enterpriseFeeRate - enterpriseFeeFix - serviceFeeRate - serviceFeeFix - taxRate - tipRate - fulfillmentMethodFeeFix - fulfillmentMethodFeeRate - paymentProcessingFeeRate - paymentProcessingFeeFix additionalProperties: false deliveryInfo: nullable: true type: object properties: addressString: type: string addressData: $ref: '#/components/schemas/DeliveryAddress' required: - addressString - addressData additionalProperties: {} deliveryQuote: nullable: true type: object properties: provider: type: string enum: - DOORDASH_DRIVE externalDeliveryId: type: string quoteFingerprint: type: string pattern: ^[a-f0-9]{64}$ feeMinor: type: integer minimum: 0 maximum: 9007199254740991 taxMinor: type: integer minimum: 0 maximum: 9007199254740991 courierTipMinor: type: integer minimum: 0 maximum: 9007199254740991 currency: type: string quotedAt: type: string format: date-time 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)))$ expiresAt: type: string format: date-time 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)))$ pickupEstimatedAt: type: string format: date-time 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)))$ dropoffEstimatedAt: type: string format: date-time 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)))$ status: type: string trackingUrl: type: string format: uri supportReference: type: string required: - provider - externalDeliveryId - quoteFingerprint - feeMinor - taxMinor - courierTipMinor - currency - quotedAt - expiresAt additionalProperties: false tableServiceInfo: nullable: true type: object properties: tableNumber: type: string additionalProperties: {} roomServiceInfo: nullable: true type: object properties: lastName: type: string roomNumber: type: string additionalProperties: {} required: - id - locationId - merchantId - status - revision - expiresAt - authorityContext - quoteFingerprint - quoteExpiresAt - catalogRevalidation - restaurantDisplayName - fulfilmentMethod - fulfillmentIdentifier - pickupType - orderDate - orderTime - currency - subTotal - subTotalFormatted - discountTotal - discountTotalFormatted - waiterTipTotal - waiterTipTotalFormatted - taxTotal - taxTotalFormatted - taxAndFeeTotal - taxAndFeeTotalFormatted - serviceFeeTotal - serviceFeeTotalFormatted - paymentProcessingFeeTotal - paymentProcessingFeeTotalFormatted - applicationFeeTotal - applicationFeeTotalFormatted - netSalesTotal - netSalesTotalFormatted - fulfillmentMethodFeeTotal - fulfillmentMethodFeeTotalFormatted - orderTotal - orderTotalFormatted - orderTotalWithServiceFee - orderTotalWithServiceFeeFormatted - orderTotalWithServiceFeeAmount - enterpriseFeeTotal - enterpriseFeeTotalFormatted - subTotalWithoutDiscount - subTotalWithoutDiscountFormatted - statementDescriptor - totalQuantity - items - fees additionalProperties: false CommerceErrorEnvelope: type: object properties: code: anyOf: - type: string enum: - VALIDATION_ERROR - UNAUTHORIZED - FORBIDDEN - NOT_FOUND - RATE_LIMITED - CART_CONFLICT - REQUOTE_REQUIRED - RESOURCE_CONFLICT - CART_IMMUTABLE - IDEMPOTENCY_KEY_REQUIRED - IDEMPOTENCY_KEY_REUSED - IDEMPOTENCY_IN_PROGRESS - DEPENDENCY_UNAVAILABLE - INTERNAL_ERROR - type: string minLength: 1 message: type: string minLength: 1 requestId: type: string minLength: 8 details: type: object additionalProperties: {} required: - code - message - requestId additionalProperties: false CartItem: type: object properties: id: type: string minLength: 1 maxLength: 128 productId: type: string minLength: 1 maxLength: 128 name: type: string description: type: string imageUrl: type: string price: type: string pattern: ^-?\d+(?:\.\d+)?$ priceFormatted: type: string quantity: type: integer minimum: 0 maximum: 9007199254740991 total: type: string pattern: ^-?\d+(?:\.\d+)?$ totalFormatted: type: string discount: type: string pattern: ^-?\d+(?:\.\d+)?$ discountFormatted: type: string categoryId: nullable: true type: string minLength: 1 maxLength: 128 specialInstructions: type: string itemUnavailableAction: type: string enum: - remove_item - cancel_entire_order selections: type: array items: {} product: type: object properties: id: type: string minLength: 1 maxLength: 128 name: type: string price: type: string pattern: ^-?\d+(?:\.\d+)?$ required: - id required: - id - productId - name - description - imageUrl - price - priceFormatted - quantity - total - totalFormatted - discount - discountFormatted - categoryId - itemUnavailableAction - selections additionalProperties: {} DeliveryAddress: type: object properties: street: type: string minLength: 1 streetOptional: default: '' type: string city: type: string minLength: 1 state: type: string minLength: 1 zipCode: type: string minLength: 1 country: type: string enum: - United States - United Arab Emirates - Australia - United Kingdom lat: type: number minimum: -90 maximum: 90 lng: type: number minimum: -180 maximum: 180 required: - street - city - state - zipCode - country - lat - lng additionalProperties: false securitySchemes: StorefrontCustomerAuth: type: http scheme: bearer bearerFormat: JWT description: Merchant-bound customer session JWT returned by OTP verification. ````