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.

This API trigger will be scheduled at a certain frequency by Increff OMS system at the following events:

• SUBORDER_CREATE
• SUBORDER_PARTIAL_CANCEL
• SUBORDER_CANCEL
• SUBORDER_COMPLETE
• SUBORDER_PROPERTIES_UPDATE
• PACKED
• SUBORDER_DELIVER

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

<aside> 🗒️ Note:

• subOrderItems Object is no longer part of the API Request Body.
• New Field Additions are highlighted in the Field Description table below </aside>

Request Body

{
  "locationCode": "LOC-001",
  "orderCode": "ORD-2024-001",
  "parentOrderCode": "PARENT-ORD-2024-001",
  "partnerCode": "PARTNER-001",
  "partnerLocationCode": "PARTNER-LOC-001",
  "orderType": "REGULAR",
  "packType": "STANDARD",
  "fulfillmentType": "FULLFILLMENT",
  "deliveryType": "STANDARD_DELIVERY",
  "channelName": "USP-Channel",
  "orderTime": "2024-01-15T10:30:00Z",
  "startProcessingTime": "2024-01-15T11:00:00Z",
  "requiredBy": "2024-01-16T18:00:00Z",
  "messageId": 123456789,
  "paymentMethod": "PREPAID",
  "isPriority": true,
  "onHold": false,
  "eventType": "SUBORDER_CREATE",
  "shippingAddress": {
    "name": "John Doe",
    "line1": "123 Main Street",
    "line2": "Apt 4B",
    "line3": "Near Central Park",
    "phone": "+1-555-123-4567",
    "email": "[email protected]",
    "city": "New York",
    "state": "NY",
    "zip": "10001",
    "country": "USA",
    "longitude": null,
    "latitude": null,
    "openLocationCode": null
  },
  "billingAddress": {
    "name": "John Doe",
    "line1": "123 Main Street",
    "line2": "Apt 4B",
    "line3": "Near Central Park",
    "phone": "+1-555-123-4567",
    "email": "[email protected]",
    "city": "New York",
    "state": "NY",
    "zip": "10001",
    "country": "USA",
    "longitude": null,
    "latitude": null,
    "openLocationCode": null
  },
  "packedAt": "2024-01-15T14:30:00Z",
  "orderItems": [
    {
      "clientSkuId": "CLIENT-SKU-001",
      "channelSkuCode": "CHANNEL-SKU-001",
      "orderedQuantity": 5,
      "cancelledQuantity": 0,
      "customerCancelledQty": 0,
      "sellerCancelledQty": 0,
      "sellerRejectQty": 0,
      "channelDiscount": 10,
      "sellingPricePerUnit": 100,
      "giftChargePerUnit": 5,
      "giftMessage": null,
      "giftDocument": null,
      "sellerDiscount": 5,
      "shippingCharge": 25,
      "isBundled": false,
      "isVirtual": false,
      "orderItemCustomAttributes": {
        "color": "Red",
        "size": "Large",
        "material": "Cotton"
      },
      "minExpiry": "2025-12-31T23:59:59Z",
      "fulfillmentItemDetails": [
        {
          "channelSkuCode": "CHANNEL-SKU-001",
          "batchCode": "BATCH-001",
          "quantity": 3,
          "supplierCode": "SUPPLIER-001",
          "manufacturingDate": "2024-01-01T00:00:00Z",
          "expiryDate": "2025-12-31T23:59:59Z",
          "mrp": 299.99,
          "batchId": 657
        }
      ]
    }
  ],
  "virtualSkuDefinitions": [
    {
      "virtualParentChannelSkuId": "VIRTUAL-PARENT-001",
      "childSkus": [
        {
          "channelSkuCode": "CHILD-SKU-001",
          "qty": 2,
          "barcode": "1234567890123",
          "clientSkuCode": "CLIENT-CHILD-001"
        }
      ],
      "virtualParentBarcode": "9876543210987",
      "virtualParentClientSkuCode": "VIRTUAL-CLIENT-001"
    }
  ],
  "orderCustomAttributes": {
    "orderSource": "Mobile App",
    "customerSegment": "Premium",
    "promotionCode": "SAVE20"
  },
  "bundledSkuDefinitions": [
    {
      "childSkus": [
        {
          "channelSkuCode": "BUNDLE-CHILD-001",
          "qty": 1,
          "barcode": "1111111111111",
          "clientSkuCode": "BUNDLE-CLIENT-001"
        }
      ],
      "bundledParentBarcode": "3333333333333",
      "bundledParentClientSkuCode": "BUNDLE-PARENT-CLIENT",
      "bundledParentChannelSkuId": "BUNDLE-PARENT-CHANNEL"
    }
  ],
  "shipments": [
    {
      "channelShipmentCode": "CH-SHIP-001",
      "omsShipmentCode": "OMS-SHIP-001",
      "efsShipmentCode": "EFS-SHIP-001",
      "locationCode": "LOC-001",
      "omsInvoiceId": "OMS-INV-001",
      "omsInvoiceDate": "2024-01-15T12:00:00Z",
      "channelInvoiceId": "CH-INV-001",
      "channelInvoiceDate": "2024-01-15T12:30:00Z",
      "invoiceDocumentUrl": "<https://example.com/invoices/CH-INV-001.pdf>",
      "shippingLabelDocumentUrl": "<https://example.com/labels/shipping-label-001.pdf>",
      "irn": "IRN-123456789",
      "qrCode": "QR-CODE-123456789",
      "shipmentStatus": "SHIPPED",
      "awbNumber": "AWB123456789",
      "transporter": "BlueDart",
      "packageSku": "PKG-SKU-001",
      "deliveredAt": "2024-01-16T15:30:00Z",
      "packedAt": "2024-01-15T14:30:00Z",
      "shipmentItems": [
        {
          "channelSkuCode": "CHANNEL-SKU-001",
          "orderItemCode": "ORDER-ITEM-001",
          "netTaxAmountPerUnit": 18,
          "netTaxAmountTotal": 90,
          "baseSellingPricePerUnit": 100,
          "baseSellingPriceTotal": 500,
          "sellingPricePerUnit": 90,
          "sellingPriceTotal": 450,
          "quantity": 5,
          "shippingChargePerUnit": 5,
          "channelDiscount": 10,
          "taxItems": [
            {
              "type": "GST",
              "rate": 18,
              "taxPerUnit": 16.2,
              "taxTotal": 81
            }
          ],
          "barcode": "1234567890123",
          "clientSkuCode": "CLIENT-SKU-001"
        }
      ],
      "shipmentDetails": {
        "length": 30.5,
        "breadth": 20,
        "height": 15,
        "weight": 2.5,
        "shipmentId": 12345,
        "totalItemQuantity": 5,
        "packboxDetailsList": [
          {
            "length": 30.5,
            "breadth": 20,
            "height": 15,
            "weight": 2.5,
            "boxId": 67890,
            "awbNumber": "AWB123456789",
            "packBoxRemarks": "Handle with care",
            "volWeight": "2.8",
            "boxSkuCode": "BOX-SKU-001",
            "boxCode": "BOX-001",
            "skuQuantityDataList": [
              {
                "channelSkuCode": 1001,
                "clientSkuId": "CLIENT-SKU-001",
                "count": 5
              }
            ]
          }
        ]
      }
    }
  ]
}

Response Body