Skip to end of banner
Go to start of banner

Push Outward Order Events API

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 20 Next »

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

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

Request

{
	"locationCode": "IN132",
	"messageId": 12345,
	"orderCode": "flipkart1234",
	"parentOrderCode": "flipkart1221",
	"orderTime": "2020-10-16T20:22:28.000+00:00",
	"startProcessingTime": "2020-10-16T20:22:28.000+00:00",
	"requiredBy": "2020-10-16T20:22:28.000+00:00",
	"paymentMethod": "COD",
	"isPriority": false,
	"channelName": "flipkart",
	"eventType": "SUBORDER_CREATE/SUBORDER_PARTIAL_CANCEL/SUBORDER_CANCEL/SUBORDER_COMPLETE",
	"onHold": false,
	"orderItems": [{
		"clientSkuId": "1000889888",
		"channelSkuCode": "1000889888",
		"orderedQuantity": 2,
		"cancelledQuantity": 1,
		"channelDiscount": 50,
		"sellingPricePerUnit": 500,
		"giftChargePerUnit": 10,
		"sellerDiscount": 5,
		"shippingCharge": 0,
		"isVirtual": true
	}],
	"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
		}]
	}]
}

 

Parameter Name

Data Type

Description

Mandatory

locationCode

String

Identifier of the location from which order is fulfilled

Yes

 

orderCode

String

Unique code used by the channel to identify order

Yes

parentOrderCode

String

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 UTC)

Yes

startProcessingTime

String

Time after which order processing is allowed in the fulfillment system

Yes

requiredBy

String

SLA time before which order processing is expected to be completed

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

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

Possible Values → true, false

Yes

orderItems

Object[]

List of order items

Yes

orderItems.clientSkuId

String

Scannable barcode on the product

Yes

orderItems.channelskuCode

String

SKU identifier of channel

Yes

orderItems.orderedQuantity

int

Ordered Quantity

Yes

orderItems.cancelledQuantity

int

Absolute cancelledQuantity

Yes

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.isVirtual

Boolean

Field to determine if an orderItem is virtual

Yes

eventType

String

Possible values : { SUBORDER_CREATE,SUBORDER_PARTIAL_CANCEL,SUBORDER_CANCEL,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.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

 

Response

HttpStatus : 200

  • No labels