{"info":{"title":"commerce basic","version":"1.0","contact":{"name":"Beamable Support","url":"https://api.beamable.com","email":"support@beamable.com"}},"servers":[{"url":"https://api.beamable.com"}],"paths":{"/basic/commerce/catalog/legacy":{"post":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResultResponse"}}}},"400":{"description":"Bad Request"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaveCatalogRequest"}}}},"security":[{"user":["developer"]},{"server":[]}]},"parameters":[{"name":"X-BEAM-SCOPE","in":"header","schema":{"type":"string"},"description":"Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.","required":true},{"name":"X-BEAM-GAMERTAG","in":"header","schema":{"type":"string"},"description":"Override the Gamer Tag of the player. This is generally inferred by the auth token.","required":false}]},"/basic/commerce/catalog":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCatalogResponse"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"version","in":"query","schema":{"type":"integer","format":"int64"},"required":false}],"security":[{"user":["tester"]},{"server":[]}]},"parameters":[{"name":"X-BEAM-SCOPE","in":"header","schema":{"type":"string"},"description":"Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.","required":true},{"name":"X-BEAM-GAMERTAG","in":"header","schema":{"type":"string"},"description":"Override the Gamer Tag of the player. This is generally inferred by the auth token.","required":false}]},"/basic/commerce/skus":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetSKUsResponse"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"version","in":"query","schema":{"type":"integer","format":"int64"},"required":false}],"security":[{}]},"post":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResultResponse"}}}},"400":{"description":"Bad Request"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaveSKUsRequest"}}}},"security":[{"user":["developer"]},{"server":[]}]},"parameters":[{"name":"X-BEAM-SCOPE","in":"header","schema":{"type":"string"},"description":"Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.","required":true},{"name":"X-BEAM-GAMERTAG","in":"header","schema":{"type":"string"},"description":"Override the Gamer Tag of the player. This is generally inferred by the auth token.","required":false}]}},"components":{"schemas":{"OfferDefinition":{"type":"object","additionalProperties":false,"properties":{"titles":{"type":"array","items":{"type":"string"}},"symbol":{"type":"string"},"obtainItems":{"type":"array","items":{"$ref":"#/components/schemas/ItemCreateRequest"}},"lootRoll":{"$ref":"#/components/schemas/CommerceLootRoll"},"obtainCurrency":{"type":"array","items":{"$ref":"#/components/schemas/CurrencyChange"}},"metadata":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"descriptions":{"type":"array","items":{"type":"string"}},"obtain":{"type":"array","items":{"type":"string"}}},"required":["symbol","titles","descriptions","images","obtain"]},"ItemCreateRequest":{"type":"object","additionalProperties":false,"properties":{"contentId":{"type":"string"},"properties":{"type":"array","items":{"$ref":"#/components/schemas/ItemProperty"}}},"required":["contentId","properties"]},"EntitlementRequirement":{"type":"object","additionalProperties":false,"properties":{"symbol":{"type":"string"},"constraint":{"type":"string"},"state":{"type":"string"},"specialization":{"type":"string"}},"required":["symbol","constraint","state"]},"GetSkusReq":{"properties":{"version":{"type":"integer","format":"int64"}},"additionalProperties":false,"title":"Get Skus Req","type":"object"},"Listing":{"type":"object","additionalProperties":false,"properties":{"cohortRequirements":{"type":"array","items":{"$ref":"#/components/schemas/CohortRequirement"}},"offerSymbol":{"type":"string"},"purchaseLimit":{"type":"integer","format":"int32"},"price":{"$ref":"#/components/schemas/Price"},"playerStatRequirements":{"type":"array","items":{"$ref":"#/components/schemas/PlayerStatRequirement"}},"buttonText":{"type":"object","additionalProperties":{"type":"string"}},"scheduleInstancePurchaseLimit":{"type":"integer","format":"int32"},"entitlementRequirements":{"type":"array","items":{"$ref":"#/components/schemas/EntitlementRequirement"}},"symbol":{"type":"string"},"clientData":{"type":"object","additionalProperties":{"type":"string"}},"schedule":{"$ref":"#/components/schemas/Schedule"},"activeDurationCoolDownSeconds":{"type":"integer","format":"int32"},"activeDurationSeconds":{"type":"integer","format":"int32"},"activeDurationPurchaseLimit":{"type":"integer","format":"int32"},"offerRequirements":{"type":"array","items":{"$ref":"#/components/schemas/OfferRequirement"}},"activePeriod":{"$ref":"#/components/schemas/Period"}},"required":["symbol","offerSymbol","price","playerStatRequirements","cohortRequirements","entitlementRequirements","offerRequirements","clientData"]},"ResultResponse":{"properties":{"result":{"type":"boolean"}},"additionalProperties":false,"title":"Result Response","type":"object","required":["result"]},"SKU":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string"},"description":{"type":"string"},"realPrice":{"type":"integer","format":"int32"},"productIds":{"type":"object","additionalProperties":{"type":"string"}}},"required":["name","description","realPrice","productIds"]},"GetCatalogResponse":{"properties":{"catalog":{"$ref":"#/components/schemas/Catalog"}},"additionalProperties":false,"title":"Get Catalog Response","type":"object"},"SKUDefinitions":{"type":"object","additionalProperties":false,"properties":{"version":{"type":"integer","format":"int64"},"created":{"type":"integer","format":"int64","x-beamable-date-format":"unix","description":"Milliseconds since midnight, January 1, 1970 UTC"},"definitions":{"type":"array","items":{"$ref":"#/components/schemas/SKU"}}},"required":["version","created","definitions"]},"Price":{"type":"object","additionalProperties":false,"properties":{"type":{"type":"string"},"symbol":{"type":"string"},"amount":{"type":"integer","format":"int32"},"schedule":{"type":"array","items":{"type":"integer","format":"int32"}}},"required":["type","symbol"]},"PlayerStatRequirement":{"type":"object","additionalProperties":false,"properties":{"domain":{"type":"string"},"stat":{"type":"string"},"constraint":{"type":"string"},"value":{"type":"string"},"access":{"type":"string"}},"required":["stat","constraint","value"]},"CommerceLootRoll":{"type":"object","additionalProperties":false,"properties":{"preroll":{"type":"boolean"},"externalTables":{"type":"array","items":{"type":"string"}}},"required":["preroll"]},"Period":{"type":"object","additionalProperties":false,"properties":{"start":{"type":"string"},"end":{"type":"string"}},"required":["start"]},"OfferConstraint":{"type":"object","additionalProperties":false,"properties":{"constraint":{"type":"string"},"value":{"type":"integer","format":"int32"}},"required":["constraint","value"]},"GetSKUsResponse":{"properties":{"skus":{"$ref":"#/components/schemas/SKUDefinitions"}},"additionalProperties":false,"title":"Get SK Us Response","type":"object","required":["skus"]},"CurrencyChange":{"type":"object","additionalProperties":false,"properties":{"symbol":{"type":"string"},"amount":{"type":"integer","format":"int64"},"originalAmount":{"type":"integer","format":"int64"}},"required":["symbol","amount"]},"GetCatalogReq":{"properties":{"version":{"type":"integer","format":"int64"}},"additionalProperties":false,"title":"Get Catalog Req","type":"object"},"ItemProperty":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string"},"value":{"type":"string"}},"required":["name","value"]},"SaveCatalogRequest":{"properties":{"stores":{"type":"array","items":{"$ref":"#/components/schemas/Store"}},"offerDefinitions":{"type":"array","items":{"$ref":"#/components/schemas/OfferDefinition"}}},"additionalProperties":false,"title":"Save Catalog Request","type":"object","required":["stores","offerDefinitions"]},"Schedule":{"type":"object","additionalProperties":false,"properties":{"description":{"type":"string"},"crons":{"type":"array","items":{"type":"string"}},"activeTo":{"type":"string"},"activeFrom":{"type":"string"},"definitions":{"type":"array","items":{"$ref":"#/components/schemas/ScheduleDefinition"}}},"required":["activeFrom"]},"ScheduleDefinition":{"type":"object","additionalProperties":false,"properties":{"dayOfWeek":{"type":"array","items":{"type":"string"}},"minute":{"type":"array","items":{"type":"string"}},"dayOfMonth":{"type":"array","items":{"type":"string"}},"year":{"type":"array","items":{"type":"string"}},"hour":{"type":"array","items":{"type":"string"}},"second":{"type":"array","items":{"type":"string"}},"month":{"type":"array","items":{"type":"string"}}},"required":["second","minute","hour","dayOfMonth","month","dayOfWeek","year"]},"SaveSKUsRequest":{"properties":{"definitions":{"type":"array","items":{"$ref":"#/components/schemas/SKU"}}},"additionalProperties":false,"title":"Save SK Us Request","type":"object","required":["definitions"]},"OfferRequirement":{"type":"object","additionalProperties":false,"properties":{"offerSymbol":{"type":"string"},"purchases":{"$ref":"#/components/schemas/OfferConstraint"}},"required":["offerSymbol","purchases"]},"CohortRequirement":{"type":"object","additionalProperties":false,"properties":{"trial":{"type":"string"},"cohort":{"type":"string"},"constraint":{"type":"string"}},"required":["trial","cohort","constraint"]},"Catalog":{"type":"object","additionalProperties":false,"properties":{"version":{"type":"integer","format":"int64"},"created":{"type":"integer","format":"int64","x-beamable-date-format":"unix","description":"Milliseconds since midnight, January 1, 1970 UTC"},"stores":{"type":"array","items":{"$ref":"#/components/schemas/Store"}},"offerDefinitions":{"type":"array","items":{"$ref":"#/components/schemas/OfferDefinition"}}},"required":["version","created","stores","offerDefinitions"]},"Store":{"type":"object","additionalProperties":false,"properties":{"activeListingLimit":{"type":"integer","format":"int32"},"choose":{"type":"integer","format":"int32"},"listings":{"type":"array","items":{"$ref":"#/components/schemas/Listing"}},"showInactiveListings":{"type":"boolean"},"symbol":{"type":"string"},"refreshTime":{"type":"integer","format":"int32"},"title":{"type":"string"}},"required":["symbol","listings"]}},"securitySchemes":{"server":{"type":"apiKey","name":"X-DE-SIGNATURE","in":"header","description":"Signed Request authentication using project secret key."},"user":{"type":"http","description":"Bearer authentication with a player access token in the Authorization header.","scheme":"bearer","bearerFormat":"Bearer <Access Token>"}}},"security":[],"externalDocs":{"description":"Beamable Documentation","url":"https://docs.beamable.com"},"openapi":"3.0.2"}