Products

Events

Action Event name
create a new product product.created
update an existing product product.updated

Payload example created

{
  "attemptId": "436b6372-f2ce-4c95-9669-82592fcd1e98",
  "created": 1623859265,
  "data": {
    "_id": "60ca203a10e7dd421be4a3bd",
    "accountId": "52a377ec430c7d4e220001fc",
    "availableChannels": {
      "inPerson": true,
      "online": false
    },
    "description": "",
    "icon": "fa-ship",
    "isBundle": false,
    "isFlexPass": false,
    "isParcel": false,
    "isPass": false,
    "lexiconKeys": {
      "description": "product-description-52a377ec430c7d4e220001fc-d2c86151-70a4-48ad-8a25-08bcbcc3120c",
      "name": "product-name-52a377ec430c7d4e220001fc-1afbceeb-8035-4e64-9aea-74c9764800df",
      "prodTypeName_paid in": "product-prodTypeName_paid in-52a377ec430c7d4e220001fc-f43702ea-1b24-4d05-ab14-6397cbc95d70",
      "terms": "product-terms-52a377ec430c7d4e220001fc-02050f2f-8ae1-4251-8d7d-88635113b1df"
    },
    "name": "ttt",
    "openReturn": false,
    "openReturnBundleId": "",
    "ord": 500,
    "products": [
      {
        "channels": {
          "backoffice": true,
          "websales": true
        },
        "expire": 0,
        "expireUnit": "days",
        "name": "Paid In",
        "priceAdjustment": {
          "times": 1,
          "type": "",
          "value": 0
        },
        "qty": {
          "max": 1,
          "min": 1
        },
        "returnDateDefault": false,
        "type": "paid in",
        "uses": 1
      }
    ],
    "readOnly": true,
    "taxProductFrom": "any",
    "terms": "",
    "type": "paid_in"
  },
  "event": "product.created",
  "id": "06b4e0c0-d125-4b16-b83e-21d023869d21",
  "livemode": true
}

Product payload updated

{
  "attemptId": "8ed3162d-573b-4713-95c3-dec92b843ec1",
  "created": 1623859316,
  "data": {
    "_id": "60ca203a10e7dd421be4a3bd",
    "accountId": "52a377ec430c7d4e220001fc",
    "availableChannels": {
      "inPerson": true,
      "online": false
    },
    "comments": "",
    "createdAt": {
      "offset": 0,
      "value": "2021-06-16T16:01:08.552Z"
    },
    "daysInAdvance": "",
    "deleted": false,
    "description": "",
    "dow": "",
    "family": null,
    "icon": "fa-ship",
    "isBundle": false,
    "isParcel": false,
    "lexiconKeys": {
      "description": "product-description-52a377ec430c7d4e220001fc-d2c86151-70a4-48ad-8a25-08bcbcc3120c",
      "name": "product-name-52a377ec430c7d4e220001fc-1afbceeb-8035-4e64-9aea-74c9764800df",
      "prodTypeName_paid in": "product-prodTypeName_paid in-52a377ec430c7d4e220001fc-f43702ea-1b24-4d05-ab14-6397cbc95d70",
      "terms": "product-terms-52a377ec430c7d4e220001fc-02050f2f-8ae1-4251-8d7d-88635113b1df"
    },
    "name": "ttt",
    "notifications": "",
    "openReturn": false,
    "openReturnBundleId": "",
    "ord": 500,
    "pricingType": "",
    "products": [
      {
        "channels": {
          "backoffice": true,
          "websales": true
        },
        "expire": 0,
        "expireUnit": "days",
        "name": "Paid In",
        "priceAdjustment": {
          "times": 1,
          "type": "",
          "value": 0
        },
        "qty": {
          "max": 1,
          "min": 1
        },
        "returnDateDefault": false,
        "type": "paid in",
        "uses": 1
      }
    ],
    "readOnly": true,
    "requiredInsurance": "",
    "serviceTypes": "",
    "shipTrackIntegration": "",
    "shipTrackIntegrationParams": "",
    "taxProductFrom": "any",
    "terms": "terms",
    "type": "paid_in",
    "updatedAt": {
      "offset": 0,
      "value": "2021-06-16T16:01:08.553Z"
    }
  },
  "event": "product.updated",
  "id": "04ffc07f-7c6c-49fe-8322-8ceeb5ac4c79",
  "livemode": true
}