Offer service (internal) version v4

http://{slave}

Announced as offer in Zookeeper

  • slave: required(string)

/offer/v4/offers

post get

post
get

Headers

  • Magine-PartnerId: required(string)

    Partner id

    Example:

    magine
  • Authorization: required(string)

    Internal authorization header

Body

Media type: application/json

Type: object

Properties
  • packId: required(string)
  • type: required(one of default, est, pass, rental, subscription, thirdparty)

    The entitlement type of the offer.

  • timing: required(object)
    • purchaseAvailableSince: (string)

      Time when the offer becomes available for purchase

      Example:

      "2017-12-01T00:00:00Z"
    • purchaseAvailableUntil: (string)

      Time when the offer is no longer available

      Example:

      "2017-12-01T00:00:00Z"
    • entitlementDurationSec: (integer)

      The length of time the pack will be available after purchase. Required for rentals, never present for ESTs

    • renewalPeriodicity: (one of monthly, yearly)

      The auto-renewal periodicity for subscriptions

    • trialDurationSec: (integer)
  • pricing: required(object)
    • upfrontPriceCents: required(integer)
    • currency: required(string)

    Example:

    {
  "currency" : "USD",
  "upfrontPriceCents" : 50
}
  • regions: required(array of union)

    Regions in which the offer is available. Either "worldwide" or an array of country codes.

    Example:

    [
  "DE",
  "FR"
]
  • thirdPartyReference: (object)
    • providerName: required(string)
    • externalOfferId: required(string)
    • providerId: required(string)

      deprecated, use externalOfferId instead

  • includeAds: (boolean - default: false)

HTTP status code 201

Body

Media type: application/json

Type: object

Properties
  • offerId: required(string)
  • partnerId: required(string)
  • packId: required(string)
  • type: required(one of default, est, pass, rental, subscription, thirdparty)

    The entitlement type of the offer.

  • regions: required(array of union)

    Regions in which the offer is available. Either "worldwide" or an array of country codes.

    Example:

    [
  "DE",
  "FR"
]
  • timing: required(object)
    • purchaseAvailableSince: (string)

      Time when the offer becomes available for purchase

      Example:

      "2017-12-01T00:00:00Z"
    • purchaseAvailableUntil: (string)

      Time when the offer is no longer available

      Example:

      "2017-12-01T00:00:00Z"
    • entitlementDurationSec: (integer)

      The length of time the pack will be available after purchase. Required for rentals, never present for ESTs

    • renewalPeriodicity: (one of monthly, yearly)

      The auto-renewal periodicity for subscriptions

    • trialDurationSec: (integer)
  • pricing: required(object)
    • upfrontPriceCents: required(integer)
    • currency: required(string)
    • reducedPrice: (object)
      • amountCents: required(integer)
      • currency: required(string)
      • numberOfBillinPeriods: (integer)

    Example:

    {
  "currency" : "USD",
  "upfrontPriceCents" : 50
}
  • disabled: required(boolean)
  • creationEventSentAt: (string)

    Example:

    "2017-12-01T00:00:00Z"
  • includeAds: (boolean - default: false)

Example:

{
  "offerId" : "6NBYG9ZA6DEXSULCVDQQCKGFEOFR",
  "partnerId" : "example",
  "packId" : "BWMNRRLFAFJQ09F79EKZ11Q97PCK",
  "type" : "est",
  "regions" : [
    "DE",
    "FR"
  ],
  "timing" : {
    "purchaseAvailableSince" : "2017-11-01T13:14:15Z",
    "purchaseAvailableUntil" : "2018-11-01T13:14:15Z"
  },
  "pricing" : {
    "currency" : "USD",
    "upfrontPriceCents" : 50
  },
  "createdAt" : "2017-12-01T00:00:00Z",
  "disabled" : false,
  "title" : "best offer in the world",
  "titleInternal" : "worst console title in the world",
  "image" : "http://image.server.se/mypicture123.jpg",
  "usps" : [
    "AAA"
  ],
  "thirdPartyReference" : {
    "providerName" : "SOME_PROVIDER",
    "providerId" : "someId",
    "externalOfferId" : "someId"
  },
  "includeAds" : true,
  "hidden" : false
}

