Order Processing for Increff

Pack Order

When the order is packed, Increff will call omni location engine’s Pack Order API.

Omni location engine will transform the request received from Increff according to eshopbox API request.

Omni location engine will call Create Label And Awb API in eshopbox.

Sample request for Increff

{
  "orderCode": "H19304030001",
  "locationCode": "l123",
  "shipmentId": 120001,
  "packageSku": "sku123",
  "weight": 40,
  "fulfillmentType": "BLOCK_COMPLETE",
  "dimensions": {
    "length": 12,
    "breadth": 6,
    "height": 8
  },
  "invoice": {
    "fromAddress": {
      "name": "sellerName",
      "line1": "address line 1",
      "line2": "address line 2",
      "line3": "address line 3",
      "city": "Bengaluru",
      "state": "Karnataka",
      "zip": "560076",
      "country": "INDIA",
      "email": "email.com",
      "phone": "9999999999"
    },
    "shippingAddress": {
      "name": "customerName",
      "line1": "address line 1",
      "line2": "address line 2",
      "line3": "address line 3",
      "city": "Bengaluru",
      "state": "Karnataka",
      "zip": "560076",
      "country": "INDIA",
      "email": "email.com",
      "phone": "9999999999"
    },
    "billingAddress": {
      "name": "customerName",
      "line1": "address line 1",
      "line2": "address line 2",
      "line3": "address line 3",
      "city": "Bengaluru",
      "state": "Karnataka",
      "zip": "560076",
      "country": "INDIA",
      "email": "email.com",
      "phone": "9999999999"
    },
    "orderTime": "2020-10-16T20:22:28.000+00:00",
    "channelName": "flipkart",
    "fromPartyName": "name1",
    "toPartyName": "name2",
    "fromTIN": "tin1",
    "toTIN": "tin2",
    "panNo": "123PV99",
    "invoiceItems": [
      {
        "actualSellingPricePerUnit": 6.0,
        "actualSellingPriceTotal": 12.0,
        "channelSkuCode": "sku1",
        "itemName": "item1",
        "quantity": 2,
        "taxRule": "GST",
        "hsnCode": "hsn1",
        "vendorSku": "vendorSku1",
        "mrp": 15.0,
        "brand": "brand1",
        "styleCode": "style1",
        "color": "white",
        "size": "size1",
        "category": "shirt",
        "imageUrl": "www.imageUrl.com/1234"
      }
    ]
  },
  "packboxDetailsList": [
    {
      "boxId": 1000001020,
      "length": 12.0,
      "breadth": 6.0,
      "height": 8.0,
      "weight": 13.2,
      "volWeight": 235.5,
      "boxSkuId": "bsku_1"
    },
    {
      "boxId": 1000001021,
      "length": 12,
      "breadth": 6,
      "height": 8,
      "weight": 13,
      "volWeight": 285.5,
      "boxSkuId": "bsku_2"
    }
  ],
  "shipmentItems": [
    {
      "channelSkuCode": "100000789701",
      "orderItemCode": "item123",
      "quantity": 7,
      "itemCodes": [
        "it1","it2"
      ],
      "externalSerialCodes": [
        "ser1","ser2"
      ],
      "skuDimension": {
        "length": 12,
        "breadth": 6,
        "height": 8,
        "weight": 13
      }
    },
    {
      "channelSkuCode": "100000789702",
      "orderItemCode": "item124",
      "quantity": 5,
      "itemCodes": [
        "it3","it4"
      ],
      "externalSerialCodes": [
        "ser3","ser4"
      ],
      "skuDimension": {
        "length": 12,
        "breadth": 6,
        "height": 8,
        "weight": 13
      }
    }
  ]
}

Key Mapping between Increff and Eshopbox

Eshopbox Fields	Mandatory	Increff Fields

