Outward Sales Posting APIs to POS (For Stores)

billingAddress

Object of type address

Billing Address

yes

billingAddress.city

String

City name

yes

billingAddress.country

String

Country Name

yes

billingAddress.email

String

email

yes

billingAddress.line1

String

address line 1

yes

billingAddress.line2

String

address line 2

no

billingAddress.lone3

String

address line 3

no

billingAddress.name

String

Name

yes

billingAddress.state

String

state name

yes

billingAddress.zip

String

zip code

yes

billingAddress.phone

String

phone number

yes

channelName

String

channel name

yes

channelType

“ERP”

channel type

yes

createdAt

String

created at time

yes

credentials

list of credentials

credentials

no

eventTime

String

time of the event

yes

eventType

String

Postings can be sent on below triggers

• SUBORDER_CREATE (creation of sub order)

• SUBORDER_CANCEL (cancellation of sub order)

• SUBORDER_COMPLETE (completion of suborder)

• SUBORDER_PARTIAL_CANCEL (partial cancellation of suborder)

yes

orderType

String

Can be - SO(Sales Order)/STO(Stock Transfer Order)/RTV(Return To Vendor), RPO(Replacement)

yes

isPriority

Boolean

Flag to identify wether an order is of priority or not

yes

locationCode

String

Warehouse location from which order was fulfilled

yes

messageId

Long

Unique Identifier of a notification (for De-duplication)

yes

omsSubOrderId

Long

Internal sub order id of OMS

yes

orderCode

String

order code from channel

yes

parentOrderCode

String

parent order code from channel

no

paymentMethod

String

possible values- COD/NCOD

yes

shippingAddress

Object of type Address

Address

yes

shippingAddress.city

String

City name

yes

shippingAddress.country

String

Country name

yes

shippingAddress.line1

String

address line 1

yes

shippingAddress.line2

String

address line 2

no

shippingAddress.line3

String

address line 3

no

shippingAddress.name

String

name

yes

shippingAddress.state

String

state name

yes

shippingAddress.zip

String

pin code

yes

shippingAddress.email

String

email address

yes

shippingAddress.phone

String

phone nymber

yes

shippingCharges

Double

Shipping charge

no

subOrderItems

yes

subOrderItems.barcode

String

barcode

yes

subOrderItems.cancelledQuantity

Integer

cancelled quantity

yes

subOrderItems.channelDiscount

Double

discount from the channel

no

subOrderItems.channelSkuCode

String

Sku Code on channel side

yes

subOrderItems.fulfilledQuantity

Long

fulfilled quantity

yes

subOrderItems.giftChargePerUnit

Double

giftChargePerUnit

no

subOrderItems.hoppedQuantity

Long

hoppedQuantity

yes

subOrderItems.omsSubOrderItemId

Long

sub order item id in oms

yes

subOrderItems.orderItemCodes

List<String>

list of order item codes

yes

subOrderItems.orderedQuantity

Long

ordered quantity

yes

subOrderItems.sellerDiscount

Double

seller discount

no

subOrderItems.sellingPricePerUnit

Double

selling price per item

no

subOrderItems.shippingCharge

Double

shipping charde

no

subOrderItems.externalItemCodes

List of String

list of item codes

no

turnAroundTime

String

turn around time

no

virtualSkuDefinitions

no

virtualSkuDefinitions.childSkus

List

List of child skus

no

virtualSkuDefinitions.virtualParentBarcode

String

Virtual Parent barcode

no

virtualSkuDefinitions.virtualParentChannelSkuId

String

Virtual Parent channel SKU id

yes

virtualSkuDefinitions.childSkus.barcode

String

barcode

no

virtualSkuDefinitions.childSkus.qty

Integer

quantity

no

virtualSkuDefinitions.childSkus.channelSkuCode

String

channel SKU code

no