Skip to end of banner
Go to start of banner

Real Time GRN Notifications API (Gate Entry)

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 11 Next »

Outbound | POST  | {Client’s URL}

Summary

This API sends near real-time GRN Notifications to ERP with gate entry level data. The feature will help to keep the ERP systems notified about all the GRN’s happening for a client.

Description

This API sends all the GRN notification gate-entry wise for the orders for which items have been GRN’ed since the time the job last ran and synced notifications successfully to ERP. Frequency of this job is configurable.

Request

{
  "invoiceId": 1234,
  "invoiceDocumentUrl": "https://www.increff.com/invoiceUrl",
  "stateTaxDocumentUrl": "https://www.increff.com/staxDocurl",
  "shippingLabelDocumentUrl": "https://www.increff.com/slurl",
  "transporter": "BlueDart",
  "vehicleNumber": "KA90-87-01",
  "invoiceCode": "invoiceCode",
  "gateEntryCreatedAt": "2020-10-16T20:22:28.000+00:00",
  "externalInvoiceDate": "2020-10-16T20:22:28.000+00:00",
  "awbNumber": "awbNumber",
  "gateEntryId": 1234,
  "messageId": 1001,
  "orderCode": "po123",
  "orderType": "PO/STO/RO",
  "locationCode": "l123",
  "billOfEntry": "b123",
  "entryDeclarationNumber": "en1",
  "parentOrderCode": "pOrder123",
  "items": [
    {
      "channelSkuCode": "100005734",
      "qcPassAbsoluteQuantity": 500,
      "qcFailAbsoluteQuantity": 2,
      "qcFailDeltaQuantity": 1,
      "qcPassDeltaQuantity": 1
    },
    {
      "channelSkuCode": "100005736",
      "qcPassAbsoluteQuantity": 400,
      "qcFailAbsoluteQuantity": 2,
      "qcFailDeltaQuantity": 2,
      "qcPassDeltaQuantity": 2
    }
  ]
}

Parameter Name

Data Type

Description

Mandatory

invoiceCode

String

External invoiceId provided at the time of Gate entry creation

Yes

invoiceDocumentUrl

String

Invoice document provided at the time of Gate entry creation is available via the Url

Yes

stateTaxDocumentUrl

String

State tax document provided at the time of Gate entry creation is available via the Url

Yes

shippingLabelDocumentUrl

String

Shipping label document provided at the time of Gate entry creation is available via the Url

Yes

transporter

String

Transporter which delivered the goods to warehouse

Yes

vehicleNumber

String

Vehicle Number which delivered the goods to warehouse

Yes

gateEntryCreatedAt

String

Time at which gate entry was created in Increff Omni

Yes

externalInvoiceDate

String

Time at which order was placed at the channel in UNIX (UTC)

yes

awbNumber

String

Awb number of shipment which is getting inwarded

Yes

orderCode

String

Unique code used by the channel to identify the order

Yes

orderType

Possible value - SO (Sales Order), STO (Stock Transfer Order), RTV (Return To Vendor), RPO(Replacement)

Yes

locationCode

String

Code used by channels to identify a warehouse

Yes

messageId

Long

Unique Identifier of a notification ( for de-duplication)

Yes

billOfEntry

String

Bill of entry of GRN

no

entryDeclarationNumber

String

Entry declaration number

no

parentOrderCode

String

Parent order code

yes

items

Object[]

List of items GRNed

Yes

items.channelSkuCode

String

SKU code of order item

Yes

qcPassAbsoluteQuantity

Integer

Total Qc pass quantity GRNed in order for the SKU

Yes

qcFailAbsoluteQuantity

Integer

Total Qc fail quantity GRNed in order for the SKU

Yes

qcPassDeltaQuantity

Integer

Qc pass quantity GRNed in order for the SKU since the last notification to ERP for the order.

Yes

qcFailDeltaQuantity

Integer

Qc fail quantity GRNed in order for the SKU since the last notification to ERP for the order.

Yes

Response

{
    "hasError":false,
    "errorMessage":"message"
}

HttpStatus : 200

  • No labels