Content Comparison

Outbound | POST | {Client’s URL}

Summary

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

Description

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

This API trigger will be triggered 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
SUBORDER_COMPLETE

Please turn on these event from OMS UI. The above listed events can be enabled or disabled from Increff’s CIMS user interface with help of Increff support team

Request

Code Block

language	json

{
  "locationCode": "IN132",
  "messageId": 12345,
  "orderCode": "flipkart1234",
  "parentOrderCode": "flipkart1221",
  "orderTime": "2020-10-16T20:22:28.000+00:0028Z[UTC]",
  "startProcessingTime": "2020-10-16T20:22:28.000+00:0028Z[UTC]",
  "requiredBy": "2020-10-16T20:22:28.000+00:0028Z[UTC]",
  "paymentMethod": "COD",
  "isPriority": false,
  "channelName": "flipkart",
  "eventType": "SUBORDER_CREATE/SUBORDER_PARTIAL_CANCEL/SUBORDER_CANCEL/SUBORDER_PROPERTIES_UPDATE/SUBORDER_COMPLETE",
  "onHold": true/false",
  "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"
    }
  ]
}

Parameter Name	Data Type	Description	Mandatory
`locationCode`	String

Location

Identifier of the location from which order

was

is fulfilled

Yes

orderCode

String

Unique code used by the channel to identify order

Yes

parentOrderCode

String

Parent order code which can be null or empty or some duplicate value across orders.

Order identifier to map the parent order with child orders	No
`channelName`	String	Channel name of the marketplace

.

	Yes
