MasterPriceLists

POST master_price_list

Changed on

Create a new master price list

post/v3/administrations/{administration_id}/master_price_lists

Request

Path parameters

administration_idstring required

Administration ID

Query parameters

fields[master_price_list]string

Fieldset. Specify a comma separated list of attributes to return

includestring

Includes list. Specify a comma separated list of resources to include.

Headers

Accept-Languagestring

Supported languages. A comma separated list with one or more of the following locales: cs, da-DK, de, de-AT, de-CH, en-US, en-GB, es, fr, fr-BE, fr-LU, it, nb, nl, nl-BE, pl, pt, tr, en, da. Default: 'en'.

Request body

Example request

{
  "data": {
    "type": "master_price_list",
    "attributes": {
      "round_to": 0.01,
      "round_direction": "ceil"
    },
    "relationships": {
      "administration": {
        "data": {
          "type": "administration"
        }
      },
      "simple_prices": {
        "data": [
          {
            "type": "simple_price"
          }
        ]
      },
      "complex_prices": {
        "data": [
          {
            "type": "complex_price"
          }
        ]
      }
    }
  },
  "included": [
    {
      "id": "1",
      "type": "administration",
      "relationships": {
        "city": {
          "data": {
            "type": "city"
          }
        },
        "checkin_timetable": {
          "data": {
            "type": "timetable"
          }
        },
        "checkout_timetable": {
          "data": {
            "type": "timetable"
          }
        },
        "interactive_map": {
          "data": {
            "type": "interactive_map"
          }
        },
        "payment_handlers": {
          "data": [
            {
              "type": "payment_handler"
            }
          ]
        }
      }
    }
  ]
}

Response

MasterPriceListResponse

Example response

{
  "data": {
    "id": "1",
    "type": "master_price_list",
    "attributes": {
      "round_to": 0.01,
      "round_direction": "ceil"
    },
    "relationships": {
      "administration": {
        "data": {
          "type": "administration"
        }
      },
      "simple_prices": {
        "data": [
          {
            "type": "simple_price"
          }
        ]
      },
      "complex_prices": {
        "data": [
          {
            "type": "complex_price"
          }
        ]
      },
      "price_rules": {
        "data": [
          {
            "type": "rule"
          }
        ]
      }
    }
  },
  "included": [
    {
      "id": "1",
      "type": "administration",
      "relationships": {
        "city": {
          "data": {
            "type": "city"
          }
        },
        "checkin_timetable": {
          "data": {
            "type": "timetable"
          }
        },
        "checkout_timetable": {
          "data": {
            "type": "timetable"
          }
        },
        "interactive_map": {
          "data": {
            "type": "interactive_map"
          }
        },
        "payment_handlers": {
          "data": [
            {
              "type": "payment_handler"
            }
          ]
        }
      }
    }
  ]
}

Changes

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the optional property // to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added to the / response property anyOf list for the response status