v1

latestOpenAPI 3.0.12026-07-243686491.1 MB

Price Groups Tags

Retrieve a single price group tag

Required scope: price-groups:read </br>Organization authorization: supported

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

Path parameters

idinteger required

Response

Price group tag with provided id

idinteger

The id for this tag.

namestring required

The name for this tag.

descriptionstring nullable

The description for this tag.

partnerExternalIdstring nullable

External Id of this entity, managed by you.

partnerCustomPayloadobject[] nullable

Custom JSON payload for this entity, managed by you.

createdAtstring date-time required

Creation date of this resource.

updatedAtstring date-time nullable

Last update date of this resource.

Example response

{
  "name": "Energy",
  "description": "Used to group `Energy` pricing elements",
  "partnerExternalId": "ACME-12345",
  "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"
}