{"info":{"title":"commerce object","version":"1.0","contact":{"name":"Beamable Support","url":"https://api.beamable.com","email":"support@beamable.com"}},"servers":[{"url":"https://api.beamable.com"}],"paths":{"/object/commerce/{objectId}/":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetActiveOffersResponse"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"scope","in":"query","schema":{"type":"string"},"required":false},{"name":"objectId","in":"path","schema":{"type":"string"},"description":"Gamertag of the player.Underlying objectId type is integer in format int64.","required":true,"x-beamable-object-id":{"type":"integer","format":"int64"}}],"security":[{"user":[]},{"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}]},"/object/commerce/{objectId}/coupons/count":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetTotalCouponResponse"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"objectId","in":"path","schema":{"type":"string"},"description":"Gamertag of the player.Underlying objectId type is integer in format int64.","required":true,"x-beamable-object-id":{"type":"integer","format":"int64"}}],"security":[{}]},"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}]},"/object/commerce/{objectId}/listings/cooldown":{"put":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"objectId","in":"path","schema":{"type":"string"},"description":"Gamertag of the player.Underlying objectId type is integer in format int64.","required":true,"x-beamable-object-id":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CooldownModifierRequest"}}}},"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}]},"/object/commerce/{objectId}/offersAdmin":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetActiveOffersResponse"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"language","in":"query","schema":{"type":"string"},"required":false},{"name":"time","in":"query","schema":{"type":"string"},"required":false},{"name":"stores","in":"query","schema":{"type":"string"},"required":false},{"name":"objectId","in":"path","schema":{"type":"string"},"description":"Gamertag of the player.Underlying objectId type is integer in format int64.","required":true,"x-beamable-object-id":{"type":"integer","format":"int64"}}],"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}]},"/object/commerce/{objectId}/purchase":{"post":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InventoryUpdateResponse"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"objectId","in":"path","schema":{"type":"string"},"description":"Gamertag of the player.Underlying objectId type is integer in format int64.","required":true,"x-beamable-object-id":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PurchaseRequest"}}}},"security":[{"user":[]},{"server":[]}]},"put":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResultResponse"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"objectId","in":"path","schema":{"type":"string"},"description":"Gamertag of the player.Underlying objectId type is integer in format int64.","required":true,"x-beamable-object-id":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportPurchaseRequest"}}}},"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}]},"/object/commerce/{objectId}/listings":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActiveListingResponse"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"listing","in":"query","schema":{"type":"string"},"required":true},{"name":"store","in":"query","schema":{"type":"string"},"required":false},{"name":"time","in":"query","schema":{"type":"string"},"required":false},{"name":"objectId","in":"path","schema":{"type":"string"},"description":"Gamertag of the player.Underlying objectId type is integer in format int64.","required":true,"x-beamable-object-id":{"type":"integer","format":"int64"}}],"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}]},"/object/commerce/{objectId}/status":{"delete":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"objectId","in":"path","schema":{"type":"string"},"description":"Gamertag of the player.Underlying objectId type is integer in format int64.","required":true,"x-beamable-object-id":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClearStatusRequest"}}}},"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}]},"/object/commerce/{objectId}/coupons":{"post":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"objectId","in":"path","schema":{"type":"string"},"description":"Gamertag of the player.Underlying objectId type is integer in format int64.","required":true,"x-beamable-object-id":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GiveCouponReq"}}}},"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}]},"/object/commerce/{objectId}/stats/update":{"post":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"objectId","in":"path","schema":{"type":"string"},"description":"Gamertag of the player.Underlying objectId type is integer in format int64.","required":true,"x-beamable-object-id":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatSubscriptionNotification"}}}},"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}]},"/object/commerce/{objectId}/offers":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetActiveOffersResponse"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"language","in":"query","schema":{"type":"string"},"required":false},{"name":"time","in":"query","schema":{"type":"string"},"required":false},{"name":"stores","in":"query","schema":{"type":"string"},"required":false},{"name":"objectId","in":"path","schema":{"type":"string"},"description":"Gamertag of the player.Underlying objectId type is integer in format int64.","required":true,"x-beamable-object-id":{"type":"integer","format":"int64"}}],"security":[{"user":[]},{"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":{"ReportPurchaseRequest":{"properties":{"listingId":{"type":"string"},"free":{"type":"boolean"}},"additionalProperties":false,"title":"Report Purchase Request","type":"object","required":["listingId"]},"GetActiveListingRequest":{"properties":{"listing":{"type":"string"},"store":{"type":"string"},"time":{"type":"string"}},"additionalProperties":false,"title":"Get Active Listing Request","type":"object","required":["listing"]},"ItemCreateRequest":{"type":"object","additionalProperties":false,"properties":{"contentId":{"type":"string"},"properties":{"type":"array","items":{"$ref":"#/components/schemas/ItemProperty"}}},"required":["contentId","properties"]},"ItemDeltas":{"type":"object","additionalProperties":false,"properties":{"created":{"type":"array","items":{"$ref":"#/components/schemas/ItemPropertiesDelta"}},"updated":{"type":"array","items":{"$ref":"#/components/schemas/ItemPropertiesDelta"}},"deleted":{"type":"array","items":{"$ref":"#/components/schemas/ItemPropertiesDelta"}}},"required":["created","updated","deleted"]},"ItemPropertiesDelta":{"type":"object","additionalProperties":false,"properties":{"contentId":{"type":"string"},"itemId":{"type":"integer","format":"int64"},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/PropertyDelta"}}},"required":["contentId","itemId"]},"PropertyDelta":{"type":"object","additionalProperties":false,"properties":{"before":{"type":"string"},"after":{"type":"string"}}},"GetOffersReq":{"properties":{"language":{"type":"string"},"time":{"type":"string"},"stores":{"type":"string"}},"additionalProperties":false,"title":"Get Offers Req","type":"object"},"CommonResponse":{"properties":{"result":{"type":"string"},"data":{"type":"object","additionalProperties":{"type":"string"}}},"additionalProperties":false,"title":"Common Response","type":"object","required":["result","data"]},"ClearStatusRequest":{"properties":{"store":{"type":"string"}},"additionalProperties":false,"title":"Clear Status Request","type":"object","required":["store"]},"PlayerListingView":{"type":"object","additionalProperties":false,"properties":{"clientDataList":{"type":"array","items":{"$ref":"#/components/schemas/ClientDataEntry"}},"symbol":{"type":"string"},"clientData":{"type":"object","additionalProperties":{"type":"string"}},"cooldown":{"type":"integer","format":"int32"},"secondsActive":{"type":"integer","format":"int64"},"offer":{"$ref":"#/components/schemas/PlayerOfferView"},"queryAfterPurchase":{"type":"boolean"},"purchasesRemain":{"type":"integer","format":"int32"},"secondsRemain":{"type":"integer","format":"int64"},"active":{"type":"boolean"}},"required":["symbol","offer","secondsActive","clientData","clientDataList","active","queryAfterPurchase"]},"StatSubscriptionNotification":{"properties":{"statsBefore":{"type":"object","additionalProperties":{"type":"string"}},"statsAfter":{"type":"object","additionalProperties":{"type":"string"}}},"additionalProperties":false,"title":"Stat Subscription Notification","type":"object","required":["statsBefore","statsAfter"]},"ResultResponse":{"properties":{"result":{"type":"boolean"}},"additionalProperties":false,"title":"Result Response","type":"object","required":["result"]},"GetTotalCouponResponse":{"properties":{"count":{"type":"integer","format":"int64"}},"additionalProperties":false,"title":"Get Total Coupon Response","type":"object","required":["count"]},"GiveCouponReq":{"properties":{"listing":{"type":"string"}},"additionalProperties":false,"title":"Give Coupon Req","type":"object","required":["listing"]},"GetStoresReq":{"properties":{"scope":{"type":"string"}},"additionalProperties":false,"title":"Get Stores Req","type":"object"},"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"]},"InventoryUpdateDelta":{"type":"object","additionalProperties":false,"properties":{"currencies":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/CurrencyDelta"}},"items":{"$ref":"#/components/schemas/ItemDeltas"}},"required":["currencies","items"]},"PlayerStoreView":{"type":"object","additionalProperties":false,"properties":{"listings":{"type":"array","items":{"$ref":"#/components/schemas/PlayerListingView"}},"symbol":{"type":"string"},"nextDeltaSeconds":{"type":"integer","format":"int64"},"title":{"type":"string"},"secondsRemain":{"type":"integer","format":"int64"}},"required":["symbol","listings"]},"PurchaseRequest":{"properties":{"purchaseId":{"type":"string"}},"additionalProperties":false,"title":"Purchase Request","type":"object","required":["purchaseId"]},"PlayerOfferView":{"type":"object","additionalProperties":false,"properties":{"coupons":{"type":"integer","format":"int32"},"price":{"$ref":"#/components/schemas/Price"},"buttonText":{"type":"string"},"titles":{"type":"array","items":{"type":"string"}},"symbol":{"type":"string"},"obtainItems":{"type":"array","items":{"$ref":"#/components/schemas/ItemCreateRequest"}},"obtainCurrency":{"type":"array","items":{"$ref":"#/components/schemas/CurrencyChange"}},"images":{"type":"array","items":{"type":"string"}},"descriptions":{"type":"array","items":{"type":"string"}},"obtain":{"type":"array","items":{"type":"string"}}},"required":["symbol","titles","descriptions","images","obtain","obtainCurrency","obtainItems","price","coupons"]},"CurrencyChange":{"type":"object","additionalProperties":false,"properties":{"symbol":{"type":"string"},"amount":{"type":"integer","format":"int64"},"originalAmount":{"type":"integer","format":"int64"}},"required":["symbol","amount"]},"ActiveListingResponse":{"properties":{"storeSymbol":{"type":"string"},"listing":{"$ref":"#/components/schemas/PlayerListingView"}},"additionalProperties":false,"title":"Active Listing Response","type":"object","required":["storeSymbol","listing"]},"CurrencyDelta":{"type":"object","additionalProperties":false,"properties":{"before":{"type":"integer","format":"int64"},"after":{"type":"integer","format":"int64"},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/PropertyDelta"}}},"required":["before","after"]},"ItemProperty":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string"},"value":{"type":"string"}},"required":["name","value"]},"UpdateListingCooldownRequest":{"type":"object","additionalProperties":false,"properties":{"symbol":{"type":"string"},"cooldownReduction":{"type":"integer","format":"int32"}},"required":["symbol","cooldownReduction"]},"InventoryUpdateResponse":{"properties":{"result":{"type":"string"},"data":{"type":"object","additionalProperties":{"type":"string"}},"deltas":{"$ref":"#/components/schemas/InventoryUpdateDelta"}},"additionalProperties":false,"title":"Inventory Update Response","type":"object","required":["result","data"]},"GetActiveOffersResponse":{"properties":{"stores":{"type":"array","items":{"$ref":"#/components/schemas/PlayerStoreView"}}},"additionalProperties":false,"title":"Get Active Offers Response","type":"object","required":["stores"]},"CooldownModifierRequest":{"properties":{"gamerTag":{"type":"integer","format":"int64"},"updateListingCooldownRequests":{"type":"array","items":{"$ref":"#/components/schemas/UpdateListingCooldownRequest"}}},"additionalProperties":false,"title":"Cooldown Modifier Request","type":"object","required":["gamerTag","updateListingCooldownRequests"]},"ClientDataEntry":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string"},"value":{"type":"string"}},"required":["name","value"]}},"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"}