Eshopbox Fields	Mandatory	Increff Fields
`boxHeight`		TBD with Increff Team
`boxLength`		TBD with Increff Team
`boxWidth`		TBD with Increff Team
`weight`		`weight`
`orderItems`[].`orderItemId`	Y	`shipmentItems`[].`orderItemCode`
`orderItems`[].`invoiceNumber`		Not Available
`orderItems`[].`invoiceDate`		`orderTime`
`orderItems`[].`taxRate`		Not Available
`orderItems`[].`centralGstPercentage`		Not Available
`orderItems`[].`compensationCessPercentage`		Not Available
`orderItems`[].`integratedGstPercentage`		Not Available
`orderItems`[].`stateGstPercentage`		Not Available
`orderItems`[].`unionTerritoryGstPercentage`		Not Available

Invoice generation

This Increff API will fetch invoice URL along with tax details from Eshopbox.

The url from omni location engine shall be provided to fetch the Invoice by Increff

The Omni location engine will internally call Get Awb And Courier Name endpoint to fetch Invoice and billing label details

Example : https://wms.eshopbox.com/articles?shipmentCode=2342&orderCode=2

Key Mapping between Increff and Eshopbox Requests

Increff Fields	Mandatory	Eshopox Fields

Increff Fields	Mandatory	Eshopox Fields
`shipmentCode`	Y	extrenalShipmentID
`orderCode`	Y	`extrenalShipmentID`

Open Question:

What Increff will pass in ShipmentCode

Expected response for Increff for Get Invoive API:

{
  "invoiceCode": "INV123",
  "invoiceUrl": "https://mybrand.com/invoice123.pdf",
  "irn": "a429746e34d844c9d2cb2a6f68997d1c2af23987cc834f3b52da45d1b0bc9799",
  "qrCode": "eyJhbGciKiJSUzI1NiIsImtpZCI6IkI4RGYzRUNCNThFQTVFNkY0QUFDM0Q1MjQ1NDNCMjI0NjY2OUIwRjgiLCJ0eXAiOiJKV1QiLCJ4NXQiOiJ1TlkteTFqcVhtOUtyRDFTUlVPeUpHWnBzUGcifQ.eyJkYXRhIjoie1wiU2VsbGVyR3N0aW5cIjpcIjI5QUFPQ001MzI2SjFaWVwiLFwiQnV5ZXJHc3RpblwiOlwiMjlBQUJDUjE3MThFMVpMXCIsXCJEb2NOb1wiOlwiTUVhajIyLTIzLzUwNTlcIixcIkRvY1R5cFwiOlwiSU5WXCIsXCJEb2NEdFwiOlwiMTMvMTAvMjAyMlwiLFwiVG90SW52VmFsXCI6MTgxNy4wNCxcIkl0ZW1DbnRcIjoxLFwiTWFpbkhzbkNvZGVcIjpcIjYyMTE0MjkwXCIsXCJJcm5cIjpcImE0Mjk3NDZlMzRkODQ0YzlkMmNiMmE2ZjY4OTk3ZDFjMmFmMjM5ODdjYzgzNGYzYjUyZGE0NWQxYjBiYzk3YzlcIixcIklybkR0XCI6XCIyMDIyLTEwLTEzIDEyOjAxOjAwXCJ9IiwiaXNzIjoiTklDIn0.wvB7b15AnpdQdX_d0VZEyj9dL1qWDaOFPLRPrlV0V2XIu3cE3aQ3YtsWLnTnyrmtUlokpbkkE4folBQNhfzkCPlnODNxRPfpO-Kz9eyNpqcIEp-8TqvcDKXZ3PrBRqmNmner00AG_fVmmqT1HLiyKB2sqOnhqtCfQaQF-PGnqIOhal3PDxIMVt0WAtaQOIwwDA75dsjjnFHaZFPl9tFPR8A6Wrw4NhQH-7xhABKW3Z961a_rGmO6M3XP7jPHyYPW-QWMfTqwNXwxNdFgFePL5FloPiUipt2-g4FIplgm-YcN1xMvEQ2irAfzQwbnxi7UKz-jwOgM0Zy2BbburYgDvQ",
  "invoiceDate": "2020-10-16T20:22:28.000+05:30",
  "invoice": "invoiceBase64String",
  "invoiceDetails": [
    {
      "channelSkuCode": "100000789702",
      "orderItemCode": "item123",
      "netTaxAmountPerUnit": 60,
      "netTaxAmountTotal": 120,
      "baseSellingPricePerUnit": 500,
      "baseSellingPriceTotal": 1000,
      "actualSellingPricePerUnit": 560,
      "actualSellingPriceTotal": 1120,
      "quantity": 2,
      "taxItems": [
        {
          "type": "SGST",
          "rate": 6,
          "taxPerUnit": 30,
          "taxTotal": 60
        },
        {
          "type": "CGST",
          "rate": 6,
          "taxPerUnit": 30,
          "taxTotal": 60
        }
      ]
    }
  ]
}