HTTP status code 400

Bad request

HTTP status code 401

Invalid authorization header

get

get

URI Parameters

  • offerId: required(string)

Headers

  • Magine-PartnerId: required(string)

    Partner id

    Example:

    magine
  • Authorization: required(string)

    Internal authorization header

HTTP status code 201

Body

Media type: application/json

Type: object

Properties
  • offerId: required(string)
  • partnerId: required(string)
  • packId: required(string)
  • type: required(one of default, est, pass, rental, subscription, thirdparty)

    The entitlement type of the offer.

  • regions: required(array of union)

    Regions in which the offer is available. Either "worldwide" or an array of country codes.

    Example:

    [
  "DE",
  "FR"
]
  • timing: required(object)
    • purchaseAvailableSince: (string)

      Time when the offer becomes available for purchase

      Example:

      "2017-12-01T00:00:00Z"
    • purchaseAvailableUntil: (string)

      Time when the offer is no longer available

      Example:

      "2017-12-01T00:00:00Z"
    • entitlementDurationSec: (integer)

      The length of time the pack will be available after purchase. Required for rentals, never present for ESTs

    • renewalPeriodicity: (one of monthly, yearly)

      The auto-renewal periodicity for subscriptions

    • trialDurationSec: (integer)
  • pricing: required(object)
    • upfrontPriceCents: required(integer)
    • currency: required(string)
    • reducedPrice: (object)
      • amountCents: required(integer)
      • currency: required(string)
      • numberOfBillinPeriods: (integer)

    Example:

    {
  "currency" : "USD",
  "upfrontPriceCents" : 50
}
  • disabled: required(boolean)
  • creationEventSentAt: (string)

    Example:

    "2017-12-01T00:00:00Z"
  • includeAds: (boolean - default: false)

Example:

{
  "offerId" : "6NBYG9ZA6DEXSULCVDQQCKGFEOFR",
  "partnerId" : "example",
  "packId" : "BWMNRRLFAFJQ09F79EKZ11Q97PCK",
  "type" : "est",
  "regions" : [
    "DE",
    "FR"
  ],
  "timing" : {
    "purchaseAvailableSince" : "2017-11-01T13:14:15Z",
    "purchaseAvailableUntil" : "2018-11-01T13:14:15Z"
  },
  "pricing" : {
    "currency" : "USD",
    "upfrontPriceCents" : 50
  },
  "createdAt" : "2017-12-01T00:00:00Z",
  "disabled" : false,
  "title" : "best offer in the world",
  "titleInternal" : "worst console title in the world",
  "image" : "http://image.server.se/mypicture123.jpg",
  "usps" : [
    "AAA"
  ],
  "thirdPartyReference" : {
    "providerName" : "SOME_PROVIDER",
    "providerId" : "someId",
    "externalOfferId" : "someId"
  },
  "includeAds" : true,
  "hidden" : false
}

HTTP status code 400

Bad request

HTTP status code 401

Invalid authorization header

/offer/v4/packs

post

post

Headers

  • Magine-PartnerId: required(string)

    Partner id

    Example:

    magine
  • Authorization: required(string)

    Internal authorization header

Body

Media type: application/json

Type: object

HTTP status code 201

Body

Media type: application/json

Type: object

Properties
  • id: required(string)
  • name: required(string)
  • viewables: required(array of string)
  • createdAt: required(string)

    Example:

    "2017-12-01T00:00:00Z"

HTTP status code 400

Bad request

HTTP status code 401

Unauthorized

get

get

URI Parameters

  • packId: required(string)

Headers

  • Magine-PartnerId: required(string)

    Partner id

    Example:

    magine
  • Authorization: required(string)

    Internal authorization header

