Entur Developer
Set up fare data

5. Create a sales package

A product is sold through a sales package (SalesOfferPackage). Create a sales package with your product, and decide which sales channels may sell it.

Before you begin

Make sure that:

  • Your product is under test or published. See 4. Test and publish.
  • You have the product's id and the versionId of the version you want to sell.

How a sales package works

A sales package is what a sales channel actually sells. It has two parts:

  • Products. The package contains one or more products. It refers to a specific version of each product by its versionId. When a product gets a new version, the package doesn't change until it gets a new version too.
  • Distribution assignments. A DistributionAssignment says which sales channel may sell the package, and what the channel may do with it: sell, refund or exchange. A package has one assignment per channel.

1. Create the sales package

Create a sales package that contains the version of your product that you want to sell:

2. Choose the sales channels

Add a distribution assignment for each sales channel that may sell the package.

For example, a parking product can be sold on its own in staffed channels, such as a ticket office or a customer service centre. In self-service channels, the same parking product can be sold together with train tickets in the train operators' own sales packages. You don't add those channels to your package.

3. Test and publish

A sales package has the same lifecycle as the product:

  1. propose it with the effective dates it should have. It is then available in the staging environment.

    POST /v3/sales-offer-packages/{id}/{version}/propose

  2. Test the purchase in the Entur app for staging. Check that the product is offered with the right name, price and purchase window, and that it can be bought in the channels you chose.

  3. Publish the parameters, prices and product as described in 4. Test and publish, and then publish the sales package.

    POST /v3/sales-offer-packages/{id}/{version}/publish

See Publish order.

Next steps

6. Maintain your fare data

Last modified on
Did you find what you were looking for?