Key Mapping between Increff and Eshopbox Response

Increff Fields	Mandatory	Eshopox Fields

Increff Fields	Mandatory	Eshopox Fields
`invoiceCode`	Y	Response of Pack Order
`invoiceUrl`	N	`labelUrl`
`invoice`	either of invoice and invoice Url is mandatory	`Not Available`
`irn`	N	`Not Available`
`qrCode`	N	`Not Available`
`invoiceDate`		Invoice Date
`invoiceDetails[].channelSkuCode`	If invoice details are being sent, then taxItems are mandatory.	sku (Order_Items) -Same as in Order Not Available
`invoiceDetails[].orderItemCode`	N	`orderItemId (Order_items)`Not Available
`invoiceDetails[].netTaxAmountPerUnit`	Y	taxAmount (order_items) Not Available
`invoiceDetails[].netTaxAmountTotal`	Y	taxAmount (order_items) * quantityNot Available
`invoiceDetails[].baseSellingPricePerUnit`	Y	mrp (order_items) Not Available
`invoiceDetails[].baseSellingPriceTotal`	Y	mrp (order_items) * quantity Not Available
`invoiceDetails[].actualSellingPricePerUnit`	Y	invoiceTotal (order_items)
`invoiceDetails[].actualSellingPriceTotal`	Y	invoiceTotal (order_items) * quantity
`invoiceDetails[].quantity`	Y	quantity (order_items)
`invoiceDetails[].taxItems`	Y
`taxItems[].type`	Y	CGST/IGST/SGST/UTGST
`taxItems[].rate`	Y	centralGstPercentage/integatedGstPercentage/stateGstPercentage/unionTerritoryGstPercentage (Order_items)
`taxItems[].taxPerUnit`	Y	cgst/igst/sgst/utgst (order_items)
`taxItems[].taxTotal`	Y	cgst/igst/sgst/utgst (order_items) * quantity

NOTE:

Increff expects tax rates and tax amount for CGST, IGST, SGCT in JSON format, but eshopbox gets these details from the saleschannel in pdf format in the invoice generated by saleschannel.

GST values are only stored for custom integrations and shopify and not for all sales channels

Shipping Label Generation

This Increff API will fetch shipping information from Eshopbox.

The url from omni location engine shall be provided to fetch the Shipping label by Increff

The Omni location engine will internally call Get Awb And Courier Name endpoint to fetch Invoice and billing label detailsG

Example : https://wms.eshopbox.com/articles?shipmentCode=2342&orderCode=2

Key Mapping between Increff and Eshopbox Requests

Increff Fields	Mandatory	Eshopox Fields

Increff Fields	Mandatory	Eshopox Fields
`shipmentCode`	Y	`TBD`
`orderCode`	Y	`externalShipmentId`

Expected response for Increff for Get Shipping Label API:

{
  "shippingLabelUrl": "https://mybrand.com/transporter.pdf",
  "awbNumber": "awb456fd5435",
  "shippingLabel": "base64shippinglabelstring",
  "transporter": "transporter"
}

Sample Response of Get Awb and Courier Name API

