Sales Order Posting

Outbound | POST | {Client’s URL}

Description

This API will share the Outward Order data with the ERP system with the details of sales orders which are completed in Increff Omni.

The API calls will be sent at a certain frequency from Increff system to the ERP system.

ERP system is advised to implement idempotency on messageId and shipmentCode fields.

• One order can have multiple shipments. Once a shipment is invoiced, it will appear in all subsequent posting
• Hence it should be ensured to capture the unique shipmentCode for idempotency at shipment level.

Postings can be triggered on below event types:

• OUTWARD_ORDER_CREATE: Triggered when a outward order is created in system
• OUTWARD_ORDER_CANCEL: Triggered when a outward order is cancelled in system
• OUTWARD_ORDER_PARTIAL_CANCEL: Triggered when a outward order is partially cancelled in system
• OUTWARD_ORDER_COMPLETE: Triggered when a outward order is completed in system
• OUTWARD_ORDER_SHIPMENT_INVOICED: Triggered when a outward order is invoiced in system
• OUTWARD_ORDER_SHIPMENT_DISPATCH: Triggered when a outward order is handed over in system
• OUTWARD_ORDER_SHIPMENT_DELIVER: Triggered when a outward order is delivered to customer

Request Body

{
      "partnerCode": "1100013090",
      "partnerLocationCode": "9",
      "locationCode": "IN132",
      "orderCode": "order1",
      "parentOrderCode": "flipkart1221",
      "isPriority": false,
      "channelName": "channel",
      "orderTime": "2020-10-16T20:22:28.000+00:00",
      "orderType": "SO/STO/RTV",
      "messageId": 1100,
      "paymentMethod": "COD",
      "eventType": "OUTWARD_ORDER_COMPLETE",
      "eventTime": "2020-10-16T20:22:28.000+00:00",
      "omsOrderId": 1234,
      "turnAroundTime": "2020-10-16T20:22:28.000+00:00",
      "virtualSkuDefinitions": [
        {
          "virtualParentChannelSkuId": "abc1",
          "virtualParentBarcode": "bar1",
          "virtualParentClientSkuCode": "abc",
          "childSkus": [
            {
              "channelSkuCode": "xyz",
              "qty": 2,
              "barcode": "bar23",
              "clientSkuCode": "clientSku123"
            },
            {
              "channelSkuCode": "xyz1",
              "qty": 1,
              "barcode": "bar34",
              "clientSkuCode": "clientSku234"
            }
          ]
        }
      ],
      "bundledSkuDefinitions": [
        {
          "bundledParentBarcode": "string",
          "bundledParentChannelSkuId": "string",
          "bundledParentClientSkuCode": "string",
           "mrp": 1999,
          "childSkus": [
            {
              "barcode": "string",
              "channelSkuCode": "string",
              "qty": 0,
              "clientSkuCode": "string"
            }
          ]
        }
      ],
      "isSplitRequired": "false",
      "shippingCharges": 20,
      "channelType": "ERP",
      "orderItems": [
        {
          "orderItemCode": "item123",
          "channelSkuCode": "1000889888",
          "orderedQuantity": 2,
          "cancelledQuantity": 1,
          "customerCancelledQty": 0,
          "sellerCancelledQty": 0,
          "sellerRejectQty": 0,
          "channelDiscount": 50,
          "sellingPricePerUnit": 500,
          "giftChargePerUnit": 10,
          "sellerDiscount": 5,
          "shippingCharge": 0,
          "omsItemId": 123,
          "barcode": "barcode1",
          "clientSkuCode": "clientSku1",
          "orderItemCustomAttributes": {
            "attribute1": "Value1",
            "attribute2": "Value2",
            "attribute3": "Value3",
            "attribute4": "Value4",
            "attribute5": "Value5",
            "attribute6": "Value6",
            "attribute7": "Value7",
            "attribute8": "Value8",
            "attribute9": "Value9",
            "channelMetadata": {
              "totalCashOnDeliveryFee": 0,
              "department": "HR",
              "paymentMethod": "ccavenue",
              "status": "processing"
            },
            "attribute10": "Value10",
            "channelMetadataMap": {
              "key1": "value1",
              "key2": "value2"
            }
          }
        }
      ],
      "shipments": [
        {
          "shipmentCode": "UIfd897",
          "omsShipmentId": "121",
          "locationCode": "loc1",
          "generatedInvoiceId": "AR105044395",
          "generatedInvoiceDate": "2020-10-16T20:22:28.000+00:00",
          "externalInvoiceId": "FK56556GH45",
          "externalInvoiceDate": "2020-10-16T20:22:28.000+00:00",
          "invoiceDocumentUrl": "<https://mybrand.com/invoice123.pdf>",
          "shippingLabelDocumentUrl": "<https://mybrand.com/sldoc.pdf>",
          "irn": "a429746e55b844c9d2cb2a6f68997d1c2af29987cc834f3b52da45d1b0bc97c9",
          "qrCode": "eyJhbGciPiJSUzI1NiIsImtpZCI6IkI4RDYzRUNCMThFQTVFNkY0QUKDM0Q1MjQ1NDNCMjI0NjY2OUIwRjgiLCJ0eXAiOiJKV1QiLCJ4NXQiOiJ1TlkteTFqcVhtOUtyRDFTUlVPeUpHWnBzUGcifQ.eyJkYXRhIjoie1wiU2VsbGVyR3N0aW5cIjpcIjI5QUFPQ001MzI2SjFaWVwiLFwiQnV5ZXJHc3RpblwiOlwiMjlBQUJDUjE3MThFMVpMXCIsXCJEb2NOb1wiOlwiTUVhajIyLTIzLzUwNTlcIixcIkRvY1R5cFwiOlwiSU5WXCIsXCJEb2NEdFwiOlwiMTMvMTAvMjAyMlwiLFwiVG90SW52VmFsXCI6MTgxNy4wNCxcIkl0ZW1DbnRcIjoxLFwiTWFpbkhzbkNvZGVcIjpcIjYyMTE0MjkwXCIsXCJJcm5cIjpcImE0Mjk3NDZlMzRkODQ0YzlkMmNiMmE2ZjY4OTk3ZDFjMmFmMjM5ODdjYzgzNGYzYjUyZGE0NWQxYjBiYzk3YzlcIixcIklybkR0XCI6XCIyMDIyLTEwLTEzIDEyOjAxOjAwXCJ9IiwiaXNzIjoiTklDIn0.wvB7b15AnpdQdX_d0VZEyj9dL1qWDaOFPLRPrlV0V2XIu3cE3aQ3YtsWLnTnyrmtUlokpbkkE4folBQNhfzkCPlnODNxRPfpO-Kz9eyNpqcIEp-8TqvcDKXZ3PrBRqmNmner00AG_fVmmqT1HLiyKB2sqOnhqtCfQaQF-PGnqIOhal3PDxIMVt0WAtaQOIwwDA75dsjjnFHaZFPl9tFPR8A6Wrw4NhQH-7xhABKW3Z961a_rGmO6M3XP7jPHyYPW-QWMfTqwNXwxNdFgFePL5FloPiUipt2-g4FIplgm-YcN1xMvEQ2irAfzQwbnxi7UKz-jwOgM0Zy2BbburYgDvQ",
          "shipmentStatus": "DELIVERED",
          "awbNumber": "118208310191",
          "transporter": "BLUEDART",
          "packageSku": "P-123",
          "deliveredAt": "2020-10-16T20:22:28.000+00:00",
          "packedAt": "2020-10-16T20:22:28.000+00:00",
          "shipmentItems": [
            {
              "channelSkuCode": "100000789702",
              "orderItemCode": "item123",
              "netTaxAmountPerUnit": 60,
              "netTaxAmountTotal": 120,
              "baseSellingPricePerUnit": 500,
              "baseSellingPriceTotal": 1000,
              "sellingPricePerUnit": 560,
              "sellingPriceTotal": 1120,
              "quantity": 2,
              "shippingChargePerUnit": 36,
              "channelDiscount": 30,
              "taxItems": [
                {
                  "type": "SGST",
                  "rate": 6,
                  "taxPerUnit": 30,
                  "taxTotal": 60
                },
                {
                  "type": "CGST",
                  "rate": 6,
                  "taxPerUnit": 30,
                  "taxTotal": 60
                }
              ],
              "barcode": "barcode1",
              "clientSkuCode": "csku1"
            },
            {
              "channelSkuCode": "100000734701",
              "orderItemCode": "item124",
              "netTaxAmountPerUnit": 60,
              "netTaxAmountTotal": 120,
              "baseSellingPricePerUnit": 500,
              "baseSellingPriceTotal": 1000,
              "sellingPricePerUnit": 560,
              "sellingPriceTotal": 1120,
              "quantity": 2,
              "shippingChargePerUnit": 36,
              "channelDiscount": 30,
              "taxItems": [
                {
                  "type": "SGST",
                  "rate": 6,
                  "taxPerUnit": 30,
                  "taxTotal": 60
                },
                {
                  "type": "CGST",
                  "rate": 6,
                  "taxPerUnit": 30,
                  "taxTotal": 60
                }
              ],
              "barcode": "barcode2",
              "clientSkuCode": "csku2"
            }
          ],
      "shipmentDetails": {
        "length": 30,
        "breadth": 20,
        "height": 10,
        "weight": 5,
        "shipmentId": 12345,
        "totalItemQuantity": 50,
        "packboxDetailsList": [
          {
            "length": 15,
            "breadth": 10,
            "height": 8,
            "weight": 2,
            "boxId": 1,
            "awbNumber": "AWB123",
            "packBoxRemarks": "Fragile items",
            "volWeight": "0.0",
            "boxSkuId": "boxSku1",
            "boxCode": "box1",
            "skuQuantityDataList": [
              {
                "globalSkuId": 987,
                "clientSkuId": "SKU001",
                "count": 10
              },
              {
                "globalSkuId": 876,
                "clientSkuId": "SKU002",
                "count": 15
              }
            ]
          }
        ]
      }
        }
      ],
      "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"
      },
      "orderCustomAttributes": {
        "attribute1": "Value1",
        "attribute2": "Value2",
        "attribute3": "Value3",
        "attribute4": "Value4",
        "attribute5": "Value5",
        "attribute6": "Value6",
        "attribute7": "Value7",
        "attribute8": "Value8",
        "attribute9": "Value9",
        "attribute10": "Value10",
        "channelMetadata": {
          "totalCashOnDeliveryFee": 0,
          "department": "HR",
          "paymentMethod": "ccavenue",
          "status": "processing"
        },
        "channelMetadataMap": {
          "key1": "value1",
          "key2": "value2"
        },
        "currency": "INR"
      }
    }