Package Webhook

Webhook event types that can be sent for the package:

• package.created

• package.status.transitioned

• package.status.packed

• package.status.cancelled

• package.status.shipped

• package.shipment.awb_number

For each event, data is sent in the following scheme. The part that changes is the package status.

Example of a “package created” event data​

{
  "event": {
    "type": "package.created",
    "uuid": "c9591f0d1c1d4da58ade880921bd7e93"
  },
  "payload": {
    "id": 73,
    "city": "İstanbul",
    "state": {
      "id": 50,
      "name": "Contains out of stock products",
      "config": {},
      "enum_class": "PackageStatus",
      "enum_value": "920",
      "content_type": 26,
      "created_date": "2020-04-27T14:47:49.786741Z",
      "modified_date": "2020-04-27T14:47:49.786759Z"
    },
    "number": "000000000",
    "commands": [],
    "order_id": 73,
    "shipment": null,
    "remote_id": null,
    "date_placed": "2020-05-12T14:11:10.580441Z",
    "order_notes": null,
    "channel_name": "Shop",
    "order_number": "00000000000",
    "payment_type": "credit_card",
    "shipment_date": null,
    "delivery_range": null,
    "invoice_number": null,
    "shipping_label": null,
    "stock_location": {
      "id": 8,
      "conf": {},
      "name": "Example shop location",
      "email": "",
      "engine": 1,
      "address": {
        "id": 8,
        "city": {
          "pk": 40,
          "name": "ISTANBUL",
          "country": 1,
          "latitude": null,
          "is_active": true,
          "longitude": null
        },
        "line": "Example address",
        "notes": null,
        "title": "Example Location",
        "country": {
          "pk": 1,
          "code": "tr",
          "name": "Türkiye",
          "latitude": null,
          "is_active": true,
          "longitude": null
        },
        "mapping": null,
        "district": null,
        "latitude": "41.07019600",
        "postcode": null,
        "township": {
          "pk": 468,
          "city": 40,
          "name": "EYUPSULTAN",
          "latitude": null,
          "is_active": true,
          "longitude": null
        },
        "is_active": true,
        "longitude": "28.91708900"
      },
      "erp_code": "369",
      "priority": 10,
      "is_active": true,
      "fax_number": "",
      "created_date": "2020-05-12T14:20:07.677690Z",
      "daytime_phone": "0 212 777 97 21",
      "evening_phone": "0 212 777 97 21",
      "modified_date": "2020-05-12T14:30:36.315525Z",
      "is_pickup_location": false,
      "is_return_available": true,
      "stock_location_type": "store",
      "is_delivery_location": false,
      "is_fulfillment_center": true,
      "target_packing_interval": "5 00:00:00",
      "target_transfer_interval": "3 00:00:00"
    },
    "packageitem_set": [
      {
        "id": 152,
        "state": {
          "id": 60,
          "name": "Out of Stock",
          "config": {},
          "enum_class": "PackageItemStatus",
          "enum_value": "520",
          "content_type": 27,
          "created_date": "2020-04-27T14:47:49.905768Z",
          "modified_date": "2020-04-27T14:47:49.905786Z"
        },
        "package": 73,
        "commands": [],
        "order_item": {
          "id": 152,
          "image": null,
          "order": 73,
          "price": "489.00",
          "state": {
            "id": 23,
            "name": "Approved",
            "config": {},
            "enum_class": "OrderStatus",
            "enum_value": "400",
            "content_type": 21,
            "created_date": "2020-04-27T14:47:49.406417Z",
            "modified_date": "2020-04-27T14:47:49.406436Z"
          },
          "product": {
            "id": 48,
            "sku": "1006905",
            "name": "Example brand name",
            "barcode": null,
            "base_code": "52811",
            "attributes": {
            },
            "omnitron_id": 221603,
            "created_date": "2020-05-12T15:20:21.072491Z",
            "modified_date": "2020-05-12T15:20:21.072513Z",
            "extra_attributes": {},
            "productimage_set": [
              {
                "id": 185,
                "url": "https:/{url}/lorem.jpg",
                "order": 1,
                "product": 48
              },
              {
                "id": 186,
                "url": "https:/{url}/lorem.jpg",
                "order": 2,
                "product": 48
              },
              {
                "id": 187,
                "url": "https:/{url}/lorem.jpg",
                "order": 3,
                "product": 48
              },
              {
                "id": 188,
                "url": "https:/{url}/lorem.jpg",
                "order": 4,
                "product": 48
              },
              {
                "id": 189,
                "url": "https:/{url}/lorem.jpg",
                "order": 5,
                "product": 48
              }
            ],
            "attributes_kwargs": {
              "erp_line": {
                "label": "Other",
                "value": "999"
              }
            }
          },
          "commands": [],
          "tax_rate": "8.00",
          "attributes": {},
          "net_amount": "489.00",
          "price_list": {
            "pk": 1,
            "code": "shop_price_list",
            "name": "shop_price_list",
            "created_date": "2020-02-24T13:43:42.004315Z",
            "is_auto_sync": true,
            "modified_date": "2020-02-24T13:43:42.004345Z"
          },
          "stock_list": {
            "pk": 1,
            "code": "shop_stock_list",
            "name": "shop_stock_list",
            "created_date": "2020-02-24T13:44:03.073917Z",
            "is_auto_sync": true,
            "modified_date": "2020-02-24T13:44:03.073944Z"
          },
          "tax_amount": null,
          "omnitron_id": 1060,
          "created_date": "2020-05-12T15:20:21.128397Z",
          "retail_price": "489.00",
          "modified_date": "2020-05-12T15:20:21.128424Z",
          "price_currency": "try",
          "discount_amount": "0.00",
          "attributes_kwargs": {},
          "without_net_amount": null,
          "installment_interest_amount": null
        },
        "created_date": "2020-05-13T11:39:46.845590Z",
        "modified_date": "2020-05-13T11:39:46.945551Z",
        "transfer_order": null,
        "selected_barcode": null
      },
      {
        "id": 151,
        "state": {
          "id": 60,
          "name": "Out of Stock",
          "config": {},
          "enum_class": "PackageItemStatus",
          "enum_value": "520",
          "content_type": 27,
          "created_date": "2020-04-27T14:47:49.905768Z",
          "modified_date": "2020-04-27T14:47:49.905786Z"
        },
        "package": 73,
        "commands": [],
        "order_item": {
          "id": 151,
          "image": null,
          "order": 73,
          "price": "79.90",
          "state": {
            "id": 23,
            "name": "Approved",
            "config": {},
            "enum_class": "OrderStatus",
            "enum_value": "400",
            "content_type": 21,
            "created_date": "2020-04-27T14:47:49.406417Z",
            "modified_date": "2020-04-27T14:47:49.406436Z"
          },
          "product": {
            "id": 47,
            "sku": "1157696",
            "name": "Example product name",
            "barcode": null,
            "base_code": "TKE12-",
            "attributes": {
            },
            "omnitron_id": 196239,
            "created_date": "2020-05-12T15:20:21.031882Z",
            "modified_date": "2020-05-12T15:20:21.031907Z",
            "extra_attributes": {},
            "productimage_set": [
              {
                "id": 183,
                "url": "https:/{url}/lorem.jpg",
                "order": 1,
                "product": 47
              },
              {
                "id": 184,
                "url": "https:/{url}/lorem.jpg",
                "order": 3,
                "product": 47
              }
            ],
            "attributes_kwargs": {
              "erp_line": {
                "label": "Sports",
                "value": "1"
              }
            }
          },
          "commands": [],
          "tax_rate": "8.00",
          "attributes": {},
          "net_amount": "79.90",
          "price_list": {
            "pk": 1,
            "code": "shop_price_list",
            "name": "shop_price_list",
            "created_date": "2020-02-24T13:43:42.004315Z",
            "is_auto_sync": true,
            "modified_date": "2020-02-24T13:43:42.004345Z"
          },
          "stock_list": {
            "pk": 1,
            "code": "shop_stock_list",
            "name": "shop_stock_list",
            "created_date": "2020-02-24T13:44:03.073917Z",
            "is_auto_sync": true,
            "modified_date": "2020-02-24T13:44:03.073944Z"
          },
          "tax_amount": null,
          "omnitron_id": 1059,
          "created_date": "2020-05-12T15:20:21.061545Z",
          "retail_price": "79.90",
          "modified_date": "2020-05-12T15:20:21.061568Z",
          "price_currency": "try",
          "discount_amount": "0.00",
          "attributes_kwargs": {},
          "without_net_amount": null,
          "installment_interest_amount": null
        },
        "created_date": "2020-05-13T11:39:46.839098Z",
        "modified_date": "2020-05-13T11:39:46.952188Z",
        "transfer_order": null,
        "selected_barcode": null
      }
    ],
    "tracking_number": null,
    "shipping_address": {
      "id": 17,
      "city": {
        "pk": 1,
        "name": "ADANA",
        "country": 1,
        "latitude": null,
        "is_active": true,
        "longitude": null
      },
      "line": "Teknopark Bölgesi, YTÜ-Davutpaşa Kampüsü, B2 Blok D:Kat:2, No: 417, 34220 Esenler/İstanbul",
      "email": "[e-mail]",
      "notes": null,
      "title": "iş",
      "tax_no": "",
      "country": {
        "pk": 1,
        "code": "tr",
        "name": "Turkiye",
        "latitude": null,
        "is_active": true,
        "longitude": null
      },
      "mapping": null,
      "customer": {
        "pk": 8,
        "email": "[e-mail]",
        "channel": 2,
        "erp_code": null,
        "last_name": "lorem",
        "first_name": "Bar",
        "phone_number": "05000000000"
      },
      "district": {
        "pk": 828,
        "city": 1,
        "name": "AKOREN STREET",
        "latitude": null,
        "township": 15,
        "is_active": true,
        "longitude": null
      },
      "postcode": "56665",
      "township": {
        "pk": 15,
        "city": 1,
        "name": "ALADAG",
        "latitude": null,
        "is_active": true,
        "longitude": null
      },
      "is_active": true,
      "last_name": "lorem",
      "first_name": "bar",
      "tax_office": "",
      "omnitron_id": 123,
      "address_type": "customer",
      "company_name": "",
      "created_date": "2020-05-12T15:14:51.321819Z",
      "phone_number": "05000000000",
      "modified_date": "2020-05-12T15:20:21.015169Z",
      "e_bill_taxpayer": false
    },
    "order_gift_box_note": null,
    "target_packing_date": "2020-05-17T14:11:10.580441Z",
    "is_click_and_collect": false,
    "order_retail_store_id": null
  }
}