Push Outward Order Events API (Beta)

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

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

Note:

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

Request Body

{
    "billingAddress": {
        "city": "New York",
        "country": "USA",
        "email": "john.doe@example.com",
        "line1": "123 Main St",
        "line2": "Apt 4B",
        "line3": "",
        "name": "John Doe",
        "phone": "123-456-7890",
        "state": "NY",
        "zip": "10001"
    },
    "bundledSkuDefinitions": [
        {
            "bundledParentBarcode": "BUNDLE12345",
            "bundledParentChannelSkuId": "BCHSKU12345",
            "bundledParentClientSkuCode": "BCSKU123",
            "childSkus": [
                {
                    "barcode": "BAR67890",
                    "channelSkuCode": "CHSKU789",
                    "clientSkuCode": "CSKU678",
                    "qty": 3
                }
            ]
        }
    ],
    "channelName": "CHANNEL_XYZ",
    "eventType": "SUBORDER_CREATE",
    "isPriority": true,
    "locationCode": "LOC12345",
    "messageId": 123456789,
    "onHold": false,
    "orderCode": "ORD98765",
    "orderCustomAttributes": {
        "attribute1": "Value1",
        "attribute10": "Value10",
        "attribute2": "Value2",
        "attribute3": "Value3",
        "attribute4": "Value4",
        "attribute5": "Value5",
        "attribute6": "Value6",
        "attribute7": "Value7",
        "attribute8": "Value8",
        "attribute9": "Value9",
        "channelMetadata": 
        { 
        "MetaDataTest1": "test_13669a9d0d24",
        "MetaDataTest2": "test_13669a9d0d25"
               },
        "currency": "USD"
    },
    "orderItems": [
        {
            "cancelledQuantity": 2,
            "channelDiscount": 5,
            "channelSkuCode": "CHSKU987",
            "clientSkuId": "SKU123",
            "customerCancelledQty": 1,
            "giftChargePerUnit": 10,
            "isBundled": false,
            "isVirtual": false,
            "orderedQuantity": 10,
            "orderItemCustomAttributes": {
                "attribute1": "Value1",
                "attribute10": "Value10",
                "attribute2": "Value2",
                "attribute3": "Value3",
                "attribute4": "Value4",
                "attribute5": "Value5",
                "attribute6": "Value6",
                "attribute7": "Value7",
                "attribute8": "Value8",
                "attribute9": "Value9",
                "channelMetadata": {
                "MetaDataTest1": "test_13669a9d0d24",
                "MetaDataTest2": "test_13669a9d0d25"
                      }
            },
            "sellerCancelledQty": 1,
            "sellerDiscount": 15,
            "sellerRejectQty": 0,
            "sellingPricePerUnit": 100,
            "shippingCharge": 20
        }
    ],
    "orderTime": "2024-12-25T10:00:00Z",
    "parentOrderCode": "PARENT12345",
    "paymentMethod": "COD",
    "requiredBy": "2024-12-30T18:00:00Z",
    "shippingAddress": {
        "city": "New York",
        "country": "USA",
        "email": "john.doe@example.com",
        "line1": "123 Main St",
        "line2": "Apt 4B",
        "line3": "",
        "name": "John Doe",
        "phone": "123-456-7890",
        "state": "NY",
        "zip": "10001"
    },
    "startProcessingTime": "2024-12-25T10:30:00Z",
    "virtualSkuDefinitions": [
        {
            "childSkus": [
                {
                    "barcode": "BAR12345",
                    "channelSkuCode": "CHSKU987",
                    "clientSkuCode": "CSKU123",
                    "qty": 5
                }
            ],
            "virtualParentBarcode": "VIRTUAL12345",
            "virtualParentChannelSkuId": "VSKU12345",
            "virtualParentClientSkuCode": "VCSKU123"
        }
    ]
}

