Transfer Webhook

Information can be provided with the OMS Transfer Order types below:

  • transfer.status.transitioned

  • transfer.status.created

  • transfer.status.in_transit

  • transfer.status.transferred

  • transfer.status.cancelled

  • transfer.status.ready_to_shipment

Events are triggered when a transfer order is created, updated or canceled.

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

Example of “transfer order created” event data entry​

{
  "event": {
    "type": "transfer.status.created",
    "uuid": "19d8078370584c87b91ff8ce2847bcc8"
  },
  "payload": {
    "id": 1,
    "order": 2,
    "state": {
      "id": 63,
      "name": "Waiting for transfer",
      "config": {},
      "enum_class": "TransferStatus",
      "enum_value": "waiting",
      "content_type": 27,
      "created_date": "2019-08-26T12:11:01.604515Z",
      "modified_date": "2019-10-24T19:41:45.073050Z"
    },
    "number": "R4384418660812P1T1",
    "source": {
      "id": 262,
      "conf": {},
      "name": "Warehouse",
      "email": "[email protected]",
      "engine": 1,
      "address": {
        "id": 1,
        "city": {
          "pk": 1,
          "name": "City_MfOLcg",
          "country": 1,
          "is_active": true,
          "longitude": "25.43060960",
          "latitude": "40.02184870"
        },
        "country": {
          "pk": 1,
          "name": "Country_zoVabc",
          "code": "bqo",
          "is_active": true,
          "longitude": "40.30578930",
          "latitude": "40.27676590"
        },
        "township": {
          "pk": 1,
          "name": "Township_ymtuCT",
          "city": 1,
          "is_active": true,
          "longitude": "33.66398410",
          "latitude": "36.95247500"
        },
        "district": {
          "pk": 1,
          "name": "District_fkLcoN",
          "city": 1,
          "township": 1,
          "is_active": true,
          "longitude": "42.19727910",
          "latitude": "36.13805450"
        },
        "mapping": null,
        "title": "Title_acBwEaIAWm",
        "is_active": true,
        "line": "Line lorem ipsum dolor sit amet.",
        "postcode": "023375",
        "notes": "Note lorem ipsum dolor sit amet.",
        "longitude": "33.64598750",
        "latitude": "39.08743550"
      },
      "category": null,
      "erp_code": "ERP_CODE_sjyrb",
      "priority": 10,
      "is_active": true,
      "fax_number": "+905XXX55555",
      "omnitron_id": null,
      "created_date": "2019-09-27T11:22:07.320237Z",
      "daytime_phone": "+905XXX55555",
      "evening_phone": "+905XXX55555",
      "modified_date": "2021-03-25T19:07:20.815539Z",
      "is_pickup_location": false,
      "is_return_available": false,
      "stock_location_type": "warehouse",
      "is_delivery_location": true,
      "is_fulfillment_center": false,
      "target_packing_interval": "1 00:00:00",
      "use_as_shipper_location": false,
      "target_transfer_interval": "1 00:00:00",
      "is_fast_delivery_available": false
    },
    "package": 12,
    "commands": [
      {
        "id": 17,
        "label": "Missing / Defective Product",
        "command": "TRANSFER_OUT_OF_STOCK",
        "source_state": 63,
        "ui_visibility": [
          "oms_web",
          "instore",
          "third_party"
        ],
        "destination_state": 102,
        "is_packageitem_parameter_required": false
      },
      {
        "id": 85,
        "label": "Ready to ship transfer",
        "command": "READY_TO_SHIP_TRANSFER_ORDER",
        "source_state": 63,
        "ui_visibility": [
          "oms_web",
          "instore",
          "third_party"
        ],
        "destination_state": 94,
        "is_packageitem_parameter_required": false
      }
    ],
    "remote_id": null,
    "destination": {
      "id": 265,
      "conf": {},
      "name": "E SATIŞ",
      "email": "",
      "engine": 1,
      "address": {
        "id": 265,
        "city": {
          "pk": 2,
          "name": "City_hwhs",
          "country": 1,
          "latitude": "41.00823760",
          "is_active": true,
          "longitude": "28.97835890"
        },
        "line": "Line lorem ipsum dolor sit amet.",
        "notes": null,
        "title": "Title_dsjrba",
        "country": {
          "pk": 1,
          "code": "Code_jfns",
          "name": "Country_name_jdna",
          "latitude": "38.96374500",
          "is_active": true,
          "longitude": "35.24332200"
        },
        "mapping": null,
        "district": {
          "pk": 29638,
          "city": 2,
          "name": "District_kalms",
          "latitude": "41.05833380",
          "township": 396,
          "is_active": true,
          "longitude": "28.66589090"
        },
        "latitude": "41.06085810",
        "postcode": null,
        "township": {
          "pk": 396,
          "city": 2,
          "name": "township_lsng",
          "latitude": "41.03431770",
          "is_active": true,
          "longitude": "28.66148090"
        },
        "is_active": true,
        "longitude": "28.65714710"
      },
      "category": null,
      "erp_code": "erp_code_ksh",
      "priority": 10,
      "is_active": true,
      "fax_number": "02164540900",
      "omnitron_id": null,
      "created_date": "2019-10-07T11:31:14.911437Z",
      "daytime_phone": "02164540900",
      "evening_phone": "02164540900",
      "modified_date": "2021-02-26T09:22:50.143050Z",
      "is_pickup_location": false,
      "is_return_available": false,
      "stock_location_type": "warehouse",
      "is_delivery_location": false,
      "is_fulfillment_center": true,
      "target_packing_interval": "1 00:00:00",
      "use_as_shipper_location": false,
      "target_transfer_interval": "1 00:00:00",
      "is_fast_delivery_available": false
    },
    "order_number": "R4384418660812",
    "invoice_number": null,
    "package_number": "R4384418660812P1",
    "transferitem_set": [
      {
        "id": 88947,
        "name": "Transfer Item",
        "state": {
          "id": 68,
          "name": "Waiting for transfer",
          "config": {},
          "enum_class": "TransferStatus",
          "enum_value": "waiting",
          "content_type": 28,
          "created_date": "2019-08-26T12:11:01.668950Z",
          "modified_date": "2019-10-31T07:07:46.873433Z"
        },
        "barcode": null,
        "product": {
          "id": 39347,
          "sku": "868238558866",
          "name": "product_name_sjrh",
          "barcode": null,
          "base_code": "base_code_cahs",
          "attributes": {
          },
          "omnitron_id": 1212,
          "created_date": "2020-11-11T22:16:44.426253Z",
          "modified_date": "2021-06-14T09:47:01.194822Z",
          "extra_attributes": {},
          "productimage_set": [
            {
              "id": 345,
              "url": "https://example.com/products/image.jpg",
              "order": 1,
              "product": 879
            }
          ],
          "attributes_kwargs": {
            "marka": {
              "label": "KIKLOP",
              "value": "KIKLOP",
              "data_type": "dropdown"
            }
          },
          "remote_modified_date": "2021-06-09T12:51:55.664825Z"
        },
        "commands": [],
        "quantity": "1.00",
        "unit_type": "quantity",
        "stock_code": null,
        "created_date": "2021-06-14T09:47:10.075573Z",
        "package_item": {
          "id": 471153,
          "state": {
            "id": 51,
            "name": "Waiting for transfer",
            "config": {},
            "enum_class": "PackageItemStatus",
            "enum_value": "150",
            "content_type": 26,
            "created_date": "2019-08-26T12:11:01.447292Z",
            "modified_date": "2019-09-18T12:27:27.530247Z"
          },
          "package": 369960,
          "commands": [],
          "order_item": {
            "id": 438036,
            "image": null,
            "order": 1212,
            "price": "250.00",
            "state": {
              "id": 22,
              "name": "Approved",
              "config": {},
              "enum_class": "OrderStatus",
              "enum_value": "400",
              "content_type": 20,
              "created_date": "2019-08-26T12:11:01.082213Z",
              "modified_date": "2019-08-26T12:11:01.082237Z"
            },
            "product": {
              "id": 1,
              "sku": "sku_123",
              "name": "name_ksh",
              "barcode": null,
              "base_code": "base_code_cahs",
              "attributes": {
                "marka": "brand",
                "yeni_sezon": "yeni_sezon",
                "editor_title": "editor_title"
              },
              "omnitron_id": 345,
              "created_date": "2020-11-11T22:16:44.426253Z",
              "modified_date": "2021-06-14T09:47:01.194822Z",
              "extra_attributes": {},
              "productimage_set": [
                {
                  "id": 345,
                  "url": "https://example.com/products/image.jpg",
                  "order": 1,
                  "product": 897
                }
              ],
              "attributes_kwargs": {
                "marka": {
                  "label": "label_sja",
                  "value": "label_sja",
                  "data_type": "dropdown"
                }
              },
              "remote_modified_date": "2021-06-09T12:51:55.664825Z"
            },
            "commands": [],
            "tax_rate": "18.00",
            "attributes": {
              "gift_note": ""
            },
            "net_amount": "250.00",
            "price_list": {
              "pk": 1,
              "code": "shop_price_list",
              "name": "shop_price_list",
              "created_date": "2019-06-11T13:07:28.548030Z",
              "is_auto_sync": true,
              "modified_date": "2019-06-11T13:07:28.548063Z"
            },
            "stock_list": {
              "pk": 2,
              "code": "stock_list",
              "name": "stock_list",
              "created_date": "2020-06-08T16:29:17.032806Z",
              "is_auto_sync": true,
              "modified_date": "2020-06-08T16:29:17.032827Z"
            },
            "tax_amount": null,
            "extra_field": {
              "price_extra_field": null,
              "stock_extra_field": null
            },
            "omnitron_id": 456,
            "created_date": "2021-06-14T09:47:01.221583Z",
            "retail_price": "250.00",
            "modified_date": "2021-06-14T09:47:01.221625Z",
            "price_currency": "try",
            "discount_amount": "0.00",
            "attributes_kwargs": {},
            "parent_omnitron_id": null,
            "without_net_amount": null,
            "installment_interest_amount": null
          },
          "unit_weight": null,
          "created_date": "2021-06-14T09:47:09.967342Z",
          "denial_reason": null,
          "modified_date": "2021-06-14T09:47:10.105828Z",
          "selected_barcode": null
        },
        "modified_date": "2021-06-14T09:47:10.075605Z",
        "transfer_order": 1
      }
    ],
    "order_date_placed": "2021-06-14T09:45:23.424189Z",
    "target_transfer_date": "2021-06-15T09:47:09.956360Z"
  }
}

Last updated

Was this helpful?