`orderTime`	String	Time at which order was placed at the channel by customer (in

UNIX (

UTC)	Yes
`startProcessingTime`	String	Time after which order

packing

processing is allowed

by MarketPlace

in the fulfillment system(in UTC)	Yes
`requiredBy`	String

Time by

SLA time before which

the

order

should be manifested

processing is expected to be completed(in UTC)

Yes

messageId

Long

Unique Identifier of a notification(for De-duplication)

Yes

paymentMethod

String

It signifies the payment mode using which customer has placed the order

Possible values

-

→ COD

,

`/NCOD`	Yes
`isPriority`	Boolean	This flag is `true` in case order is HIGH priority than normal orders

.

, it is defined by front end system (Brand website or Marketplace)	Yes
`onHold`	Boolean

True if order is

Identifier to be used to decide whether an order should be kept onHold for processing

otherwise false

Yes

or not. Possible Values → `true, false`	Yes
`eventType`	String	Possible values: `SUBORDER_CREATE` `SUBORDER_PARTIAL_CANCEL` `SUBORDER_CANCEL` `SUBORDER_PROPERTIES_UPDATE` `SUBORDER_COMPLETE`	Yes
`orderCustomAttributes`	Object	Custom attributes of 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	no
`orderCustomAttributes.channelMetaData`	Object	meta data fields as an object which is to be parsed at the channel’s end	no
`orderItems`	Object[]	List of order items	Yes
`orderItems.clientSkuId`	String	Scannable barcode on the product	Yes
`orderItems.channelskuCode`	String	SKU

code

identifier of

order item

channel	Yes
`orderItems.orderedQuantity`	int	Ordered Quantity	Yes
`orderItems.cancelledQuantity`	int	Absolute cancelledQuantity	Yes
`orderItems`.`customerCancelledQty`	int	customer cancelled quantity	No
`orderItems`.`barcode`	barcode	barcode	No
`orderItems`.`sellerCancelledQty`	int	seller cancelled qty	No
`orderItems`.`sellerRejectQty`	int	seller rejected qty	No
`orderItems`.`fulfilledQuantity`	int	fulfilled qty	No
`orderItems`.`hoppedQuantity`	int	hopped qty	No
`orderItems.sellingPricePerUnit`	double	sellingPricePerUnit	No
`orderItems.giftChargePerUnit`	Double	giftChargePerUnit	No
`orderItems.channelDiscount`	Double	Discount provided by channel per unit	No
`orderItems.sellerDiscount`	Double	Discount provided by seller per unit	No
`orderItems.shippingCharge`	Double	Shipping charges on item	No
`orderItems.orderItemCustomAttributes`	Object[]	Custom attributes of order item	no
`orderItems.orderItemCustomAttributes.attribute1`	String	Custom attribute 1	no
`orderItems.orderItemCustomAttributes.attribute2`	String	Custom attribute 2	no
`orderItems.`

isVirtual

eventType

String

Possible values : { SUBORDER_CREATE,SUBORDER_PARTIAL_CANCEL,SUBORDER_CANCEL,SUBORDER_PROPERTIES_UPDATE,SUBORDER_COMPLETE}

Yes

shippingAddress

Object

Shipping address of the customer

Yes

shippingAddress.name

String

Name of customer

Yes

shippingAddress.line1

String

1st line of customer’s address

Yes

shippingAddress.line2

String

2nd line of customer’s address

No

shippingAddress.line3

String

3rd line of customer’s address

No

shippingAddress.city

String

City of customer

Yes

shippingAddress.state

String

State of customer

Yes

shippingAddress.zip

String

ZIP/Pin code of customer

Yes

shippingAddress.country

String

Country of customer

Yes

shippingAddress.email

String

Email of customer

No

shippingAddress.phone

String

Phone Number of customer

No

billingAddress

Object

Billing address of the customer

Yes

billingAddress.name

String

Name of customer

Yes

billingAddress.line1

String

1st line of customer’s address

Yes

billingAddress.line2

String

2nd line of customer’s address

No

billingAddress.line3

String

3rd line of customer’s address

No

billingAddress.city

String

City of customer

Yes

billingAddress.state

String

State of customer

Yes

billingAddress.zip

String

ZIP/Pin code of customer

Yes

billingAddress.country

String

Country of customer

Yes

billingAddress.email

String

Email of customer

No

billingAddress.phone

String

Phone Number of customer

No

virtualSkuDefinitions

Object[]

List of virtual SKU definitions

No

virtualSkuDefinitions.virtualParentChannelSkuId

String

SKU code of virtual SKU

Yes if its being used

virtualSkuDefinitions.virtualParentBarcode

String

Barcode of parent SKU

No

virtualSkuDefinitions

orderItemCustomAttributes.attribute3

Boolean

Field to determine if an orderItem is virtual

Yes

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	meta data fields as an object which is to be parsed at the channel’s end	no
`subOrderItems`	Object[]	List of order items	Yes
`subOrderItems.clientSkuId`	String	Scannable barcode on the product	Yes
`subOrderItems.channelskuCode`	String	SKU identifier of channel	Yes
`subOrderItems.orderedQuantity`	int	Ordered Quantity	Yes
`subOrderItems.cancelledQuantity`	int	Absolute cancelledQuantity	Yes
`subOrderItems`.`customerCancelledQty`	int	customer cancelled quantity	No
`subOrderItems`.`barcode`	barcode	barcode	No
`subOrderItems`.`sellerCancelledQty`	int	seller cancelled qty	No
`subOrderItems`.`sellerRejectQty`	int	seller rejected qty	No
`subOrderItems`.`fulfilledQuantity`	int	fulfilled qty	No
`subOrderItems`.`hoppedQuantity`	int	hopped qty	No
`subOrderItems.sellingPricePerUnit`	double	sellingPricePerUnit	No
`subOrderItems.giftChargePerUnit`	Double	giftChargePerUnit	No
`subOrderItems.channelDiscount`	Double	Discount provided by channel per unit	No
`subOrderItems.sellerDiscount`	Double	Discount provided by seller per unit	No
`subOrderItems.shippingCharge`	Double	Shipping charges on item	No
`subOrderItems.orderItemCustomAttributes`	Object[]	Custom attributes of order item	no
`subOrderItems.orderItemCustomAttributes.attribute1`	String	Custom attribute 1	no
`subOrderItems.orderItemCustomAttributes.attribute2`	String	Custom attribute 2	no
`subOrderItems.orderItemCustomAttributes.attribute3`	String	Custom attribute 3	no
`subOrderItems.orderItemCustomAttributes.attribute4`	String	Custom attribute 4	no
`subOrderItems.orderItemCustomAttributes.attribute5`	String	Custom attribute 5	no
`subOrderItems.orderItemCustomAttributes.attribute6`	String	Custom attribute 6	no
`subOrderItems.orderItemCustomAttributes.attribute7`	String	Custom attribute 7	no
`subOrderItems.orderItemCustomAttributes.attribute8`	String	Custom attribute 8	no
`subOrderItems.orderItemCustomAttributes.attribute9`	String	Custom attribute 9	no
`subOrderItems.orderItemCustomAttributes.attribute10`	String	Custom attribute 10	no
`subOrderItems.orderItemCustomAttributes.channelMetaData`	Object	meta data fields as an object which is to be parsed at the channel’s end	no
`virtualSkuDefinitions.childSkus`	Object[]	List of child SKUs	No
`childSkus.channelSkuCode`	String	SKU code of child SKU	No
`childSkus.qty`	Integer	Quantity of child SKU	No
`childSkus.barcode`	String	Barcode of child SKU	No
`bundledSkuDefinitions`	Object[]	List of bundled sku definitions	yes
`bundledSkuDefinitions.bundledParentBarcode`	String	Unique barcode of bundled Sku	no
`bundledSkuDefinitions.bundledParentChannelSkuId`	String	Unique identifier of bundled Sku at channel	yes
`bundledSkuDefinitions.childSkus`	Object[]	List of child SKUs

No

yes

childSkus.

channelSkuCode

barcode

String

SKU code

Unique barcode of child

SKU

sku

No

no

childSkus.

qty

channelSkuCode

Integer

String

Quantity

Unique identifier of child

SKU

sku at channel

No

no

childSkus.

barcode

qty

String

Integer

Barcode of

child

SKU

sku quantity

No

no

Response

HttpStatus : 200

Version	Old Version 10	New Version Current
Changes made by	Alaf Azam Khan	Raghav Mehta
Saved on	Aug 03, 2023	Dec 26, 2024

Versions Compared

Key

Outbound | POST | {Client’s URL}

Summary

Description

Request