Sign in
Miscellaneous

Get app data

Get initial app data, including user, products, cart, addresses, cards, subscriptions, and orders.

get/view/init

Response

Initial app data.

Example response

{
  "data": {
    "profile": {
      "user": {
        "id": "usr_XXXXXXXXXXXXXXXXXXXXXXXXX",
        "name": "John Doe",
        "email": "john@example.com",
        "fingerprint": "183ded44-24d0-480e-9908-c022eff8d111",
        "stripeCustomerID": "cus_XXXXXXXXXXXXXXXXX"
      }
    },
    "products": [
      {
        "id": "prd_XXXXXXXXXXXXXXXXXXXXXXXXX",
        "name": "[object Object]",
        "description": "The interpolation of Caturra and Castillo varietals from Las Cochitas creates this refreshing citrusy and complex coffee.",
        "variants": [
          {
            "id": "var_XXXXXXXXXXXXXXXXXXXXXXXXX",
            "name": "12oz",
            "price": 2200
          }
        ],
        "order": 100,
        "subscription": "allowed",
        "tags": {
          "featured": true
        },
        "filters": []
      }
    ],
    "cart": {
      "subtotal": 4400,
      "items": [
        {
          "id": "itm_XXXXXXXXXXXXXXXXXXXXXXXXX",
          "productVariantID": "var_XXXXXXXXXXXXXXXXXXXXXXXXX",
          "quantity": 2,
          "subtotal": 4400
        }
      ],
      "amount": {
        "subtotal": 4400,
        "shipping": 800
      },
      "addressID": "shp_XXXXXXXXXXXXXXXXXXXXXXXXX",
      "cardID": "crd_XXXXXXXXXXXXXXXXXXXXXXXXX",
      "shipping": {
        "service": "USPS Ground Advantage",
        "timeframe": "3-5 days"
      }
    },
    "addresses": [
      {
        "id": "shp_XXXXXXXXXXXXXXXXXXXXXXXXX",
        "name": "John Doe",
        "street1": "123 Main St",
        "street2": "Apt 1",
        "city": "Anytown",
        "province": "CA",
        "zip": "12345",
        "country": "US",
        "phone": "5555555555",
        "created": "2024-06-29T19:36:19.000Z"
      }
    ],
    "cards": [
      {
        "id": "crd_XXXXXXXXXXXXXXXXXXXXXXXXX",
        "brand": "Visa",
        "expiration": {
          "month": 12,
          "year": 2023
        },
        "last4": "1234",
        "created": "2024-06-29T19:36:19.000Z"
      }
    ],
    "subscriptions": [
      {
        "id": "sub_XXXXXXXXXXXXXXXXXXXXXXXXX",
        "productVariantID": "var_XXXXXXXXXXXXXXXXXXXXXXXXX",
        "price": 2200,
        "quantity": 1,
        "addressID": "shp_XXXXXXXXXXXXXXXXXXXXXXXXX",
        "cardID": "crd_XXXXXXXXXXXXXXXXXXXXXXXXX",
        "schedule": {
          "type": "weekly",
          "interval": 3
        },
        "next": "2025-02-01T19:36:19.000Z",
        "created": "2024-06-29T19:36:19.000Z"
      }
    ],
    "orders": [
      {
        "id": "ord_XXXXXXXXXXXXXXXXXXXXXXXXX",
        "index": 0,
        "shipping": {
          "name": "John Doe",
          "street1": "123 Main St",
          "street2": "Apt 1",
          "city": "Anytown",
          "province": "CA",
          "zip": "12345",
          "country": "US",
          "phone": "5555555555"
        },
        "amount": {
          "subtotal": 4400,
          "shipping": 800
        },
        "created": "2024-06-29T19:36:19.000Z",
        "tracking": {
          "service": "USPS Ground Advantage",
          "number": "92346903470167000000000019",
          "url": "https://tools.usps.com/go/TrackConfirmAction_input?origTrackNum=92346903470167000000000019",
          "status": "DELIVERED",
          "statusDetails": "Your shipment has been delivered.",
          "statusUpdatedAt": "2025-04-08T12:00:00.000Z"
        },
        "items": [
          {
            "id": "itm_XXXXXXXXXXXXXXXXXXXXXXXXX",
            "amount": 4400,
            "quantity": 2,
            "productVariantID": "var_XXXXXXXXXXXXXXXXXXXXXXXXX"
          }
        ]
      }
    ],
    "tokens": [
      {
        "id": "pat_XXXXXXXXXXXXXXXXXXXXXXXXX",
        "token": "trm_test_******XXXX",
        "created": "2024-06-29T19:36:19.000Z"
      }
    ],
    "apps": [
      {
        "id": "cli_XXXXXXXXXXXXXXXXXXXXXXXXX",
        "secret": "sec_******XXXX",
        "name": "Example App",
        "redirectURI": "https://example.com/callback"
      }
    ],
    "region": "na"
  }
}

