Get a supplier policy by ID

GET 
/v1/rates/supplier-policies/:id

Get a supplier policy by ID

Request

Path Parameters

id stringrequired

Supplier policy ID

Responses

200

Supplier policy found

application/json

Schema

Schema

_id stringrequired
name stringrequired
reservation object

freeTime number

Default value: 0

freeTimeUnit string

Possible values: [minute, hour]

penaltyActive boolean

fieldExclusions string[]

penaltyTiers object[]

Array [

fareType string

Default value: percent

commissionType string

Default value: commission

rangeStart number

rangeEnd number

penaltyPercent number

commissionPercent number

penaltyFee number

Default value: 0

commissionFee number

Default value: 0

]

penaltyType string

Possible values: [amount, percent]

penaltyFee number

Default value: 0

onDemand object

freeTime number

Default value: 0

freeTimeUnit string

Possible values: [minute, hour]

penaltyType string

Possible values: [amount, percent]

commissionType string

Possible values: [commission, fixed]

fieldExclusions string[]

penaltyFee number

Default value: 0

commissionFee number

Default value: 0

noShow object

penaltyType string

Possible values: [amount, percent, basedOnPayout]

commissionType string

Possible values: [commission, fixed]

fieldExclusions string[]

penaltyFee number

Default value: 0

commissionFee number

Default value: 0

createdDate date-time
latestUpdate date-time

Example (from schema)

{
  "_id": "string",
  "name": "Standard Supplier Policy",
  "reservation": {
    "freeTime": 0,
    "freeTimeUnit": "minute",
    "penaltyActive": true,
    "fieldExclusions": [
      "string"
    ],
    "penaltyTiers": [
      {
        "fareType": "percent",
        "commissionType": "commission",
        "rangeStart": 0,
        "rangeEnd": 0,
        "penaltyPercent": 0,
        "commissionPercent": 0,
        "penaltyFee": 0,
        "commissionFee": 0
      }
    ],
    "penaltyType": "amount",
    "penaltyFee": 0
  },
  "onDemand": {
    "freeTime": 0,
    "freeTimeUnit": "minute",
    "penaltyType": "amount",
    "commissionType": "commission",
    "fieldExclusions": [
      "string"
    ],
    "penaltyFee": 0,
    "commissionFee": 0
  },
  "noShow": {
    "penaltyType": "amount",
    "commissionType": "commission",
    "fieldExclusions": [
      "string"
    ],
    "penaltyFee": 0,
    "commissionFee": 0
  },
  "createdDate": "2024-07-29T15:51:28.071Z",
  "latestUpdate": "2024-07-29T15:51:28.071Z"
}

400

Invalid input data

404

Supplier policy not found

409

Supplier policy already exists

500

Internal server error

Loading...