{
  "awbNo": "FMPP1858986839"
  "courierCode": "E-Kart Logistics"
  "courierName": "E-Kart Logistics"
  "invoiceNumber": "FANOAJ2400009329"
  "labelStream":"JVBERi0xLjQKJfbk/N8KMSAwIG..." ,
  "labelUrl": "https://storage.googleapis.com/label_invoice_file_uploads/label_invoice_folder/combined-FMPP1858986839-1694489167929.pdf"
  "status": "SUCCESS"
}

Key Mapping between Increff and Eshopbox Response

Increff Fields	Mandatory	Eshopox Fields

Increff Fields	Mandatory	Eshopox Fields
`shippingLabelUrl`	Y	`labelUrl`
`awbNumber`	Y	`awbNo`
`shippingLabel`	Y	`labelStream`
`transporter`	Y	`courierName`

Code Change in COre API’s required

Separate Shipping label and Invoice

Handover

This API will notify eshopbox that handover of the shipment is done.

The url from omni location engine shall be provided to notify handover by Increff.

The Omni location engine will internally call markDispatched endpoint.

Sample Request from Increff

{
  "transporter": "WERTYU",
  "locationCode": "wd02",
  "manifestId": 87456,
  "manifestItems": [
    {
      "orderCode": "H19304030001",
      "shipmentCode": "eid123",
      "awbNumber": "awb123"
    }
  ]
}

Sample URL for markDispatched

PUT : http://blackberrys.eshopbox.com/order/shipment/eid123/markDispatched

Key Mapping between Increff and Eshopbox Requests

Increff Fields	Mandatory	Eshopox Fields

Increff Fields	Mandatory	Eshopox Fields
`transporter`	Y	`courierName`
`locationCode`	Y	`externalWarehouseId`
`manifestId`	N	manifest_id (shipments)
`manifestItems[].orderCode`	Y	`externalShipmentId`
`manifestItems[].shipmentCode`	Y	`TBD`
`manifestItems[].awbNumber`	Y	`awbNo`

Sample response expected by Increff

{
  "manifestCode": "72653",
  "manifestItems": [
    {
      "orderCode": "515",
      "shipmentCode": "95848"
    }
  ]
}

Key Mapping between Increff and Eshopbox Response

Increff Fields	Mandatory	Eshopox Fields

Increff Fields	Mandatory	Eshopox Fields
`manifestCode`	Y	`manifest_id`(shipments)
`manifestItems[].orderCode`	Y	`externalShipmentId` (order_items)
`manifestItems[].shipmentCode`	Y	`externalShipmentId (shipments)`

Order Cancellation

When any order is cancelled at marketplace, The cancelled order are polled by eshopbox and the order is cancelled in eshopbox workspace. When eshopbox order is cancelled, Shipment Cancel Event is triggered.

Omni Location engine shall listen to Shipment Cancel Event and trigger cancel order API of Increff.

Sample Shipment cancellation Event