Parameter Name	Data Type	Description	Mandatory
`locationCode`	String	Identifier of the location from which the order is fulfilled	Yes
`messageId`	Long	Unique identifier of a notification (for de-duplication)	Yes
`orderCode`	String	Unique code used by the channel to identify the order	Yes
`parentOrderCode`	String	Order identifier to map the parent order with child orders	No
`orderTime`	String	Time at which the order was placed at the channel by the customer (in UTC)	Yes
`startProcessingTime`	String	Time after which order processing is allowed in the fulfillment system (in UTC)	Yes
`requiredBy`	String	SLA time before which order processing is expected to be completed (in UTC)	Yes
`paymentMethod`	String	Payment mode used by the customer to place the order (e.g., COD, NCOD)	Yes
`isPriority`	Boolean	Flag indicating if the order is high priority	Yes
`channelName`	String	Channel name of the marketplace	Yes
`eventType`	String	Event type (e.g., SUBORDER_CREATE, SUBORDER_CANCEL, etc.)	Yes
`onHold`	Boolean	Indicates if the order should be kept on hold for processing	Yes
`orderCustomAttributes`	Object	Custom attributes of the order	No
`orderCustomAttributes.attribute1`	String	Custom attribute 1	No
`orderCustomAttributes.attribute2`	String	Custom attribute 2	No
`orderCustomAttributes.attribute3`	String	Custom attribute 3	No
`orderCustomAttributes.attribute4`	String	Custom attribute 4	No
`orderCustomAttributes.attribute5`	String	Custom attribute 5	No
`orderCustomAttributes.attribute6`	String	Custom attribute 6	No
`orderCustomAttributes.attribute7`	String	Custom attribute 7	No
`orderCustomAttributes.attribute8`	String	Custom attribute 8	No
`orderCustomAttributes.attribute9`	String	Custom attribute 9	No
`orderCustomAttributes.attribute10`	String	Custom attribute 10	No
`orderCustomAttributes.currency`	String	Currency used for the order	No
`orderCustomAttributes.channelMetadata`	Object	Metadata fields parsed at the channel’s end	No
`orderItems`	List<OrderItem>	List of order items	Yes
`orderItems.clientSkuId`	String	Unique identifier for an sku at client’s end	Yes
`orderItems.channelSkuCode`	String	SKU identifier of the channel	No
`orderItems.orderedQuantity`	Integer	Ordered quantity	Yes
`orderItems.cancelledQuantity`	Integer	Absolute cancelled quantity	Yes
`orderItems.customerCancelledQty`	Integer	Customer-cancelled quantity	No
`orderItems.sellerCancelledQty`	Integer	Seller-cancelled quantity	No
`orderItems.sellerRejectQty`	Integer	Seller-rejected quantity	No
`orderItems.channelDiscount`	Double	Discount provided by the channel per unit	No
`orderItems.sellingPricePerUnit`	Double	Selling price per unit	No
`orderItems.giftChargePerUnit`	Double	Gift charge per unit	No
`orderItems.sellerDiscount`	Double	Discount provided by the seller per unit	No
`orderItems.shippingCharge`	Double	Shipping charges on the item	No
`orderItems.isVirtual`	Boolean	Indicates if the item is virtual	Yes
`orderItems.isBundled`	Boolean	Indicates if the item is bundled	No
`orderItems.orderItemCustomAttributes`	Object	Custom attributes of the order item	No
`orderItems.orderItemCustomAttributes.attribute1`	String	Custom attribute 1	No
`orderItems.orderItemCustomAttributes.attribute2`	String	Custom attribute 2	No
`orderItems.orderItemCustomAttributes.attribute3`	String	Custom attribute 3	No
`orderItems.orderItemCustomAttributes.attribute4`	String	Custom attribute 4	No
`orderItems.orderItemCustomAttributes.attribute5`	String	Custom attribute 5	No
`orderItems.orderItemCustomAttributes.attribute6`	String	Custom attribute 6	No
`orderItems.orderItemCustomAttributes.attribute7`	String	Custom attribute 7	No
`orderItems.orderItemCustomAttributes.attribute8`	String	Custom attribute 8	No
`orderItems.orderItemCustomAttributes.attribute9`	String	Custom attribute 9	No
`orderItems.orderItemCustomAttributes.attribute10`	String	Custom attribute 10	No
`orderItems.orderItemCustomAttributes.channelMetaData`	Object	Metadata fields parsed at the channel’s end	No
`virtualSkuDefinitions`	List<VirtualSkuDefinition>	List of virtual SKU definitions	No
`virtualSkuDefinitions.virtualParentChannelSkuId`	String	SKU identifier of the virtual parent	Yes
`virtualSkuDefinitions.virtualParentBarcode`	String	Barcode of the virtual parent	No
`virtualSkuDefinitions.virtualParentClientSkuCode`	String	Client SKU code of the virtual parent	No
`virtualSkuDefinitions.childSkus`	List<ChildDefinition>	List of child SKUs	No
`childSkus.channelSkuCode`	String	SKU code of the child SKU	No
`childSkus.qty`	Integer	Quantity of the child SKU	No
`childSkus.barcode`	String	Barcode of the child SKU	No
`childSkus.clientSkuCode`	String	Code to identify the child sku at client’s end	No
`bundledSkuDefinitions`	List<BundledSkuDefinition>	List of bundled SKU definitions	Yes
`bundledSkuDefinitions.bundledParentBarcode`	String	Unique barcode of the bundled SKU	No
`bundledSkuDefinitions.bundledParentChannelSkuId`	String	Unique identifier of the bundled SKU at the channel	Yes
`bundledSkuDefinitions.bundledParentClientSkuCode`	String	Unique identifier of the bundled sku at client’s end	No
`bundledSkuDefinitions.childSkus`	List<ChildDefinition>	List of child SKUs in the bundle	Yes

Response Body

HttpStatus : 200