SbPublicApiStoreResponse

snowbee.ecom.store.SbPublicApiStoreResponse

object · non-null

currencyIsoCodestringnon-nullrequired

ISO 4217 currency the store prices and charges in

Example"NOK"

idstringnon-nullrequired

loyaltyProgramobjectnullableoptional

The loyalty program whose members get member prices in this store; null when the store has none

Show child fields

idstringnon-nullrequired: Loyalty program ID; matches the ids in a customer's loyaltyPrograms
namestringnon-nullrequired: Loyalty program name, as shown to shoppers

namestringnon-nullrequired

paymentRequiredbooleannon-nullrequired

Whether the store takes web payment: checkout then requires a completed payment session

Exampletrue

View raw schema

{
  "type": "object",
  "properties": {
    "currencyIsoCode": {
      "type": "string",
      "description": "ISO 4217 currency the store prices and charges in",
      "example": "NOK",
      "title": "String"
    },
    "id": {
      "type": "string",
      "title": "String"
    },
    "loyaltyProgram": {
      "description": "The loyalty program whose members get member prices in this store; null when the store has none",
      "oneOf": [
        {
          "type": "null"
        },
        {
          "$ref": "#/components/schemas/snowbee.ecom.store.SbPublicApiStoreLoyaltyProgramResponse"
        }
      ]
    },
    "name": {
      "type": "string",
      "title": "String"
    },
    "paymentRequired": {
      "type": "boolean",
      "description": "Whether the store takes web payment: checkout then requires a completed payment session",
      "example": "true",
      "title": "Boolean"
    }
  },
  "required": [
    "currencyIsoCode",
    "id",
    "name",
    "paymentRequired"
  ],
  "title": "SbPublicApiStoreResponse"
}