Changes

Changed in 18 of the 41 revisions of this API.71152

  • 84ef614abb9711See the full diff
    • ●

      removed the optional property data/products/items/variants/items/description from the response with the 200 status

      response-optional-property-removed

    • ○

      added the optional property data/products/items/timeHidden to the response with the 200 status

      response-optional-property-added

  • 007e5b7479981See the full diff
    • ○

      added the optional property data/products/items/variants/items/description to the response with the 200 status

      response-optional-property-added

  • 128873249a6472See the full diff
    • ●

      added the new DELIVERED enum value to the data/orders/items/tracking/status response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new FAILURE enum value to the data/orders/items/tracking/status response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new PRE_TRANSIT enum value to the data/orders/items/tracking/status response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new RETURNED enum value to the data/orders/items/tracking/status response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new TRANSIT enum value to the data/orders/items/tracking/status response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new UNKNOWN enum value to the data/orders/items/tracking/status response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new global enum value to the data/region response property for the response status 200

      response-property-enum-value-added

    • ○

      added the optional property data/products/items/tags/market_global to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/products/items/variants/items/tags to the response with the 200 status

      response-optional-property-added

  • bf623569cd3c1See the full diff
    • ○

      added the required property data/subscriptions/items/price to the response with the 200 status

      response-required-property-added

  • 58fa4af8e3254See the full diff
    • ○

      added the required property data/addresses/items/created to the response with the 200 status

      response-required-property-added

    • ○

      added the required property data/cards/items/created to the response with the 200 status

      response-required-property-added

    • ○

      added the required property data/orders/items/created to the response with the 200 status

      response-required-property-added

    • ○

      added the required property data/subscriptions/items/created to the response with the 200 status

      response-required-property-added

  • d02e3d898e583See the full diff
    • ○

      added the optional property data/orders/items/tracking/status to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/orders/items/tracking/statusDetails to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/orders/items/tracking/statusUpdatedAt to the response with the 200 status

      response-optional-property-added

  • 1c6726b12e29318See the full diff
    • ▲

      the response's body type/format changed from / to object/ for status 401

      response-body-type-changed

    • ▲

      the response's body type/format changed from / to object/ for status 429

      response-body-type-changed

    • ▲

      the response's body type/format changed from / to object/ for status 500

      response-body-type-changed

    • ○

      removed ErrorResponse from the response body allOf list for the response status 401

      response-body-all-of-removed

    • ○

      removed ErrorResponse from the response body allOf list for the response status 429

      response-body-all-of-removed

    • ○

      removed ErrorResponse from the response body allOf list for the response status 500

      response-body-all-of-removed

    • ○

      added the optional property details to the response with the 401 status

      response-optional-property-added

    • ○

      added the optional property details to the response with the 429 status

      response-optional-property-added

    • ○

      added the optional property details to the response with the 500 status

      response-optional-property-added

    • ○

      added the optional property param to the response with the 401 status

      response-optional-property-added

    • ○

      added the optional property param to the response with the 429 status

      response-optional-property-added

    • ○

      added the optional property param to the response with the 500 status

      response-optional-property-added

    • ○

      added the required property code to the response with the 401 status

      response-required-property-added

    • ○

      added the required property code to the response with the 429 status

      response-required-property-added

    • ○

      added the required property code to the response with the 500 status

      response-required-property-added

    • ○

      added the required property message to the response with the 401 status

      response-required-property-added

    • ○

      added the required property message to the response with the 429 status

      response-required-property-added

    • ○

      added the required property message to the response with the 500 status

      response-required-property-added

    • ○

      added the required property type to the response with the 401 status

      response-required-property-added

    • ○

      added the required property type to the response with the 429 status

      response-required-property-added

    • ○

      added the required property type to the response with the 500 status

      response-required-property-added

  • cb50019f242511See the full diff
    • ●

      removed the optional property data/products/items/tags/type from the response with the 200 status

      response-optional-property-removed

    • ○

      added the required property data/region to the response with the 200 status

      response-required-property-added

  • 12aaa327d6532See the full diff
    • ●

      removed the optional property data/cart/amount/giftCard from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/cart/giftCardID from the response with the 200 status

      response-optional-property-removed

  • 3b68749c34dc4See the full diff
    • ○

      added the optional property data/cart/amount/giftCard to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/cart/amount/total to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/cart/giftCardID to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/products/items/tags/type to the response with the 200 status

      response-optional-property-added