POST v1/Webhook/SampleWebhook

This is for documentation purposes.

Request Information

URI Parameters

None.

Body Parameters

The webhook object for documentation.

Webhook

Name Description Type
OrganisationID

The internal identifier of this organisation in Tradevine e.g. 3451460443781171981

 integer
AccessToken

The token corresponding to the TV account this webhook concerns

 string
EventType

The type of event this webhook was generated from

 integer
EventObjectId

The object identifier of this webhook. It currently can be either ProductID or SalesOrderID.

 integer
EventDateUtc

The type of event this webhook was generated from

 date
Product

The latest product data if this webhook was related to a product event

 Product
SalesOrder

The latest sales-order data if this webhook was related to a sales-order event

 SalesOrder

Request Formats

application/json

Sample: 

{
  "OrganisationID": 3479979772659009354,
  "AccessToken": "99366f6d-ee8e-463b-a4e6-64b66a855bf4",
  "EventType": 95001,
  "EventObjectId": null,
  "EventDateUtc": "0001-01-01T00:00:00",
  "Product": {
    "ProductID": 3451582911247567682,
    "OrganisationID": 3479979772659009354,
    "Code": "MSP-152",
    "Name": "Baking Powder 1kg",
    "Description": "Baking Powder 1kg - for all your cooking needs. Widely usable in all baking recipes",
    "AlternateCode": "EDMNDS4535",
    "EnableInventory": true,
    "IsBoM": false,
    "IsBoMComponent": false,
    "UnitOfMeasure": "Each",
    "Barcode": "68568957899",
    "InternalNotes": "Private note so say this powder leads to dense cakes that often result in indigestion",
    "ExternalNotes": "Public note so say this powder is sure to leave your sponge nice and fluffy",
    "ProductCategoryID": 3479979772660940830,
    "Weight": 1000.0,
    "Length": 140.0,
    "Width": 80.0,
    "Height": 60.0,
    "Currency": 10109,
    "TaxClassID": 3479979772669744181,
    "IsArchived": false,
    "TaxCode": "GST",
    "QuantityAvailableToSell": 78.0,
    "QuantityAvailableForShipmentAllocation": null,
    "QuantityAvailableToShip": 90.0,
    "CostPrice": 90.0,
    "TradeMeListings": null,
    "TradeMeOffers": null,
    "SoftAllocated": null,
    "MediumAllocated": null,
    "HardAllocated": null,
    "SoftPurchase": null,
    "HardPurchase": null,
    "BoMSoftAllocated": null,
    "BoMTradeMeListings": null,
    "BoMTradeMeOffers": null,
    "SellPriceIncTax": 114.89,
    "SellPriceExTax": 99.9,
    "MinimumStockQuantity": 10.0,
    "OverrideSalesGLAccountCode": null,
    "OverrideSalesGLAccountName": null,
    "OverridePurchaseGLAccountCode": null,
    "OverridePurchaseGLAccountName": null,
    "PhotoIdentifier": null,
    "IsManualOrderApprovalNeeded": false,
    "CreatedDate": "2012-08-07T11:42:52Z",
    "CreatedBy": 3479979772662022396,
    "ModifiedDate": "2013-03-02T00:04:52Z",
    "ModifiedBy": 3479979772662022396,
    "IsBoMWeightAutocalculated": null,
    "Brand": null,
    "ManufacturerCode": null,
    "Photos": [
      {
        "PhotoID": null,
        "OrganisationID": null,
        "FileName": null,
        "ContentsBase64": null,
        "TradevineUrl": "https://nz.tradevine.com/my-account-name/ProductPhoto/GetPhoto?photoID=3602768739505780893",
        "PublicUrl": "https://nz.tradevine.com/BlobStorage/GetFullPhoto?photoID=3602768739505780893&organisationID=3479979772659009354",
        "PublicThumbnailUrl": "https://nz.tradevine.com/BlobStorage/GetPhotoThumbnail?photoID=3602768739505780893&organisationID=3479979772659009354&size=100",
        "CreatedDate": null,
        "CreatedBy": null,
        "ModifiedDate": null,
        "ModifiedBy": null
      }
    ],
    "PerWarehouseInventory": [
      {
        "QuantityInStockSnapshot": 312.0,
        "AverageFIFOCost": 85.0,
        "TotalInventoryValueSnapshot": null,
        "WarehouseID": 3479979772662022613,
        "WarehouseCode": "WH1",
        "ProductID": null,
        "Code": null,
        "Name": null,
        "QuantityAvailableToSell": null,
        "QuantityAvailableForShipmentAllocation": null,
        "QuantityAvailableToShip": null,
        "QuantityReorderBalance": null,
        "TradeMeListings": null,
        "TradeMeOffers": null,
        "SoftAllocated": null,
        "MediumAllocated": null,
        "HardAllocated": null,
        "SoftPurchase": null,
        "HardPurchase": null,
        "BoMSoftAllocated": null,
        "BoMTradeMeListings": null,
        "BoMTradeMeOffers": null
      }
    ],
    "ProductSuppliers": [
      {
        "ProductSupplierID": 33546957475474,
        "SupplierID": 3487940363376548,
        "SupplierCode": "SU-231",
        "SupplierName": "ACME Enterpises Ltd",
        "SupplierProductCode": "ACME-79867-233",
        "Price": 90.0,
        "IsPriceIncTax": false,
        "IsPreferredSupplier": true,
        "DefaultPurchaseOrderQuantity": 100.0,
        "CreatedDate": "2012-08-07T11:42:52Z",
        "CreatedBy": 3479979772662022396,
        "ModifiedDate": "2013-03-02T00:04:52Z",
        "ModifiedBy": 3479979772662022396
      }
    ],
    "BoMComponents": null,
    "QuantityInStock": 100.0,
    "QuantityReorderBalance": null,
    "Labels": null
  },
  "SalesOrder": null
}

Response Information

Resource Description

HttpStatusCode

Response Formats

application/json

Sample: 

100