Price Service events

Overview

Webhook events related to the creation, update, and deletion of a price, price model, price list and a price list price.

Available events

Event typeEvent schema
price.created
Copy
Copied
{
  "id": "String",
  "itemId": {
    "id": "String",
    "itemType": "String"
  },
  "itemYrn": "String",
  "currency": "String",
  "location": {
    "countryCode": "String"
  },
  "salePrice": {
    "discountAmount": "String",
    "discountRate": "String",
    "description": "String"
  },
  "priceModelId": "String",
  "restrictions": {
    "principals": [
      {
        "id": "String",
        "type": "String"
      }
    ],
    "validity": {
      "from": "String",
      "to": "String"
    },
    "siteCodes": ["String"],
    "priceListId": "String"
  },
  "tierValues": [
    {
      "id": "String",
      "priceValue": "String"
    }
  ],
  "mixins": "Map",
  "metadata": {
    "createdAt": "String",
    "modifiedAt": "String",
    "version": "Number",
    "mixins": "Map"
  }
}
price.updated
Copy
Copied
{
  "id": "String",
  "itemId": {
    "id": "String",
    "itemType": "String"
  },
  "itemYrn": "String",
  "currency": "String",
  "location": {
    "countryCode": "String"
  },
  "salePrice": {
    "discountAmount": "String",
    "discountRate": "String",
    "description": "String"
  },
  "priceModelId": "String",
  "restrictions": {
    "principals": [
      {
        "id": "String",
        "type": "String"
      }
    ],
    "validity": {
      "from": "String",
      "to": "String"
    },
    "siteCodes": ["String"],
    "priceListId": "String"
  },
  "tierValues": [
    {
      "id": "String",
      "priceValue": "String"
    }
  ],
  "mixins": "Map",
  "metadata": {
    "createdAt": "String",
    "modifiedAt": "String",
    "version": "Number",
    "mixins": "Map"
  }
}
price.deleted
Copy
Copied
{
  "id": "String"
}
price-model.created
Copy
Copied
{
  "id": "String",
  "name": "Map",
  "description": "Map",
  "includesTax": "Boolean",
  "isDefault": "Boolean",
  "measurementUnit": {
    "quantity": "Number",
    "unitCode": "String"
  },
  "tierDefinition": {
    "tierType": "String",
    "tiers": [
      {
        "id": "String",
        "minQuantity": {
          "quantity": "Number",
          "unitCode": "String"
        }
      }
    ]
  },
  "metadata": {
    "version": "Number",
    "createdAt": "String",
    "modifiedAt": "String"
  }
}
price-model.updated
Copy
Copied
{
  "id": "String",
  "name": "Map",
  "description": "Map",
  "includesTax": "Boolean",
  "isDefault": "Boolean",
  "measurementUnit": {
    "quantity": "Number",
    "unitCode": "String"
  },
  "tierDefinition": {
    "tierType": "String",
    "tiers": [
      {
        "id": "String",
        "minQuantity": {
          "quantity": "Number",
          "unitCode": "String"
        }
      }
    ]
  },
  "metadata": {
    "version": "Number",
    "createdAt": "String",
    "modifiedAt": "String"
  }
}
price-model.deleted
Copy
Copied
{
  "id": "String"
}
price-list.created
Copy
Copied
{
  "id": "String",
  "name": "Map",
  "currency": "String",
  "countries": ["String"],
  "regions": ["String"],
  "customerGroups": ["String"],
  "siteCode": "String",
  "validity": {
    "from": "String",
    "to": "String"
  },
  "mixins": "Map",
  "metadata": {
    "createdAt": "String",
    "updatedAt": "String",
    "version": "Number",
    "mixins": "Map"
  }
}
price-list.updated
Copy
Copied
{
  "id": "String",
  "name": "Map",
  "currency": "String",
  "countries": ["String"],
  "regions": ["String"],
  "customerGroups": ["String"],
  "siteCode": "String",
  "validity": {
    "from": "String",
    "to": "String"
  },
  "mixins": "Map",
  "metadata": {
    "createdAt": "String",
    "updatedAt": "String",
    "version": "Number",
    "mixins": "Map"
  }
}
price-list.deleted
Copy
Copied
{
  "id": "String"
}
price-list-price.created
Copy
Copied
{
  "id": "String",
  "itemId": {
    "itemType": "String",
    "id": "String"
  },
  "priceListId": "String",
  "priceModelId": "String",
  "tierValues": [
    {
      "id": "String",
      "priceValue": "String"
    }
  ],
  "metadata": {
    "createdAt": "String",
    "updatedAt": "String",
    "version": "Number"
  }
}
price-list-price.updated
Copy
Copied
{
  "id": "String",
  "itemId": {
    "itemType": "String",
    "id": "String"
  },
  "priceListId": "String",
  "priceModelId": "String",
  "tierValues": [
    {
      "id": "String",
      "priceValue": "String"
    }
  ],
  "metadata": {
    "createdAt": "String",
    "updatedAt": "String",
    "version": "Number"
  }
}
price-list-price.deleted
Copy
Copied
{
  "id": "String"
}