HTTP status code 200

Body

Media type: application/json

Type: object

Properties
  • id: required(string)
  • name: required(string)
  • viewables: required(array of string)
  • createdAt: required(string)

    Example:

    "2017-12-01T00:00:00Z"

HTTP status code 400

Bad request

HTTP status code 401

Unauthorized

/offer/v4/offers/{offerId}/prices

get post

get
post

URI Parameters

  • offerId: required(string)

Headers

  • Magine-PartnerId: required(string)

    Partner id

    Example:

    magine
  • Authorization: required(string)

    Internal authorization header

HTTP status code 200

Body

Media type: application/json

Type: array of object

Items: OfferPriceOutput

  • priceId: required(string)
  • offerId: required(string)
  • amountCents: required(integer)
  • startDateInitialPurchase: required(string)

    Example:

    "2017-12-01T00:00:00Z"
  • startDateRenewal: required(string)

    Example:

    "2017-12-01T00:00:00Z"
  • emailsSent: required(boolean)
  • createdAt: required(string)

    Example:

    "2017-12-01T00:00:00Z"
  • modifiedAt: required(string)

    Example:

    "2017-12-01T00:00:00Z"

Example:

[
  {
    "priceId" : "513d7531-74ee-438c-8580-2eb4b614e39e",
    "offerId" : "6NBYG9ZA6DEXSULCVDQQCKGFEOFR",
    "amountCents" : 50,
    "startDateInitialPurchase" : "2017-12-01T00:00:00Z",
    "startDateRenewal" : "2017-12-01T00:00:00Z",
    "emailsSent" : true,
    "createdAt" : "2017-12-01T00:00:00Z",
    "modifiedAt" : "2017-12-01T00:00:00Z"
  },
  {
    "priceId" : "35ff5267-576d-4fa2-8322-6b57acf1ece7",
    "offerId" : "6NBYG9ZA6DEXSULCVDQQCKGFEOFR",
    "amountCents" : 1000,
    "startDateInitialPurchase" : "2017-12-02T00:00:00Z",
    "startDateRenewal" : "2017-12-02T00:00:00Z",
    "emailsSent" : false,
    "createdAt" : "2017-12-01T00:00:00Z",
    "modifiedAt" : "2017-12-01T00:00:00Z"
  }
]

HTTP status code 400

Bad request

HTTP status code 401

Invalid authorization header

HTTP status code 404

Offer Id is not found

URI Parameters

  • offerId: required(string)

Headers

  • Magine-PartnerId: required(string)

    Partner id

    Example:

    magine
  • Authorization: required(string)

    Internal authorization header

Body

Media type: application/json

Type: object

Properties
  • amountCents: required(integer)
  • startDateInitialPurchase: required(string)

    Example:

    "2017-12-01T00:00:00Z"
  • startDateRenewal: required(string)

    Example:

    "2017-12-01T00:00:00Z"

HTTP status code 201

Body

Media type: application/json

Type: object

Properties
  • priceId: required(string)
  • offerId: required(string)
  • amountCents: required(integer)
  • startDateInitialPurchase: required(string)

    Example:

    "2017-12-01T00:00:00Z"
  • startDateRenewal: required(string)

    Example:

    "2017-12-01T00:00:00Z"
  • emailsSent: required(boolean)
  • createdAt: required(string)

    Example:

    "2017-12-01T00:00:00Z"
  • modifiedAt: required(string)

    Example:

    "2017-12-01T00:00:00Z"

Example:

{
  "priceId" : "8bb0b50f-6e00-4dc4-b98e-850bb92894a8",
  "offerId" : "6NBYG9ZA6DEXSULCVDQQCKGFEOFR",
  "amountCents" : 1000,
  "startDateInitialPurchase" : "2017-12-02T00:00:00Z",
  "startDateRenewal" : "2017-12-02T00:00:00Z",
  "emailsSent" : false,
  "createdAt" : "2017-12-01T00:00:00Z",
  "modifiedAt" : "2017-12-01T00:00:00Z"
}

