API INtergratioin
INTERFACE DEFINATION
INBOUND ORDER
SERVICE TITLE |
INBOUND ORDER - 01 |
|||
SERVICE PURPOSE |
SAP will call WMS Inbound Order API & create new Inbound order in the system(Purchase Order) |
|||
METHOD |
POST |
|||
CLIENT |
SAP |
|||
INPUT PARAMETER |
PARAMETER |
DATA TYPE |
MANDATORY/OPTIONAL |
REMARK |
OrderReferenceNo |
String |
Mandatory |
Unique Order No |
|
WarehouseCode |
String |
Mandatory |
Warehouse Code for which order is. |
|
SKUCode |
String |
Mandatory |
Sku code in order |
|
Quantity |
Decimal |
Mandatory |
Order Quantity of SKU |
|
UOM |
String |
Mandatory |
Unit of Measurement of SKU |
|
OrderDate |
Date |
Mandatory |
Order Date |
|
DeliveryDate |
Date |
Mandatory |
Delivery date of order |
|
VendorCode |
String |
Mandatory |
Vendor code from whom order receive |
|
ContainerID |
String |
Optional |
|
|
Trailer |
String |
Optional |
|
|
Seal |
String |
Optional |
|
|
STATUS CODE |
STATUS CODE |
DESCRIPTION |
||
100 |
Order Saved Successfully |
|||
101 |
Invalid Parameters |
|||
102 |
Some Error Occurred |
|||
JSON Request |
REQUEST🡺 { “InboundOrder”: [ { “OrderReferenceNo”:” Order01Jan2021-01”, “WarehouseCode”:” WH-01”, “OrderDate”: ”01-Jan-2021”, “DeliveryDate”: “02-Jan-2021”, “VendorCode”: “Vendor01”, “ContainerID”: “Container-001”, “Trailer”: “Trailer001”, “Seal”:” Seal-002” “SKUDetails”: [ { “SKUCode”: “SKUCode01”, “Quantity”: “10.00”, “UOM”: “Kg”, “Location”:”Loc1” },{ “SKUCode”: “SKUCode02”, “Quantity”: “10.00”, “UOM”: “Kg”, “Location”:”Loc1” },{ “SKUCode”: “SKUCode03”, “Quantity”: “10.00”, “UOM”:”Kg”, “Location”:”Loc1” },{ “SKUCode”: “SKUCode04”, “Quantity”: “10.00”, “UOM”: “Kg”, “Location”:”Loc1” } ] }, { “OrderReferenceNo”:” Order01Jan2021-02”, “WarehouseCode”:” WH-01”, “OrderDate”: ”01-Jan-2021”, “DeliveryDate”: “02-Jan-2021”, “VendorCode”: “Vendor01”, “ContainerID”: “Container-001”, “Trailer”: “Trailer001”, “Seal”:” Seal-002” “SKUDetails”:[ { “SKUCode”: “SKUCode06”, “Quantity”: “10.00”, “UOM”: “Kg”, “Location”:”Loc1” },{ “SKUCode”: “SKUCode07”, “Quantity”: “10.00”, “UOM”: “Kg”, “Location”:”Loc1” },{ “SKUCode”: “SKUCode08”, “Quantity”: “10.00”, “UOM”: “Kg”, “Location”:”Loc1” },{ “SKUCode”: “SKUCode09”, “Quantity”: “10.00”, “UOM”: “Kg”, “Location”:”Loc1” } ] }] } RESPONSE🡺 { “SaveInboundOrderStatus” { “OrderNo”:”45632”, “StatusCode”:”100”, “Description”:” Order Saved Successfully” } } |
OUTBOUND ORDER
SERVICE TITLE |
OUTBOUND ORDER - 02 |
|||
SERVICE PURPOSE |
OMS TO CREATE BATCH FROM SAP DATA and CALL WMS OUTBOUND ORDER SERVICE TO CREATE OUTBOUND ORDER (SALES ORDER) |
|||
METHOD |
POST |
|||
CLIENT |
SAP |
|||
INPUT PARAMETER |
PARAMETER |
DATA TYPE |
MANDATORY/OPTIONAL |
REMARK |
OrderNumber |
String |
Mandatory |
Unique ref. Order No |
|
WarehouseCode |
String |
Mandatory |
Warehouse Code. |
|
SKUCode |
String |
Mandatory |
Sku code in order |
|
Quantity |
Decimal |
Mandatory |
Order Quantity of SKU |
|
UOM |
String |
Mandatory |
Unit of Measurement of SKU |
|
OrderDate |
Date |
Mandatory |
Order Date |
|
DeliveryDate |
Date |
Mandatory |
Exp.Delivery date of order |
|
ClientCode |
String |
Mandatory |
Client code to whom order send |
|
ClientName |
String |
Mandatory |
Name of Client |
|
ClientEmailID |
String |
Mandatory |
Email ID of Client |
|
ClientMobileNo |
String |
Mandatory |
Client Mobile Number |
|
Shipping Address |
|
|
|
|
AddressLine |
String |
Mandatory |
Address |
|
Country |
String |
Mandatory |
Country |
|
State |
String |
Mandatory |
State |
|
City |
String |
Mandatory |
City |
|
Pincode |
Number |
Mandatory |
Pin Code of Address |
|
Billing Address |
|
|
|
|
AddressLine |
String |
Mandatory |
Address |
|
Country |
String |
Mandatory |
Country |
|
State |
String |
Mandatory |
State |
|
City |
String |
Mandatory |
City |
|
Pincode |
Number |
Mandatory |
Pin Code of Address |
|
STATUS CODE |
DESCRIPTION |
|
|
|
100 |
Order Saved Successfully |
|
|
|
STATUS CODE |
101 |
Invalid Parameters |
||
102 |
Some Error Occurred |
|||
REQUEST🡺 { “OutboundOrder”: [ { “OrderNumber”:” Order01Jan2021-01”, “WarehouseCode”:” WH-01”, “OrderDate”: ”01-Jan-2021”, “DeliveryDate”: “02-Jan-2021”, “ClinetCode”: “ClientCode001”, “ClientName”:”ClientName1”, “ClientEmailID”:”client@abc.com”, “ClientMobileNo”: “9090909090”, “ShippingAddress”: { “AddressLine”:” Near Kothrud Stand”, “Country”:” India”, “State”:” Maharashtra”, “City”: “Pune”, “Pincode”: “411038” } , “BillingAddress”: { “AddressLine”:” Near Kothrud Stand”, “Country”:” India”, “State”:” Maharashtra”, “City”: “Pune”, “Pincode”: “411038” }, “SKUDetails”:[ { “SKUCode”: “SKUCode01”, “Quantity”: “10.00”, “UOM”: “Kg”, “Location”: “Loc-1” },{ “SKUCode”: “SKUCode02”, “Quantity”: “10.00”, “UOM”: “Kg”, “Location”: “Loc-1” },{ “SKUCode”: “SKUCode03”, “Quantity”: “10.00”, “UOM”:”kg”, “Location”: “Loc-1” },{ “SKUCode”: “SKUCode04”, “Quantity”: “10.00”, “UOM”: “Kg”, “Location”: “Loc-1” } ] }, { “OrderNumber”:” Order01Jan2021-02”, “WarehouseCode”:” WH-01”, “OrderDate”: ”01-Jan-2021”, “DeliveryDate”: “02-Jan-2021”, “CLinetCode”: “ClientCode002”, “ClinetCode”: “ClientCode002”, “ClientName”:” ClientName2”, “ClientEmailID”: ”client2@abc.com”, “ClientMobileNo”: “9191919191”, “ShippingAddress”: { “AddressLine”:” Near Karve Nagar”, “Country”:” India”, “State”:” Maharashtra”, “City”: “Pune”, “Pincode”: “411038” }, “BillingAddress”: { “AddressLine”:” Near Kothrud Stand”, “Country”:” India”, “State”:” Maharashtra”, “City”: “Pune”, “Pincode”: “411038” } , “SKUDetails”:[ { “SKUCode”: “SKUCode06”, “Quantity”: “10.00”, “UOM”: “Kg”, “Location”: “Loc-1” },{ “SKUCode”: “SKUCode07”, “Quantity”: “10.00”, “UOM”: “Kg”, “Location”: “Loc-1” },{ “SKUCode”: “SKUCode08”, “Quantity”: “10.00”, “UOM”: “Kg”, “Location”: “Loc-1” },{ “SKUCode”: “SKUCode09”, “Quantity”: “10.00”, “UOM”: “Kg”, “Location”: “Loc-1” } ] }] } RESPONSE🡺 { “SaveOutboundOrderStatus” { “StatusCode”:”100”, “Description”:” Order Saved Successfully” } } |
||||
|
||||
JSON Request |
|
Client Master
SERVICE TITLE |
Client Master |
|||
SERVICE PURPOSE |
ADD / EDIT SKU DETAIL IN WMS |
|||
METHOD |
POST |
|||
CLIENT |
SAP |
|||
INPUT PARAMETER |
PARAMETER |
DATA TYPE |
MANDATORY/OPTIONAL |
REMARK |
ClientCode |
String |
Mandatory |
Unique Clientcode |
|
ClientName |
String |
Mandatory |
Name of Client |
|
Ledger Number |
String |
Mandatory |
Unique Number |
|
ClientEmailID |
String |
Mandatory |
Email ID of Client |
|
ClientMobileNo |
String |
Mandatory |
Client Mobile Number |
|
Shipping Address |
|
|
|
|
AddressLine |
String |
Mandatory |
Address |
|
Country |
String |
Mandatory |
Country |
|
State |
String |
Mandatory |
State |
|
City |
String |
Mandatory |
City |
|
Pincode |
Number |
Mandatory |
Pin Code of Address |
|
Billing Address |
|
|
|
|
AddressLine |
String |
Mandatory |
Address |
|
Country |
String |
Mandatory |
Country |
|
State |
String |
Mandatory |
State |
|
City |
String |
Mandatory |
City |
|
Pincode |
Number |
Mandatory |
Pin Code of Address |
|
STATUS CODE |
DESCRIPTION |
|
|
|
100 |
Order Saved Successfully |
|
|
|
STATUS CODE |
101 |
Invalid Parameters |
||
102 |
Some Error Occurred |
|||
REQUEST🡺 { “Clientmaster”: [ { “ClinetCode”: “ClientCode001”, “ClientName”:”ClientName1”, “Ledgernumber”:”129999”, “ClientEmailID”:”client@abc.com”, “ClientMobileNo”: “9090909090”, “ShippingAddress”: { “AddressLine”:” Near Kothrud Stand”, “Country”:” India”, “State”:” Maharashtra”, “City”: “Pune”, “Pincode”: “411038” } , “BillingAddress”: { “AddressLine”:” Near Kothrud Stand”, “Country”:” India”, “State”:” Maharashtra”, “City”: “Pune”, “Pincode”: “411038” }, RESPONSE🡺 { “SaveClientStatus” { “StatusCode”:”100”, “Description”:” Client Saved Successfully” } } |
||||
|
||||
JSON Request |
|
VENDOR Master
SERVICE TITLE |
Vendor Master |
|||
SERVICE PURPOSE |
ADD / EDIT SKU DETAIL IN WMS |
|||
METHOD |
POST |
|||
CLIENT |
SAP |
|||
INPUT PARAMETER |
PARAMETER |
DATA TYPE |
MANDATORY/OPTIONAL |
REMARK |
VendorCode |
String |
Mandatory |
Unique Vendorcode |
|
VendorName |
String |
Mandatory |
Name of the Vendor |
|
VendorType |
String |
Mandatory |
Transporter, supplier ,etc |
|
Vendorledgernumber |
String |
Mandatory |
Unique Number |
|
Address |
String |
Mandatory |
Vendor address |
|
STATUS CODE |
DESCRIPTION |
|
|
|
100 |
Order Saved Successfully |
|
|
|
STATUS CODE |
101 |
Invalid Parameters |
||
102 |
Some Error Occurred |
|||
REQUEST🡺 { “Clientmaster”: [ { “VendorCode”: “VendorCode001”, “ClientName”:”VendorName1”, “Vendortype”:”Transporter”, “VendorLedgernumber”:”129999”, “Address”: { “Address”:” Near Kothrud Stand”, “Country”:” India”, “State”:” Maharashtra”, “City”: “Pune”, “Pincode”: “411038” } , RESPONSE🡺 { “SaveVendorStatus” { “StatusCode”:”100”, “Description”:” Vendor Saved Successfully” } } |
||||
|
||||
JSON Request |
|
SKU MASTER
SERVICE TITLE |
SKU MASTER – 04 |
||||
SERVICE PURPOSE |
ADD / EDIT SKU DETAIL IN WMS |
||||
METHOD |
POST |
||||
CLIENT |
SAP |
||||
INPUT PARAMETER |
PARAMETER |
DATA TYPE |
MANDATORY/OPTIONAL |
REMARK |
|
SKUCode |
String |
Mandatory |
Sku Code |
|
|
SKUName |
String |
Mandatory |
SKU Name |
|
|
Description |
String |
Mandatory |
Description |
|
|
Category |
String |
Mandatory |
Sku Category |
|
|
SubCategory |
String |
Mandatory |
Sub Category |
|
|
AliasSKUCode |
String |
Mandatory |
Alias SKU Code |
|
|
Price |
Decimal (18,2) |
Optional |
SKU Price |
|
|
PickingMethod |
String |
Mandatory |
Picking Method (FIFO, LIFO, Expiry Wise) |
|
|
UPCBarcode |
String |
Mandatory |
UPC Barcode |
|
|
HSNCode |
String |
Optional |
HSN Code |
|
|
Brand |
String |
Optional |
Sku Brand |
|
|
ISExpirable |
True/False |
Mandatory |
IS Sku Expirable |
|
|
Lottable1 |
String |
Optional |
Lottable name of SKU |
|
|
UOM1Name |
String |
Mandatory |
UOM Name |
|
|
UOM1Quantity |
Number |
Mandatory |
UOM Quantity |
|
|
UOM2Name |
String |
Optional |
|
|
|
UOM2Quantity |
Number |
Optional |
|
|
|
UOM3Name |
String |
Optional |
|
|
|
UOM3Quantity |
Number |
Optional |
|
|
|
Height |
Number |
Optional |
Height |
|
|
Width |
Number |
Optional |
Width |
|
|
Length |
Number |
Optional |
Length |
|
|
Weight |
Number |
Optional |
Weight |
|
|
TotalShelfLife |
Number |
Optional |
Total Shelf Life of SKU |
|
|
OutboundShelfLife |
Number |
Optional |
Outbound Shelf life of SKU |
|
|
STATUS CODE |
STATUS CODE |
DESCRIPTION |
|
||
100 |
SKU Saved Successfully |
|
|||
101 |
Invalid Parameters |
|
|||
102 |
Some Error Occurred |
|
|||
JSON Request |
REQUEST🡺 { “SKUDetails”: [ { “SKUCode”:” SKU001”, “SKUName”:”SKU Name”, “Description”:” SKU001”, “Category”:” Foods”, “SubCategory”: “Foods”, “AliasSKUCode”: “SKU001”, “Price”: “10.00”, “PickingMethod”:” ExpiryWise”, “UPCBarcode”:” SKU001”, “HSNCode”:” SKU001”, “Brand”:” Brand1”, “ISExpirable”:” True”, “Lottable1”:” Expiry Date”, “UOM1Name”:” Each”, “UOM1Quantity”:”1”, “UOM2Name”:” Dozen”, “UOM2Quantity”:”12”, “UOM3Name”:” Box”, “UOM3Quantity”:”34”, “Height”:”1.00”, “Width”:”2.00”, “Length”:”3.00”, “Weight”:”4.00”, “TotalShelfLife”:”100”, “OutboundShelfLife”:” 50” }, { “SKUCode”:” SKU002”, “SKUName”:”SKU Name”, “Description”:” SKU002”, “Category”:” Foods”, “SubCategory”: “Foods”, “AliasSKUCode”: “SKU002”, “Price”: “10.00”, “PickingMethod”:” ExpiryWise”, “UPCBarcode”:” SKU002”, “HSNCode”:””, “Brand”:””, “ISExpirable”:” True”, “Lottable1”:” Expiry Date”, “Lottable2”:” MFG Date”, “UOM1Name”:” Each”, “UOM1Quantity”:”1”, “UOM2Name”:” Dozen”, “UOM2Quantity”:”12”, “UOM3Name”:” Box”, “UOM3Quantity”:”34”, “Height”:”1.00”, “Width”:”2.00”, “Length”:”3.00”, “Weight”:”4.00”, “TotalShelfLife”:”100”, “OutboundShelfLife”:” 50” } }] } RESPONSE🡺 { “SaveSKUStatus” { “StatusCode”:”100”, “Description”:” SKU Saved Successfully” } } |
WAREHOUSE TO WAREHOUSE TRANSFER SERVICE
SERVICE TITLE |
Warehouse to Warehouse Transfer - 05 |
|
|||
SERVICE PURPOSE |
SAP TO CALL WMS W2W TRANSFER SERVICE FOR TRANSFERING STOCK ACROSS WAREHOUSE MANAGED BY WMS |
|
|||
METHOD |
POST |
|
|||
CLIENT |
SAP |
||||
INPUT PARAMETER |
PARAMETER |
DATA TYPE |
MANDATORY/OPTIONAL |
REMARK |
|
OrderReferenceNo |
String |
Mandatory |
Unique Order No |
|
|
FromWarehouseCode |
String |
Mandatory |
From Warehouse Code |
|
|
ToWarehouseCode |
String |
Mandatory |
To Warehouse Code |
|
|
CustomerCode |
String |
Mandatory |
Customer Code |
|
|
SKUCode |
String |
Mandatory |
Sku code in order |
|
|
Quantity |
Decimal |
Mandatory |
Order Quantity of SKU |
|
|
UOM |
String |
Mandatory |
Unit of Measurement of SKU |
|
|
Sequence |
Int |
Mandatory |
Sequence of product in order |
|
|
TransferDate |
Date |
Mandatory |
Transfer Date |
|
|
DeliveryDate |
Date |
Mandatory |
Delivery date of order |
|
|
STATUS CODE |
STATUS CODE |
DESCRIPTION |
|
||
100 |
Transfer Saved Successfully |
|
|||
101 |
Invalid Parameters |
|
|||
102 |
Some Error Occurred |
|
|||
JSON Request |
REQUEST🡺 { “TransferOrder”: [ { “OrderReferenceNo”:” Transfer01Jan2021-01”, “FromWarehouseCode”:” WH-01”, “ToWarehouseCode”:” WH-02”, “CustomerCode”: “Customer01”, “TransferDate”: ”01-Jan-2021”, “DeliveryDate”: “02-Jan-2021”, “SKUDetails”:[ { “SKUCode”: “SKUCode01”, “Quantity”: “10.00”, “UOM”: “Kg”, “Sequence”:1 },{ “SKUCode”: “SKUCode02”, “Quantity”: “10.00”, “UOM”: “Kg”, “Sequence”:2 },{ “SKUCode”: “SKUCode03”, “Quantity”: “10.00”, “UOM”:”kg”, “Sequence”:3 },{ “SKUCode”: “SKUCode04”, “Quantity”: “10.00”, “UOM”: “Kg”, “Sequence”:4 } ] }, { “OrderReferenceNo”:” Transfer01Jan2021-02”, “FromWarehouseCode”:” WH-01”, “ToWarehouseCode”:” WH-02”, “CustomerCode”: “Customer01”, “TransferDate”: ”01-Jan-2021”, “DeliveryDate”: “02-Jan-2021”, “SKUDetails”:[ { “SKUCode”: “SKUCode06”, “Quantity”: “10.00”, “UOM”: “Kg”, “Sequence”:1 },{ “SKUCode”: “SKUCode07”, “Quantity”: “10.00”, “UOM”: “Kg”, “Sequence”:2 },{ “SKUCode”: “SKUCode08”, “Quantity”: “10.00”, “UOM”: “Kg”, “Sequence”:3 },{ “SKUCode”: “SKUCode09”, “Quantity”: “10.00”, “UOM”: “Kg”, “Sequence”:4 } }] } RESPONSE🡺 { “SaveTransferOrderStatus” { “StatusCode”:”100”, “Description”:” Transfer Saved Successfully” } } |
|
SALES RETURN SERVICE
SERVICE TITLE |
SALES RETURN |
|||
SERVICE PURPOSE |
SAP will call WMS SALES RETURN API & create new SALES RETURN order in the system |
|||
METHOD |
POST |
|||
CLIENT |
SAP |
|||
INPUT PARAMETER |
PARAMETER |
DATA TYPE |
MANDATORY/OPTIONAL |
REMARK |
OrderReferenceNo |
String |
Mandatory |
Unique Order No |
|
WarehouseCode |
String |
Mandatory |
Warehouse Code for which return order is received. |
|
SKUCode |
String |
Mandatory |
Sku code in order |
|
Quantity |
Decimal |
Mandatory |
Return Order Quantity of SKU |
|
UOM |
String |
Mandatory |
Unit of Measurement of SKU |
|
ReturnDate |
Date |
Mandatory |
Return Date |
|
ClientCode |
String |
Mandatory |
client code from whom order returned |
|
ContainerID |
String |
Optional |
|
|
Trailer |
String |
Optional |
|
|
Seal |
String |
Optional |
|
|
STATUS CODE |
STATUS CODE |
DESCRIPTION |
||
100 |
Order Saved Successfully |
|||
101 |
Invalid Parameters |
|||
102 |
Some Error Occurred |
|||
JSON Request |
REQUEST🡺 { “SalesReturnOrder”: [ { “OrderReferenceNo”:” Order01Jan2021-01”, “WarehouseCode”:” WH-01”, “ReturnDate”: ”01-Jan-2021”, “ClientCode”: “Vendor01”, “ContainerID”: “Container-001”, “Trailer”: “Trailer001”, “Seal”:” Seal-002” “SKUDetails”: [ { “SKUCode”: “SKUCode01”, “Quantity”: “10.00”, “UOM”: “Kg” },{ “SKUCode”: “SKUCode02”, “Quantity”: “10.00”, “UOM”: “Kg” },{ “SKUCode”: “SKUCode03”, “Quantity”: “10.00”, “UOM”:” Kg” },{ “SKUCode”: “SKUCode04”, “Quantity”: “10.00”, “UOM”: “Kg” } ] }, { “OrderReferenceNo”:” Order01Jan2021-02”, “WarehouseCode”:” WH-01”, “ReturnDate”: ”01-Jan-2021”, “ClientCode”: “Vendor01”, “ContainerID”: “Container-001”, “Trailer”: “Trailer001”, “Seal”:” Seal-002” “SKUDetails”:[ { “SKUCode”: “SKUCode06”, “Quantity”: “10.00”, “UOM”: “Kg” },{ “SKUCode”: “SKUCode07”, “Quantity”: “10.00”, “UOM”: “Kg” },{ “SKUCode”: “SKUCode08”, “Quantity”: “10.00”, “UOM”: “Kg” },{ “SKUCode”: “SKUCode09”, “Quantity”: “10.00”, “UOM”: “Kg” } ] }] } RESPONSE🡺 { “SaveSalesReturnOrderStatus” { “OrderNo”:”45632”, “StatusCode”:”100”, “Description”:” Order Saved Successfully” } } |
PURCHASE RETURN SERVICE
SERVICE TITLE |
PURCHASE RETURN |
|||
SERVICE PURPOSE |
SAP will call WMS PURCHASE RETURN API & create new PURCHASE RETURN order in the system |
|||
METHOD |
POST |
|||
CLIENT |
SAP |
|||
INPUT PARAMETER |
PARAMETER |
DATA TYPE |
MANDATORY/OPTIONAL |
REMARK |
OrderReferenceNo |
String |
Mandatory |
Unique Order No |
|
WarehouseCode |
String |
Mandatory |
Warehouse Code for which order is RETURN From. |
|
SKUCode |
String |
Mandatory |
Sku code in order |
|
Quantity |
Decimal |
Mandatory |
Return Order Quantity of SKU |
|
UOM |
String |
Mandatory |
Unit of Measurement of SKU |
|
ReturnDate |
Date |
Mandatory |
Return Date |
|
VendorCode |
String |
Mandatory |
Vendor code to whom order sent. |
|
Shipping Address |
|
|
|
|
AddressLine |
String |
Mandatory |
Address |
|
Country |
String |
Mandatory |
Country |
|
State |
String |
Mandatory |
State |
|
City |
String |
Mandatory |
City |
|
Pincode |
Number |
Mandatory |
Pin Code of Address |
|
Billing Address |
|
|
|
|
AddressLine |
String |
Mandatory |
Address |
|
Country |
String |
Mandatory |
Country |
|
State |
String |
Mandatory |
State |
|
City |
String |
Mandatory |
City |
|
Pincode |
Number |
Mandatory |
Pin Code of Address |
|
STATUS CODE |
STATUS CODE |
DESCRIPTION |
||
100 |
Order Saved Successfully |
|||
101 |
Invalid Parameters |
|||
102 |
Some Error Occurred |
|||
JSON Request |
REQUEST🡺 { “PurchaseReturnOrder”: [ { “OrderReferenceNo”:” Order01Jan2021-01”, “WarehouseCode”:” WH-01”, “ReturnDate”: ”01-Jan-2021”, “VendorCode”: “Vendor01”, “ShippingAddress”: { “AddressLine”:” Near Kothrud Stand”, “Country”:” India”, “State”:” Maharashtra”, “City”: “Pune”, “Pincode”: “411038” } , “BillingAddress”: { “AddressLine”:” Near Kothrud Stand”, “Country”:” India”, “State”:” Maharashtra”, “City”: “Pune”, “Pincode”: “411038” }, “SKUDetails”: [ { “SKUCode”: “SKUCode01”, “Quantity”: “10.00”, “UOM”: “Kg” },{ “SKUCode”: “SKUCode02”, “Quantity”: “10.00”, “UOM”: “Kg” },{ “SKUCode”: “SKUCode03”, “Quantity”: “10.00”, “UOM”:”Kg” },{ “SKUCode”: “SKUCode04”, “Quantity”: “10.00”, “UOM”: “Kg” } ] }, { “OrderReferenceNo”:” Order01Jan2021-02”, “WarehouseCode”:” WH-01”, “OrderDate”: ”01-Jan-2021”, “DeliveryDate”: “02-Jan-2021”, “VendorCode”: “Vendor01”, “ShippingAddress”: { “AddressLine”:” Near Kothrud Stand”, “Country”:” India”, “State”:” Maharashtra”, “City”: “Pune”, “Pincode”: “411038” } , “BillingAddress”: { “AddressLine”:” Near Kothrud Stand”, “Country”:” India”, “State”:” Maharashtra”, “City”: “Pune”, “Pincode”: “411038” }, “SKUDetails”:[ { “SKUCode”: “SKUCode06”, “Quantity”: “10.00”, “UOM”: “Kg” },{ “SKUCode”: “SKUCode07”, “Quantity”: “10.00”, “UOM”: “Kg” },{ “SKUCode”: “SKUCode08”, “Quantity”: “10.00”, “UOM”: “Kg” },{ “SKUCode”: “SKUCode09”, “Quantity”: “10.00”, “UOM”: “Kg” } ] }] } RESPONSE🡺 { “SavePurchaseReturnOrderStatus” { “OrderNo”:”45632”, “StatusCode”:”100”, “Description”:” Order Saved Successfully” } } |
PRODUCTION ORDER SERVICE
SERVICE TITLE |
Production Order service |
|
|||
SERVICE PURPOSE |
SAP TO CALL WMS W2W TRANSFER SERVICE FOR TRANSFERING STOCK ACROSS WAREHOUSE MANAGED BY WMS |
|
|||
METHOD |
POST |
|
|||
CLIENT |
SAP |
||||
INPUT PARAMETER |
PARAMETER |
DATA TYPE |
MANDATORY/OPTIONAL |
REMARK |
|
OrderReferenceNo |
String |
Mandatory |
Unique Order No |
|
|
FromWarehouseCode |
String |
Mandatory |
From Warehouse Code |
|
|
ToWarehouseCode |
String |
Mandatory |
To Warehouse Code |
|
|
CustomerCode |
String |
Mandatory |
Customer Code |
|
|
SKUCode |
String |
Mandatory |
Sku code in order |
|
|
Quantity |
Decimal |
Mandatory |
Order Quantity of SKU |
|
|
UOM |
String |
Mandatory |
Unit of Measurement of SKU |
|
|
Sequence |
Int |
Mandatory |
Sequence of product in order |
|
|
TransferDate |
Date |
Mandatory |
Transfer Date |
|
|
DeliveryDate |
Date |
Mandatory |
Delivery date of order |
|
|
STATUS CODE |
STATUS CODE |
DESCRIPTION |
|
||
100 |
Transfer Saved Successfully |
|
|||
101 |
Invalid Parameters |
|
|||
102 |
Some Error Occurred |
|
|||
JSON Request |
REQUEST🡺 { “TransferOrder”: [ { “OrderReferenceNo”:” Transfer01Jan2021-01”, “FromWarehouseCode”:” WH-01”, “ToWarehouseCode”:” WH-02”, “CustomerCode”: “Customer01”, “TransferDate”: ”01-Jan-2021”, “DeliveryDate”: “02-Jan-2021”, “SKUDetails”:[ { “SKUCode”: “SKUCode01”, “Quantity”: “10.00”, “UOM”: “Kg”, “Sequence”:1 },{ “SKUCode”: “SKUCode02”, “Quantity”: “10.00”, “UOM”: “Kg”, “Sequence”:2 },{ “SKUCode”: “SKUCode03”, “Quantity”: “10.00”, “UOM”:”kg”, “Sequence”:3 },{ “SKUCode”: “SKUCode04”, “Quantity”: “10.00”, “UOM”: “Kg”, “Sequence”:4 } ] }, { “OrderReferenceNo”:” Transfer01Jan2021-02”, “FromWarehouseCode”:” WH-01”, “ToWarehouseCode”:” WH-02”, “CustomerCode”: “Customer01”, “TransferDate”: ”01-Jan-2021”, “DeliveryDate”: “02-Jan-2021”, “SKUDetails”:[ { “SKUCode”: “SKUCode06”, “Quantity”: “10.00”, “UOM”: “Kg”, “Sequence”:1 },{ “SKUCode”: “SKUCode07”, “Quantity”: “10.00”, “UOM”: “Kg”, “Sequence”:2 },{ “SKUCode”: “SKUCode08”, “Quantity”: “10.00”, “UOM”: “Kg”, “Sequence”:3 },{ “SKUCode”: “SKUCode09”, “Quantity”: “10.00”, “UOM”: “Kg”, “Sequence”:4 } }] } RESPONSE🡺 { “SaveTransferOrderStatus” { “StatusCode”:”100”, “Description”:” Transfer Saved Successfully” } } |
|
STOCK OF THE WAREHOUSE SERVICE
SERVICE TITLE |
SKU STOCK OF THE WAREHOUSE |
|||
SERVICE PURPOSE |
WMS TO OFFER THIS SERVICE FOR GIVING SKU AVAILABLE STOCK IN WMS |
|||
METHOD |
POST |
|||
CLIENT |
SAP |
|||
INPUT PARAMETER |
PARAMETER |
DATA TYPE |
MANDATORY/OPTIONAL |
REMARK |
SKUCode |
String |
Mandatory |
Single Sku Code |
|
WarehouseCode |
String |
Mandatory |
Warehouse Code for which order is. |
|
CustomerCode |
String |
Optional |
Customer Code |
|
OUTPUT PARAMETER |
PARAMETER |
DATA TYPE |
MANDATORY/OPTIONAL |
REMARK |
SKUCode |
String |
Mandatory |
Sku Code |
|
Reserve Stock |
Number |
Mandatory |
Reserved Balance |
|
ClosingBalance |
Number |
Mandatory |
Closing Balance of Day |
|
JSON Request |
REQUEST🡺 { "Skustockrequest": { "Warehousecode": "2001", "SKUCode": "SAH-SKU-01, SAH-SKU-01,SAH-SKU-2,REPSKU75,RPLSKU07,SAH-SKU01,SAH-SKU01,SAH-SKU02,SAH-SKU02,500107,500198,500190,500189,SAH-SKU03,SAH-SKU04,SAH-SKU06,SAH-SKU07,SAH-SKU07,SAH001,SAH002", "customerCode": "SARL"
} } RESPONSE🡺 { "GetProductStockResult":[{"Description":"Success", "ReserveStock":592.00, "SKUCode":"SAH-SKU-01", "StatusCode":"000", "Warehousecode":"2001", "availablestock":734.00 }, {"Description":"Success", "ReserveStock":592.00, "SKUCode":"SAH-SKU-01", "StatusCode":"000", "Warehousecode":"2001", "availablestock":734.00 }, {"Description":"Success", "ReserveStock":277.00, "SKUCode":"SAH-SKU-02", "StatusCode":"000", "Warehousecode":"2001", "availablestock":1104.00 }, {"Description":"Success", "ReserveStock":20.00, "SKUCode":"REPSKU75", "StatusCode":"000", "Warehousecode":"2001", "availablestock":501.00 }, {"Description":"Success", "ReserveStock":10.00, "SKUCode":"RPLSKU07", "StatusCode":"000", "Warehousecode":"2001", "availablestock":484.00 }, {"Description":"Success", "ReserveStock":20.00, "SKUCode":"SAH-SKU01", "StatusCode":"000", "Warehousecode":"2001", "availablestock":424.00 }, {"Description":"Success", "ReserveStock":20.00, "SKUCode":"SAH-SKU01", "StatusCode":"000", "Warehousecode":"2001", "availablestock":424.00 }, {"Description":"Success", "ReserveStock":5.00, "SKUCode":"SAH-SKU02", "StatusCode":"000", "Warehousecode":"2001", "availablestock":444.00 }, {"Description":"Success", "ReserveStock":5.00, "SKUCode":"SAH-SKU02", "StatusCode":"000", "Warehousecode":"2001", "availablestock":444.00 }, {"Description":"SKU code not availbale in given warehouse.", "ReserveStock":0, "SKUCode":"500107", "StatusCode":"103", "Warehousecode":"2001", "availablestock":0 }, {"Description":"Success", "ReserveStock":5.00, "SKUCode":"500198", "StatusCode":"000", "Warehousecode":"2001", "availablestock":1312.00 }, {"Description":"Success", "ReserveStock":22.00, "SKUCode":"500190", "StatusCode":"000", "Warehousecode":"2001", "availablestock":397.00 }, {"Description":"Success", "ReserveStock":27.00, "SKUCode":"500189", "StatusCode":"000", "Warehousecode":"2001", "availablestock":319.00 }, {"Description":"Success", "ReserveStock":160.00, "SKUCode":"SAH-SKU03", "StatusCode":"000", "Warehousecode":"2001", "availablestock":54.00 }, {"Description":"Success", "ReserveStock":20.00, "SKUCode":"SAH-SKU04", "StatusCode":"000", "Warehousecode":"2001", "availablestock":179.00 }, {"Description":"Success", "ReserveStock":5.00, "SKUCode":"SAH-SKU06", "StatusCode":"000", "Warehousecode":"2001", "availablestock":75.00 }, {"Description":"Success", "ReserveStock":5.00, "SKUCode":"SAH-SKU07", "StatusCode":"000", "Warehousecode":"2001", "availablestock":117.00 }, {"Description":"Success", "ReserveStock":5.00, "SKUCode":"SAH-SKU07", "StatusCode":"000", "Warehousecode":"2001", "availablestock":117.00 }, {"Description":"Success", "ReserveStock":10.00, "SKUCode":"SAH001", "StatusCode":"000", "Warehousecode":"2001", "availablestock":1087.00 }, {"Description":"Success", "ReserveStock":34.00, "SKUCode":"SAH002", "StatusCode":"000", "Warehousecode":"2001", "availablestock":450.00 }]} |
To be given by Amit S. (SAP Team)
SAP SERVICE - GRN SERVICE
SERVICE TITLE |
GOOD RECIEPT NOTIFICATION - 06 |
|||
SERVICE PURPOSE |
WMS USE THIS SERVICE TO CONFIRM THE RECIEPT OF GOODs |
|||
METHOD |
POST |
|||
CLIENT |
WMS |
|||
INPUT PARAMETER |
Field Name |
Data Type |
Mandatory/Optional |
Remark |
PO Number |
String |
Mandatory |
Purchase order number |
|
GRNId |
String |
Mandatory |
Id of GRNHead |
|
PO QTY |
Decimal |
Mandatory |
Purchase order qty |
|
GRN QTY |
Decimal |
Mandatory |
GRN Quantity |
|
Warehouse Number |
String |
Mandatory |
Unique Code |
|
Customer Number |
String |
Mandatory |
Name of Customer |
|
UserNumber |
String |
Mandatory |
|
|
OUTPUT PARAMETER |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
JSON Request |
REQUEST🡺 { “POnumber”:” Po 10477” “GrnID”:”!2345” “POqty”:” 10.00” “GRNqty”:” 10.00” “warehousenumber”:” WH-01” “CustomerNumber”:”0909” “Userid”:”5203” } |
|||
JSON Response |
|
SAP SERVICE - DISPATCH CONFIRMATION SERVICE
SERVICE TITLE |
DISPATCH CONFIRMATION – SAP - 07 |
|||
SERVICE PURPOSE |
WMS TO CALL SAP SERVICE AND CONFIRM DISPATCH AGAINST TRANSFER ORDER |
|||
METHOD |
POST |
|||
CLIENT |
WMS |
|||
INPUT PARAMETER |
FIELD NAME |
Data Type |
Mandatory/Optional |
Remark |
Orderno |
String |
Mandatory |
Outbound Order number |
|
Orderqty |
Decimal |
Mandatory |
Outbound order quantity |
|
Dispatchqty |
Decimal |
Mandatory |
Dispatch Quantity |
|
Warehousenumber |
String |
Mandatory |
Warehouse code |
|
CustomerNumber |
String |
Mandatory |
Customer code |
|
UserId |
String |
Mandatory |
User-created outbound order |
|
SOID |
INT |
Mandatory |
Outbound order id |
|
OUTPUT PARAMETER |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
JSON Request |
REQUEST🡺 { “Ordernumber”:” WSO 10477” “Orderqty”:” 10.00” “dispatchqty”:” 10.00” “warehousenumber”:” WH-01” “CustomerNumber”:”0909” “Userid”:”5203” “Soid”:”25467” } |
|||
JSON Response |
|
Re-Trigger Service
In Case of ERP interface service is Down then the ERP service needs to send one standard error message as Sever Down then WMS will try to retrigger service 03 times in 10-minute intervals through the schedular and if still service not able to receive success response, then WMS will send an email notification to operation team/Users to manually retrigger the service for order.
In between retrigger attempt if the user wants to cancel retrigger user need to click on the cancel button, then it will stop attempting retrigger for service automatically and send manual retrigger notification to the operation team/Users. Retrigger interval time will be configurable.
Re-Trigger EMAIL NOTIFICATION
WMS to have Options for Re-trigger Manually for Failed Service Call.
A new interface provided under menu to re-trigger order which is failed to automatically retrigger service, this interface will be accessible only for operation user (Super Admin). To retrigger order for service user, need to select single order at a time and click on retrigger service button. User Need to enter Remark/Note before Re-triggering order to service this note will be capture and send in report if manual re-trigger also fails. After successful retrigger it will give success message. Manual retrigger will be single order at a time no need of check box grid has functionality to select order by clicking on it.
Below shown is the Retrigger Screen
Select the Order from the retrigger screen, Submit the remark and then Click on the Retrigger service to retrigger the order as shown below:
Third-Party Service
- We have provided the option for third Party Configuration in the Administrator Menu In tools and Utilites as shown below. Kindly refer the below Screens for Third Party configuration.
1.
2. Here User will find the API for Each Component and also the user can generate API Key from The 'Key ICON'.
3.After Clicking on the Key ICON the API KEY will be generated as shown below:
4.
Webhook:
- Below Shown are the Call back API setup. User can Click on the Action Eye against the EVENT name.
2. After clicking below popup will appear where the details for API configuration is filled as shown :
API log
1.Below shown is the log of Each Component of API for WMS.
2.
SIGN OFF
Project Requirement Sign Off, we hereby agree for the Scope work as listed in the document. Any changes other than above will be treated as Separate Change and will routed through change request flow.
Created with the Personal Edition of HelpNDoc: Create HTML Help, DOC, PDF and print manuals from 1 single source