Price Groups Tags

Retrieve price group tags.

GET

https://partner-api.monta.com

/api/v1/price-group-tags

Required scope: price-groups:read
Organization authorization: supported

Retrieve price group tags. › query Parameters

page

integer · int32

Page number to retrieve (starts with 0)

Default: 0

perPage

integer · int32

Number of items per page (between 1 and 100, default 10)

Default: 10

name

string | null

Filter to retrieve resources by the specified name.

Example: Energy

partnerExternalId

string | null

Filter resources by partnerExternalId, to filter only resources without partnerExternalId use partnerExternalId=""

Example: 1A2B

Retrieve price group tags. › Responses

Price group tags for a given filter

OffsetBasedResponse_44

PriceGroupTag[] · required

MontaPage.Meta · required

GET/api/v1/price-group-tags

curl https://partner-api.monta.com/api/v1/price-group-tags \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "data": [
    {
      "id": null,
      "name": "Energy",
      "description": "Used to group `Energy` pricing elements",
      "partnerExternalId": "ACME-12345",
      "partnerCustomPayload": {
        "internalId": "ACME-12345",
        "department": "Fleet"
      },
      "operator": {
        "id": 14,
        "name": "Monta",
        "identifier": "monta",
        "partnerId": 1,
        "vatNumber": "FOO-123-ABC"
      },
      "createdAt": "2022-05-12T15:56:45.99Z",
      "updatedAt": "2022-05-12T16:56:45.99Z"
    }
  ],
  "meta": {
    "itemCount": 0,
    "currentPage": 0,
    "perPage": 0,
    "totalPageCount": 0,
    "totalItemCount": 0
  }
}

json

application/json

Create a price group tag

POST

https://partner-api.monta.com

/api/v1/price-group-tags

Required scope: price-groups:write
Organization authorization: supported

Create a price group tag › Request Body

CreatePriceGroupTag

name

string · minLength: 1 · required

Name of the tag. names are unique and cannot be reused.

Example: Energy

description

string | null

Description of the tag.

Example: Can be used to group `Energy` pricing elements

partnerExternalId

string | null

External Id of this entity, managed by you.

Example: ACME-12345

object | null

Custom JSON payload for this entity, managed by you.
Note: the expected shape is a flat JSON object with named keys. The payload is limited to 1000 characters.

Example: {"internalId":"ACME-12345","department":"Fleet"}

Create a price group tag › Responses

Price group tag created

PriceGroupTag

name

string · required

The name for this tag.

Example: Energy

createdAt

string · date-time · required

Creation date of this resource.

Example: 2022-05-12T15:56:45.99Z

id

integer · int64

The id for this tag.

Example: null

description

string | null

The description for this tag.

Example: Used to group `Energy` pricing elements

partnerExternalId

string | null

External Id of this entity, managed by you.

Example: ACME-12345

object | null

Custom JSON payload for this entity, managed by you.
Note: the expected shape is a flat JSON object with named keys.

Example: {"internalId":"ACME-12345","department":"Fleet"}

object

The operator to which this resource belongs to.

updatedAt

string | null · date-time

Last update date of this resource.

Example: 2022-05-12T16:56:45.99Z

POST/api/v1/price-group-tags

curl https://partner-api.monta.com/api/v1/price-group-tags \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "name": "Energy",
  "description": "Can be used to group `Energy` pricing elements",
  "partnerExternalId": "ACME-12345",
  "partnerCustomPayload": {
    "internalId": "ACME-12345",
    "department": "Fleet"
  }
}'

Example Request Body

{
  "name": "Energy",
  "description": "Can be used to group `Energy` pricing elements",
  "partnerExternalId": "ACME-12345",
  "partnerCustomPayload": {
    "internalId": "ACME-12345",
    "department": "Fleet"
  }
}

json

Example Responses

{
  "id": null,
  "name": "Energy",
  "description": "Used to group `Energy` pricing elements",
  "partnerExternalId": "ACME-12345",
  "partnerCustomPayload": {
    "internalId": "ACME-12345",
    "department": "Fleet"
  },
  "operator": {
    "id": 14,
    "name": "Monta",
    "identifier": "monta",
    "partnerId": 1,
    "vatNumber": "FOO-123-ABC"
  },
  "createdAt": "2022-05-12T15:56:45.99Z",
  "updatedAt": "2022-05-12T16:56:45.99Z"
}

