Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Outbound | POST  | {Client’s URL}

Summary

This API pushes the Sales Order level details to External fulfilment system

Description

This API will call the External Fulfillment System (EFS) and send the details of Sale Orders and Sale Order line items.

...

The above listed events can be enabled or disabled from Increff’s CIMS user interface with help of Increff support team

Request

Code Block
breakoutModewide
languagejson
{
    "locationCode": "IN132",
    "messageId": 12345,
    "orderCode": "flipkart1234",
    "parentOrderCode": "flipkart1221",
    "orderTime": "2020-10-16T20:22:28Z[UTC]",
    "startProcessingTime": "2020-10-16T20:22:28Z[UTC]",
    "requiredBy": "2020-10-16T20:22:28Z[UTC]",
    "paymentMethod": "COD",
    "isPriority": false,
    "channelName": "flipkart",
    "eventType": "SUBORDER_CREATE",
    "onHold": false,
  "orderCustomAttributes": {
    "attribute1": "test_4e10f67e0585",
    "attribute2": "test_df7f45161dbf",
    "attribute3": "test_511554245071",
    "attribute4": "test_285ab90a9a26",
    "attribute5": "test_c9902353bd62",
    "attribute6": "test_29bf877ad20e",
    "attribute7": "test_f05c5ee7bda0",
    "attribute9": "test_913b35f805f0",
    "attribute10": "test_e3af29b52cda",
    "channelMetadata": {
      "MetaDataTestExample1": "test_13669a9d0d24",
      "MetaDataTestExample2": "test_13669a9d0d25"
    },
    "currency": "test_ad35da54ae2f"
  },
    "orderItems": [{
        "orderItemCodes": [
        "14974593958185"
      ],
        "clientSkuId": "1000889888",
        "channelSkuCode": "1000889888",
        "orderedQuantity": 2,
        "cancelledQuantity": 1,
        "barcode": "51100L",
        "customerCancelledQty": null,
        "sellerCancelledQty": null,
        "sellerRejectQty": null,
        "channelDiscount": 50,
        "sellingPricePerUnit": 500,
        "giftChargePerUnit": 10,
        "hoppedQuantity": null,
        "sellerDiscount": 5,
        "shippingCharge": 0,
        "isVirtual": true,
        "externalItemCodes": [
        "A6D70B2DE36"],
        "orderItemCustomAttributes": {
        "attribute1": "test_9500ccd4855f",
        "attribute2": "test_957207fbdbb0",
        "attribute3": "test_e9c4494fc055",
        "attribute4": "test_2c6670838f48",
        "attribute5": "test_09156554f500",
        "attribute6": "test_20ab8d00c447",
        "attribute7": "test_f0c3e77287ae",
        "attribute9": "test_691c1f899bb8",
        "attribute10": "test_1e7511fe9fc8",
        "channelMetadata": {
          "MetaDataTestExample1": "test_13669a9d0d24",
          "MetaDataTestExample2": "test_13669a9d0d25"
        }
      }
    }],
    "subOrderItems": [{
        "orderItemCodes": [
        "14974593958185"
      ],
        "clientSkuId": "1000889888",
        "channelSkuCode": "1000889888",
        "orderedQuantity": 2,
        "cancelledQuantity": 1,
        "barcode": "51100L",
        "customerCancelledQty": null,
        "sellerCancelledQty": null,
        "sellerRejectQty": null,
        "channelDiscount": 50,
        "sellingPricePerUnit": 500,
        "giftChargePerUnit": 10,
        "hoppedQuantity": null,
        "sellerDiscount": 5,
        "shippingCharge": 0,
        "isVirtual": true,
        "externalItemCodes": [
        "A6D70B2DE36"],
        "orderItemCustomAttributes": {
        "attribute1": "test_9500ccd4855f",
        "attribute2": "test_957207fbdbb0",
        "attribute3": "test_e9c4494fc055",
        "attribute4": "test_2c6670838f48",
        "attribute5": "test_09156554f500",
        "attribute6": "test_20ab8d00c447",
        "attribute7": "test_f0c3e77287ae",
        "attribute9": "test_691c1f899bb8",
        "attribute10": "test_1e7511fe9fc8",
        "channelMetadata": {
          "MetaDataTestExample1": "test_13669a9d0d24",
          "MetaDataTestExample2": "test_13669a9d0d25"
        }
      }
    }],
    "shippingAddress": {
        "name": "Customer's Name",  
        "line1": "Line Address 1",
        "line2": "Line Address 2",
        "line3": "Line Address 3",
        "city": "city",
        "state": "state",
        "zip": "zip",
        "country": "country",
        "email": "abc@gmail.com",
        "phone": "9999999999"
    },
    "billingAddress": {
        "name": "customer",
        "line1": "address line 1",
        "line2": "address line 2",
        "line3": "address line 3",
        "city": "Bengaluru",
        "state": "Karnataka",
        "zip": "560076",
        "country": "INDIA",
        "email": "abc@gmail.com",
        "phone": "9999999999"
    },
    "virtualSkuDefinitions": [{
        "virtualParentChannelSkuId": "sku_34",
        "virtualParentBarcode": "bar_43",
        "childSkus": [{
            "channelSkuCode": "ch_sku_23",
            "barcode": "bar_32",
            "qty": 21
        }]
    }],
  "bundledSkuDefinitions": [
    {
      "childSkus": [
        {
          "barcode": "string",
          "channelSkuCode": "string",
          "qty": 0
        }
      ],
      "bundledParentBarcode": "string",
      "bundledParentChannelSkuId": "string"
    }
  ]
}

...