"response_data": {
    "customerOrderNumber": "5153206763687",
    "orderSiteID": "",
    "vendorOrderNumber": "#44617",
    "externalShipmentID": "5153206763687-1161-9661",
    "externalWarehouseID": "Gurgaon_FC",
    "externalChannelID": "CH1161",
    "externalWmsChannelName": "LABRADA_SHOPIFY_APP_VITAMINPLANET_AGGN_2298",
    "external_wms_channel_id": 2298,
    "channelLabel": "Labrada Shopify App",
    "integrationType": "7",
    "vendorPartyID": null,
    "partner_as2_id": null,
    "defaultWarehouseCode": "Gurgaon_FC",
    "facilityLabel": "Gurgaon (AGGN)",
    "facilityType": "auperator",
    "orderDate": "2023-09-12 08:28:53",
    "portal_id": 27,
    "paymentType": "Cash on Delivery (COD)",
    "expectedShipDate": "2023-09-12 12:00:00",
    "dispatchAfterDate": null,
    "externalManifestNumber": null,
    "channelManifestNumber": null,
    "order_id": 50266207,
    "channel_id": 1161,
    "warehouse_id": 650,
    "channel_account_id": 0,
    "account_id": 379,
    "connectionId": 321,
    "locationId": "66322858151",
    "region": "Zonal",
    "isMetro": "0",
    "isSpecialplace": "0",
    "shippingConnectionId": 0,
    "picklistCode": null,
    "invoiceNumber": "INVVITHZ61832",
    "boxType": "UNKNOWN",
    "isPriorityShipment": "0",
    "isGift": "0",
    "invoice_url": "https://storage.googleapis.com/invoicefiles-prod/invoice/515320676368711619661-1694487610409.pdf",
    "invoiceDate": "2023-09-12 08:30:07",
    "label_url": "",
    "labels": "",
    "shippingInfo": [],
    "boxAdditionalRecommendation": [],
    "dimension_length": "13.3",
    "dimension_width": "12.5",
    "dimension_height": "12.5",
    "weight": "500",
    "trackingID": "",
    "trackingDomain": "track.labradanutrition.in",
    "packageID": "",
    "barcode": "",
    "taxAmount": 0,
    "shipChargeAmount": 0,
    "courierName": "SELF",
    "cp_id": 0,
    "created_at": "2023-09-12 08:29:06",
    "updated_at": "2023-09-12 08:30:11",
    "status": "cancelled",
    "remarks": "customer_cancel",
    "warehousePincode": "122503",
    "thirdPartyShipping": false,
    "customerName": "Irshad Shaikh",
    "customerContactNumber": "7878629758",
    "email": "nomailprovided@gmail.com",
    "channelSlug": "vitaminplanet",
    "status_updated_at": "2023-09-12 10:23:55",
    "status_log": {
      "created": "2023-09-12 08:29:06",
      "accepted": "2023-09-12 08:30:06",
      "cancelled": "2023-09-12 10:23:55"
    },
    "status_log_first_occurrence": {
      "cancelled": "2023-09-12 10:23:55",
      "accepted": "2023-09-12 08:30:06",
      "created": "2023-09-12 08:29:06"
    },
    "status_log_count": {
      "created": 1,
      "accepted": 1,
      "cancelled": 1
    },
    "status_log_id": "133192779",
    "orderExternalCreatedAt": "2023-09-12 08:29:01",
    "riskScore": "High",
    "riskScoreReasons": [
      "Address issue",
      "Suspicious behaviour"
    ],
    "pincodeServiceableRemarks": "",
    "orderAdditionalInfo": "",
    "shippingAddress": {
      "customerName": "Irshad Shaikh",
      "addressLine1": "Ander kot noor coloni ajmer",
      "addressLine2": "null",
      "city": "Ajmer",
      "state": "Rajasthan",
      "postalCode": "305001",
      "countryCode": "IN",
      "countryName": "INDIA",
      "contactPhone": "7878629758",
      "email": "nomailprovided@gmail.com"
    },
    "billingAddress": {
      "customerName": "Irshad Shaikh",
      "email": "nomailprovided@gmail.com",
      "contactPhone": "7878629758"
    },
    "warehouseAddress": {
      "addressLine1": "MJ Logistics Private Limited, Seabird Marine Services Pvt Ltd",
      "addressLine2": "Village Babra Bakirpur, Pataudi Road Near Adani Logistic Park,  ICD Patli, Gurgaon, Haryana(122503)",
      "city": "Gurgaon",
      "state": "Haryana",
      "postalCode": "122503",
      "gstin": "06AAFCB0498R2Z2"
    },
    "id": 18472117,
    "balanceDue": 899,
    "orderTotal": 899,
    "subTotal": 899,
    "isCOD": "1",
    "track_payload": [],
    "notifyCustomer": true,
    "items": [
      {
        "order_item_id": 32905934,
        "lineItemSequenceNumber": 12302208467111,
        "orderItemID": "5153206763687-32905934",
        "itemID": "43125095137447",
        "sku": "68YAN3GPQOM",
        "asin": "",
        "productName": "CreaLean Strength Creatine Powder",
        "quantity": 1,
        "orderItemCreatedAt": "2023-09-12 08:29:01",
        "customerPrice": 1099,
        "lineItemTotal": 899,
        "invoiceTotal": 899,
        "cashOnDeliveryCharges": 0,
        "discount": 200,
        "taxRate": 0,
        "taxAmount": 0,
        "inventoryItemCode": "",
        "giftMessage": "",
        "isGift": "0",
        "giftLabelContent": "",
        "lineItemOrderStatus": "",
        "orderItemIDs": [
          "5153206763687-32905934"
        ],
        "productImageUrl": "https://static.vitaminplanet.in/2113/labrada-crealean.jpg",
        "productAdditionalInfo": null,
        "expectedDeliveryDate": null,
        "shippingCharges": 0,
        "productUrl": null,
        "originalOrderItemId": null,
        "isVirtualKit": "0",
        "component": [],
        "onhold": "1",
        "cancellationAdditionalReason": "",
        "cancellationReason": "High risk of failed delivery",
        "customerOrderItemID": "",
        "recallBlockedInventoryUsed": ""
      }
    ]
  }

