API docs by Redocly

PHPR API (3.7.0)

Download OpenAPI specification:

PHPR API USING API-PLATFORM

rates

Retrieves a rates resource.

Retrieves a rates resource.

Authorizations:
JWT
path Parameters
id
required
string

rates identifier

Responses

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "name": "string",
  • "rate": "string",
  • "rateApplicationDate": "2019-08-24T14:15:22Z",
  • "notes": "string",
  • "shortcode": "RATE",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "slug": "string",
  • "customProperties": null,
  • "customData": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "disabledAt": "2019-08-24T14:15:22Z",
  • "toString": "string",
  • "anonymousToken": "string",
  • "uniqueId": "string",
  • "taggingListing": "string",
  • "enabled": true,
  • "disabled": true
}

Replaces the rates resource.

Replaces the rates resource.

Authorizations:
JWT
path Parameters
id
required
string

rates identifier

Request Body schema:
required

The updated rates resource

name
required
string
rate
required
string
rateApplicationDate
required
string <date-time>
notes
string or null
deletedAt
string or null <date-time>
slug
required
string

DB Identifier

customData
Array of strings or null
disabledAt
string or null <date-time>

Responses

Request samples

Content type
{
  • "name": "string",
  • "rate": "string",
  • "rateApplicationDate": "2019-08-24T14:15:22Z",
  • "notes": "string",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "slug": "string",
  • "customData": [
    ],
  • "disabledAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "name": "string",
  • "rate": "string",
  • "rateApplicationDate": "2019-08-24T14:15:22Z",
  • "notes": "string",
  • "shortcode": "RATE",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "slug": "string",
  • "customProperties": null,
  • "customData": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "disabledAt": "2019-08-24T14:15:22Z",
  • "toString": "string",
  • "anonymousToken": "string",
  • "uniqueId": "string",
  • "taggingListing": "string",
  • "enabled": true,
  • "disabled": true
}

Removes the rates resource.

Removes the rates resource.

Authorizations:
JWT
path Parameters
id
required
string

rates identifier

Responses