Versions Compared

Version Old Version 5 New Version 6
Changes made by

Rahul Singh

Rahul Singh

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Proxy Flow

Channel API's

Channel API endpoints

Get List of Orders

Lists orders that match specified search criteria.(based on filters for status and created_at time)

/rest/default/V1/orders

Get an Order

Get order details for an order id

/rest/default/V1/orders/{orderId}

Get Order status

Get status of a specific order

/rest/default/V1/orders/{id}/statuses

Get Canceled orders List

Lists orders that match specified search criteria.(based on filters for status and updated_at time

/rest/default/V1/orders

Order Acknowledgment

Change order status to processing as an acknowledgement of order received

rest/default/V1/orders/orders/{orderId}/comments

Cancel order

Cancels a specified order.

/rest/default/V1/orders/{orderId}/cancel

Create Shipment

Performs persist operations for a specified shipment.

/rest/default/V1/shipment/

Create Invoice

Create invoice on magento

/rest/default/V1/order/{orderId}/invoice

Get Invoice

Get invoice details from magento based on the filter of order id

/rest/default/V1/invoices

Get Shipment

Get shipping label

/rest/default/V1/shipment/{shipmentId}

Create Manifest

No call to channel

null

Get Manifest

No call to channel

null

Update Inventory

Update the inventory of a specific sku

/rest/default/V1/products/{productSku}/stockItems/{itemId}

Credential Api

Get access token

/rest/V1/integration/admin/token

Return Orders

No call to channel(used to create a return order corresponding to a forward order in AssureIncreff Omni)

null

Handover Orders

The order is handed over to the delivery partner marking the order complete at magento panel

/rest/default/V1/order/{orderId}/ship

...

This API is used to create B2C return orders in AssureIncreff Omni.

Description

This API is used to create B2C return orders in AssureIncreff Omni. One order item represents only one quantity of an SKU. If there are multiple quantities of the same SKU then multiple order items should be created.

...

Parameter Name

Data Type

Description

Mandatory

forwardOrderCode

String

Forward order code for which return order is being created. This will be the entity_id of the forward order created in AssureIncreff Omni

yes

returnOrderCode

String

This is a unique identifier provided by the channel to identify the return order

yes

locationCode

String

Location code of the warehouse where the return order will be received. This is the location code of order in AssureIncreff Omni.

yes

returnOrderTime

String

Time at which return order got placed by customer. This should be in the format as mentioned above

no

orderItems

Object[]

Array of order items, order items represent each line of return order.

yes

orderItems.itemCode

String

This is a unique identifier provided by the channel to identify the return order item.

yes

orderItems.reason

String

Reason for return as given by the customer.

yes

orderItems.channelSkuCode

String

SKU code for return order item.

yes

orderType

String

Type of return. Possible values - SELF_SHIP,CUSTOMER_RETURN,RETURN_TO_ORIGIN

yes

awbNumber

String

Courier tracking number.

no

transporter

String

Courier partner name.

no

...