Increff Cancel order API

URL : https://staging-asim.increff.com/assuremagic2/orders/{orderCode}/cancel

Request for Increff Cancel Order API

{
   "locationCode":"locationCode",
   "orderItems":[
      {
         "channelSkuCode":"100000789702",
         "cancelledQuantity":1,
         "orderItemCode":"item123"
      },
      {
         "channelSkuCode":"100000789703",
         "cancelledQuantity":4,
         "orderItemCode":"item124"
      }
   ]
}

Key Mapping between Increff and Eshopbox Requests

Increff Fields	Mandatory	Eshopox Fields

Increff Fields	Mandatory	Eshopox Fields
`orderCode`	Y	`externalShipmentId`
`locationCode`	Y	`externalWarehouseId`
`orderItems[].channelSkuCode`	Y	`response_data.items[].sku`
`orderItems[].cancelledQuantity`	Y	`response_data.items[].quantity`
`orderItems[].orderItemCode`	Y	`response_data.items[].esin`

Unhold Order

If any order which was earlier created as an onhold order , is now moved to Unhold status

The order is moved to unhold status in Eshopbox, by calling the POST API to mark order to Unhold,

URL: http://{{account_Slug}}.eshopbox.com/api/orders/unhold

{
    "externalChannelId": "CH1943",
    "externalShipmentId": "OD225457492199440000-1943-374",
    "customerOrderNumber": "4b594944-69b0-4e69-bc23-c0d086517482",
    "items": [
        {
            "itemId": "SRTGFGHF4H4HCBVF",
            "quantity": "1",
            "lineItemSequenceNumber": "22545749219944002",
            "orderItemId": "22545749219944002-24939335"
        }
    ]
}

This API creates an event in the Pub/Sub topic: wms_unhold_shipment_event

The Omni location engine consumes events published to the above topic and hits Increff’s Inbound Update Order Properties API.

URL for Increff’s Update Order API: PUT :: https://staging-asim.increff.com/assuremagic2/orders/{orderCode}

Request Body

{
  "dispatchByTime": "2022-10-17T20:22:28.000+00:00",
  "locationCode": "string",
  "onHold": false,
  "startProcessingTime": "2023-09-16T20:22:28.000+00:00",
  "deliveredAt": "2023-09-30T20:22:28.000+00:00",
  "orderStatus": "DELIVERED"
}

Key Mapping between Increff and Eshopbox Requests

Increff Fields	Mandatory	Eshopox Fields

Increff Fields	Mandatory	Eshopox Fields
`orderCode`	Y	`externalShipmentId`
`dispatchByTime`	Y	`expectedShipDate`
`locationCode`	Y	LocationId to be fetched from externalWarehouseId from Connection Table
`onHold`	Y	`False`
`startProcessingTime`	Y	`CurrentDateTime`
`deliveredAt`	N	Not Available
`orderStatus`	N	Not Available

Apps and Automations

Order Processing for Increff

Pack Order

Invoice generation

Shipping Label Generation

Handover

Order Cancellation

Unhold Order

Related content