json

application/json

Retrieve a single price group tag

GET

https://partner-api.monta.com

/api/v1/price-group-tags/{id}

Required scope: price-groups:read
Organization authorization: supported

Retrieve a single price group tag › path Parameters

id

integer · int64 · required

Retrieve a single price group tag › Responses

Price group tag with provided id

PriceGroupTag

name

string · required

The name for this tag.

Example: Energy

createdAt

string · date-time · required

Creation date of this resource.

Example: 2022-05-12T15:56:45.99Z

id

integer · int64

The id for this tag.

Example: null

description

string | null

The description for this tag.

Example: Used to group `Energy` pricing elements

partnerExternalId

string | null

External Id of this entity, managed by you.

Example: ACME-12345

object | null

Custom JSON payload for this entity, managed by you.
Note: the expected shape is a flat JSON object with named keys.

Example: {"internalId":"ACME-12345","department":"Fleet"}

object

The operator to which this resource belongs to.

updatedAt

string | null · date-time

Last update date of this resource.

Example: 2022-05-12T16:56:45.99Z

Update a price group tag

PATCH

https://partner-api.monta.com

/api/v1/price-group-tags/{id}

Required scope: price-groups:write
Organization authorization: supported

Update a price group tag › path Parameters

id

integer · int64 · required

Update a price group tag › Request Body

PatchPriceGroupTag

name

string | null

Name of the tag.

Example: Energy

description

string | null

Description of the tag.

Example: Can be used to group `Energy` pricing elements

partnerExternalId

string | null

External Id of this entity, managed by you.

Example: ACME-12345

object | null

Custom JSON payload for this entity, managed by you.
Note: the expected shape is a flat JSON object with named keys. The payload is limited to 1000 characters.

Example: {"internalId":"ACME-12345","department":"Fleet"}

Update a price group tag › Responses

Price group tag updated

PriceGroupTag

name

string · required

The name for this tag.

Example: Energy

createdAt

string · date-time · required

Creation date of this resource.

Example: 2022-05-12T15:56:45.99Z

id

integer · int64

The id for this tag.

Example: null

description

string | null

The description for this tag.

Example: Used to group `Energy` pricing elements

partnerExternalId

string | null

External Id of this entity, managed by you.

Example: ACME-12345

object | null

Custom JSON payload for this entity, managed by you.
Note: the expected shape is a flat JSON object with named keys.

Example: {"internalId":"ACME-12345","department":"Fleet"}

object

The operator to which this resource belongs to.

updatedAt

string | null · date-time

Last update date of this resource.

Example: 2022-05-12T16:56:45.99Z

PATCH/api/v1/price-group-tags/{id}

curl https://partner-api.monta.com/api/v1/price-group-tags/:id \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "name": "Energy",
  "description": "Can be used to group `Energy` pricing elements",
  "partnerExternalId": "ACME-12345",
  "partnerCustomPayload": {
    "internalId": "ACME-12345",
    "department": "Fleet"
  }
}'

Example Request Body

{
  "name": "Energy",
  "description": "Can be used to group `Energy` pricing elements",
  "partnerExternalId": "ACME-12345",
  "partnerCustomPayload": {
    "internalId": "ACME-12345",
    "department": "Fleet"
  }
}

json

Example Responses

{
  "id": null,
  "name": "Energy",
  "description": "Used to group `Energy` pricing elements",
  "partnerExternalId": "ACME-12345",
  "partnerCustomPayload": {
    "internalId": "ACME-12345",
    "department": "Fleet"
  },
  "operator": {
    "id": 14,
    "name": "Monta",
    "identifier": "monta",
    "partnerId": 1,
    "vatNumber": "FOO-123-ABC"
  },
  "createdAt": "2022-05-12T15:56:45.99Z",
  "updatedAt": "2022-05-12T16:56:45.99Z"
}

json

application/json

Delete an existing price group tag

DELETE

https://partner-api.monta.com

/api/v1/price-group-tags/{id}

Required scope: price-groups:delete
Organization authorization: supported

Delete an existing price group tag › path Parameters

id

integer · int64 · required

Delete an existing price group tag › Responses

Price group tag deleted

No data returned

Price Groups Prices Forecast