Outbound | POST | {Client’s URL}

Summary

This API will call the POS system with sales order details after the order completion.

Description

• This API will call the POS system with the details of sales orders which are completed in Increff system.
• This API will be triggered at a certain frequency from Increff system.

Postings can be sent on below events

• SUBORDER_CREATE
• SUBORDER_CANCEL
• SUBORDER_COMPLETE
• SUBORDER_PARTIAL_CANCEL
• SUBORDER_PROPERTIES_UPDATE

Request

{
  "locationCode": "IN132",
  "messageId": 12345,
  "orderCode": "flipkart1234",
  "omsSubOrderId": 19011046,
  "parentOrderCode": "flipkart1221",
  "orderTime": "2020-10-16T20:22:28.000+00:00",
  "orderType": "SO/STO/RTV",
  "paymentMethod": "COD",
  "turnAroundTime": "2024-06-28T08:30:00.000+00:00",
  "shipments": [
    {
      "shipmentCode": "7982354179",
      "locationCode": "DLLJPT06",
      "shipmentStatus": "DISPATCHED",
      "generatedInvoiceId": "17531870",
      "generatedInvoiceDate": "2024-06-26T08:22:53.000+00:00",
      "omsShipmentId": null,
      "invoiceDocumentUrl": "<https://mybrand.com/invoice123.pdf>",
      "irn": null,
      "qrCode": null,
      "shippingLabelDocumentUrl": "<https://mybrand.com/sldoc.pdf>",
      "externalInvoiceId": "I0725ZP000000647",
      "externalInvoiceDate": "2024-06-26T08:22:41.000+00:00",
      "awbNumber": "awb1",
      "transporter": "Myntra Logistics",
      "packageSku": "packageSku1",
      "shipmentItems": [
        {
          "orderItemCode": "9982333122",
          "channelSkuCode": "35255XXL",
          "netTaxAmountPerUnit": 353.46,
          "netTaxAmountTotal": 353.46,
          "baseSellingPricePerUnit": 2945.54,
          "baseSellingPriceTotal": 2945.54,
          "sellingPricePerUnit": 3299,
          "sellingPriceTotal": 3299,
          "quantity": 1,
          "shippingChargePerUnit": 10.00,
          "taxItems": [
            {
              "type": "IGST",
              "rate": 12,
              "taxPerUnit": 353.46,
              "taxTotal": 353.46
            }
          ],
          "barcode": "35255XXL",
          "clientSkuCode": "ClientSku1"
        }
      ],
      "shipmentDetails": {
        "length": 30.0,
        "breadth": 20.0,
        "height": 10.0,
        "weight": 5.0,
        "shipmentId": 12345,
        "totalItemQuantity": 50,
        "packboxDetailsList": [
          {
            "length": 15.0,
            "breadth": 10.0,
            "height": 8.0,
            "weight": 2.0,
            "boxId": 1,
            "awbNumber": "AWB123",
            "packBoxRemarks": "Fragile items",
            "skuQuantityDataList": [
              {
                "globalSkuId": 987,
                "clientSkuId": "SKU001",
                "count": 10
              },
              {
                "globalSkuId": 876,
                "clientSkuId": "SKU002",
                "count": 15
              }
            ]
          }
        ]
      },
      "deliveredAt": null
    }
  ],
  "isPriority": false,
  "channelName": "flipkart",
  "channelType": "ERP/MARKETPLACE",
  "eventType": "SUBORDER_COMPLETE",
  "eventTime": "2020-10-16T20:22:28.000+00:00",
  "shippingCharges": 20,
  "orderCustomAttributes": {
        "attribute1": "test_4e10f67e0585",
        "attribute10": "test_e3af29b52cda",
        "attribute2": "test_df7f45161dbf",
        "attribute3": "test_511554245071",
        "attribute4": "test_285ab90a9a26",
        "attribute5": "test_c9902353bd62",
        "attribute6": "test_29bf877ad20e",
        "attribute7": "test_f05c5ee7bda0",
        "attribute9": "test_913b35f805f0",
        "channelMetadata": {
            "MetaDataTestExample1": "test_13669a9d0d24",
            "MetaDataTestExample2": "test_13669a9d0d25"
        },
        "currency": "test_ad35da54ae2f"
    },
  "virtualSkuDefinitions": [
    {
      "virtualParentChannelSkuId": "abc1",
      "virtualParentBarcode": "barcode1",
      "virtualParentClientSkuCode": "VPClientSku1",
      "childSkus": [
        {
          "channelSkuCode": "xyz",
          "qty": 2,
          "barcode": "bar1",
          "clientSkuCode": "ClientSku1"
        },
        {
          "channelSkuCode": "xyz1",
          "qty": 1,
          "barcode": "bar2",
          "clientSkuCode" : null
        }
      ]
    }
  ],
  "bundledSkuDefinitions": [
    {
       "bundledParentBarcode": "string",
       "bundledParentChannelSkuId": "string",
       "bundledParentClientSkuCode" : "BPClientSku1",
       "childSkus": [
           {
               "barcode": "string",
               "clientSkuCode": "ClientSku1",
               "channelSkuCode": "string",
               "qty": 0
           }
       ]
     }
  ],
  "orderItems": [
    {
      "orderItemCodes": [
        "item123"
      ],
      "channelSkuCode": "1000889888",
      "orderedQuantity": 2,
      "cancelledQuantity": 1,
      "customerCancelledQty": 0,
      "sellerCancelledQty": 0,
      "sellerRejectQty": 0,
      "fulfilledQuantity": 1,
      "hoppedQuantity": 0,
      "barcode": "35255XXL",
      "clientSkuCode": "ClientSku1",
      "channelDiscount": 50,
      "sellingPricePerUnit": 500,
      "giftChargePerUnit": 10,
      "sellerDiscount": 5,
      "shippingCharge": 0,
      "externalItemCodes": [
        "externalCode1"
      ],
      "orderItemCustomAttributes": {
                "attribute1": "test_9500ccd4855f",
                "attribute10": "test_1e7511fe9fc8",
                "attribute2": "test_957207fbdbb0",
                "attribute3": "test_e9c4494fc055",
                "attribute4": "test_2c6670838f48",
                "attribute5": "test_09156554f500",
                "attribute6": "test_20ab8d00c447",
                "attribute7": "test_f0c3e77287ae",
                "attribute9": "test_691c1f899bb8",
                "channelMetadata": {
                    "MetaDataTestExample1": "test_13669a9d0d24",
                    "MetaDataTestExample2": "test_13669a9d0d25"
                }
            }
    }
  ],
  "subOrderItems": [
    {
      "orderItemCodes": [
        "item123"
      ],
      "channelSkuCode": "1000889888",
      "orderedQuantity": 2,
      "cancelledQuantity": 1,
      "customerCancelledQty": 0,
      "sellerCancelledQty": 0,
      "sellerRejectQty": 0,
      "fulfilledQuantity": 1,
      "hoppedQuantity": 0,
      "barcode": "35255XXL",
      "clientSkuCode": "ClientSku1",
      "channelDiscount": 50,
      "sellingPricePerUnit": 500,
      "giftChargePerUnit": 10,
      "sellerDiscount": 5,
      "shippingCharge": 0,
      "externalItemCodes": [
        "externalCode1"
      ],
      "orderItemCustomAttributes": {
                "attribute1": "test_9500ccd4855f",
                "attribute10": "test_1e7511fe9fc8",
                "attribute2": "test_957207fbdbb0",
                "attribute3": "test_e9c4494fc055",
                "attribute4": "test_2c6670838f48",
                "attribute5": "test_09156554f500",
                "attribute6": "test_20ab8d00c447",
                "attribute7": "test_f0c3e77287ae",
                "attribute9": "test_691c1f899bb8",
                "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": "[email protected]",
    "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": "[email protected]",
    "phone": "9999999999"
  }
}

Note : subOrderItems has the same structure as orderItems

Response

{
    "hasError": false,
    "errorMessage":"message"
}