HTTP status code 400

Bad request

HTTP status code 401

Invalid authorization header

get put delete

get
put
delete

URI Parameters

  • offerId: required(string)
  • priceId: required(string)

Headers

  • Magine-PartnerId: required(string)

    Partner id

    Example:

    magine
  • Authorization: required(string)

    Internal authorization header

HTTP status code 200

Body

Media type: application/json

Type: object

Properties
  • priceId: required(string)
  • offerId: required(string)
  • amountCents: required(integer)
  • startDateInitialPurchase: required(string)

    Example:

    "2017-12-01T00:00:00Z"
  • startDateRenewal: required(string)

    Example:

    "2017-12-01T00:00:00Z"
  • emailsSent: required(boolean)
  • createdAt: required(string)

    Example:

    "2017-12-01T00:00:00Z"
  • modifiedAt: required(string)

    Example:

    "2017-12-01T00:00:00Z"

Example:

{
  "priceId" : "8bb0b50f-6e00-4dc4-b98e-850bb92894a8",
  "offerId" : "6NBYG9ZA6DEXSULCVDQQCKGFEOFR",
  "amountCents" : 1000,
  "startDateInitialPurchase" : "2017-12-02T00:00:00Z",
  "startDateRenewal" : "2017-12-02T00:00:00Z",
  "emailsSent" : false,
  "createdAt" : "2017-12-01T00:00:00Z",
  "modifiedAt" : "2017-12-01T00:00:00Z"
}

HTTP status code 400

Bad request

HTTP status code 401

Invalid authorization header

HTTP status code 404

Offer Id or price Id is not found

URI Parameters

  • offerId: required(string)
  • priceId: required(string)

Headers

  • Magine-PartnerId: required(string)

    Partner id

    Example:

    magine
  • Authorization: required(string)

    Internal authorization header

Body

Media type: application/json

Type: object

Properties
  • amountCents: required(integer)
  • startDateInitialPurchase: required(string)

    Example:

    "2017-12-01T00:00:00Z"
  • startDateRenewal: required(string)

    Example:

    "2017-12-01T00:00:00Z"

HTTP status code 200

Body

Media type: application/json

Type: object

Properties
  • priceId: required(string)
  • offerId: required(string)
  • amountCents: required(integer)
  • startDateInitialPurchase: required(string)

    Example:

    "2017-12-01T00:00:00Z"
  • startDateRenewal: required(string)

    Example:

    "2017-12-01T00:00:00Z"
  • emailsSent: required(boolean)
  • createdAt: required(string)

    Example:

    "2017-12-01T00:00:00Z"
  • modifiedAt: required(string)

    Example:

    "2017-12-01T00:00:00Z"

Example:

{
  "priceId" : "8bb0b50f-6e00-4dc4-b98e-850bb92894a8",
  "offerId" : "6NBYG9ZA6DEXSULCVDQQCKGFEOFR",
  "amountCents" : 1000,
  "startDateInitialPurchase" : "2017-12-02T00:00:00Z",
  "startDateRenewal" : "2017-12-02T00:00:00Z",
  "emailsSent" : false,
  "createdAt" : "2017-12-01T00:00:00Z",
  "modifiedAt" : "2017-12-01T00:00:00Z"
}

HTTP status code 400

Bad request

HTTP status code 401

Invalid authorization header

HTTP status code 404

Offer Id or price Id is not found

URI Parameters

  • offerId: required(string)
  • priceId: required(string)

Headers

  • Magine-PartnerId: required(string)

    Partner id

    Example:

    magine
  • Authorization: required(string)

    Internal authorization header

HTTP status code 204

Price change deleted successfully

HTTP status code 400

Bad request

HTTP status code 401

Invalid authorization header

HTTP status code 403

Forbidden because price is already active or it is the only offer price

HTTP status code 404

Offer Id or price Id is not found