• Identity API

Price Adjustment

post

Attach assets to a price adjustment

Attach assets to a specific price adjustment for a network.

assetGroupIdsarray

required

Responses

Request examples

{
  "assetGroupIds": [
    "string"
  ]
}

Response examples

OK

{
  "attached": true
}
get

List Price Adjustments

Retrieve a list of price adjustments based on specified criteria

limitstring

The maximum number of price adjustments to return (default 20, maximum 100).

Pattern
^[0-9][0-9]?$|^100$
startingAfterstring

The ID of the last price adjustment in the previous page of results. Results will start after this price adjustment.

Responses

Response examples

A list of price adjustments

{
  "data": {
    "hasMore": true,
    "items": [
      {
        "id": "string",
        "sitePartnerId": "string",
        "name": {
          "en_US": "string"
        },
        "currency": "string",
        "expirationDate": "2023-06-07T17:32:28Z",
        "type": "PERCENTAGE",
        "amount": 123.0,
        "maxAdjustment": 123.0,
        "status": "ACTIVE",
        "autoApproveInvitations": true,
        "networkId": "string",
        "createdAt": "2023-06-07T17:32:28Z",
        "updatedAt": "2023-06-07T17:32:28Z"
      }
    ]
  }
}
post

Create Price Adjustment

Create a new price adjustment for a site partner

sitePartnerIdstring

required

nameobject

required

en_USstring

required

typestring

required

Enum
  • PERCENTAGE
expirationDatestring
Format
date-time
amountnumber

required

maxAdjustmentnumber
autoApproveInvitationsboolean

required

networkIdstring
currencystring

required

Responses

Request examples

{
  "sitePartnerId": "string",
  "name": {
    "en_US": "string"
  },
  "type": "PERCENTAGE",
  "expirationDate": "2023-06-07T17:32:28Z",
  "amount": 123.0,
  "maxAdjustment": 123.0,
  "autoApproveInvitations": true,
  "networkId": "string",
  "currency": "string"
}

Response examples

OK

{
  "data": {
    "id": "string",
    "sitePartnerId": "string",
    "name": {
      "en_US": "string"
    },
    "currency": "string",
    "expirationDate": "2023-06-07T17:32:28Z",
    "type": "PERCENTAGE",
    "amount": 123.0,
    "maxAdjustment": 123.0,
    "status": "ACTIVE",
    "autoApproveInvitations": true,
    "networkId": "string",
    "createdAt": "2023-06-07T17:32:28Z",
    "updatedAt": "2023-06-07T17:32:28Z"
  }
}
post

Detach assets from a price adjustment

Detach assets from a specific price adjustment for a network.

assetGroupIdsarray

required

Responses

Request examples

{
  "assetGroupIds": [
    "string"
  ]
}

Response examples

OK

{
  "attached": true
}
post

Detach a driver from a price adjustment

Detach one or more drivers from a price adjustment by providing a list of driver IDs

driverIdsarray

required

Responses

Request examples

{
  "driverIds": [
    "string"
  ]
}

Response examples

OK

{
  "success": true
}
patch

Disable a price adjustment

Disable a specific price adjustment

priceAdjustmentIdstring

required

Responses

Response examples

OK

{
  "data": {
    "id": "string",
    "sitePartnerId": "string",
    "name": {
      "en_US": "string"
    },
    "currency": "string",
    "expirationDate": "2023-06-07T17:32:28Z",
    "type": "PERCENTAGE",
    "amount": 123.0,
    "maxAdjustment": 123.0,
    "status": "ACTIVE",
    "autoApproveInvitations": true,
    "networkId": "string",
    "createdAt": "2023-06-07T17:32:28Z",
    "updatedAt": "2023-06-07T17:32:28Z"
  }
}
get

List Price Adjustment Asset Junctions

Retrieve a list of Price Adjustment Asset Junctions based on specified criteria.

limitstring

The maximum number of Price Adjustment Asset Junctions to return (default 20, maximum 100).

Pattern
^[0-9][0-9]?$|^100$
startingAfterAssetstring

The ID of the last asset in the previous page of results. Results will start after this asset.

startingAfterPriceAdjustmentstring

The ID of the last price adjustment in the previous page of results. Results will start after this price adjustment.

Responses

Response examples

OK

{
  "data": {
    "hasMore": true,
    "items": [
      {
        "priceAdjustmentId": "string",
        "networkId": "string",
        "status": "ATTACHED",
        "attachedAt": "2023-06-07T17:32:28Z",
        "detachedAt": "2023-06-07T17:32:28Z",
        "createdAt": "2023-06-07T17:32:28Z",
        "updatedAt": "2023-06-07T17:32:28Z",
        "assetId": "string"
      }
    ]
  }
}
get

List Price Adjustment Driver Junctions

Retrieve a list of Price Adjustment Driver Junctions based on specified criteria.

limitstring

The maximum number of Price Adjustment Druver Junctions to return (default 20, maximum 100).

Pattern
^[0-9][0-9]?$|^100$
startingAfterDriverstring

The ID of the last driver in the previous page of results. Results will start after this driver.

startingAfterPriceAdjustmentstring

The ID of the last price adjustment in the previous page of results. Results will start after this price adjustment.

Responses

Response examples

OK

{
  "data": {
    "hasMore": true,
    "items": [
      {
        "priceAdjustmentId": "string",
        "networkId": "string",
        "status": "ATTACHED",
        "attachedAt": "2023-06-07T17:32:28Z",
        "detachedAt": "2023-06-07T17:32:28Z",
        "createdAt": "2023-06-07T17:32:28Z",
        "updatedAt": "2023-06-07T17:32:28Z",
        "driverId": "string"
      }
    ]
  }
}
get

Retrieve an applicable Price Adjustment

Search for an applicable price adjustment based on assetId and driverId

assetIdstring

The ID of the asset for which the price adjustment is applicable.

driverIdstring

The ID of the driver for whom the price adjustment is applicable.

Responses

Response examples

OK

{
  "data": {
    "id": "string",
    "sitePartnerId": "string",
    "name": {
      "en_US": "string"
    },
    "currency": "string",
    "expirationDate": "2023-06-07T17:32:28Z",
    "type": "PERCENTAGE",
    "amount": 123.0,
    "maxAdjustment": 123.0,
    "status": "ACTIVE",
    "autoApproveInvitations": true,
    "networkId": "string",
    "createdAt": "2023-06-07T17:32:28Z",
    "updatedAt": "2023-06-07T17:32:28Z"
  }
}
patch

Update a priceAdjustment

This endpoint updates an existing priceAdjustment by its ID./

nameobject
en_USstring

required

autoApproveInvitationsboolean

Responses

Request examples

{
  "name": {
    "en_US": "string"
  },
  "autoApproveInvitations": true
}

Response examples

The updated priceAdjustment object.

{
  "data": {
    "id": "string",
    "sitePartnerId": "string",
    "name": {
      "en_US": "string"
    },
    "currency": "string",
    "expirationDate": "2023-06-07T17:32:28Z",
    "type": "PERCENTAGE",
    "amount": 123.0,
    "maxAdjustment": 123.0,
    "status": "ACTIVE",
    "autoApproveInvitations": true,
    "networkId": "string",
    "createdAt": "2023-06-07T17:32:28Z",
    "updatedAt": "2023-06-07T17:32:28Z"
  }
}

Was this page helpful?