GET api/POP

Retrieve pending pop info using specific item code or store

Request Information

URI Parameters

None.

Body Parameters

POPReq
NameDescriptionTypeAdditional information
Company

The company code

string

Required

String length: inclusive between 0 and 6

ItemCode

The item code. Optional: return all items if not given

string

String length: inclusive between 0 and 30

Store

Retrieve only info about the given store. Optional: return all stores if not given

string

String length: inclusive between 0 and 5

Request Formats

application/json, text/json

Sample:
{
  "Company": "EPM",
  "ItemCode": null,
  "Store": null
}

Response Information

Resource Description

POPRes
NameDescriptionTypeAdditional information
msgControl

Message control - Will contain information about the response

MsgControl

None.

items

List of items with their remaining POP quantities

Collection of itemPOP

None.

Response Formats

application/json, text/json

Sample:
{
  "msgControl": {
    "result": 0,
    "Message": "Corresponding success and error message",
    "MethodName": "api/<Request Name>",
    "AppName": "EsoftWebApi",
    "EsoftUser": "Web API",
    "User": "Username",
    "Password": "Password",
    "SystemDate": "2019-12-25T00:00:00",
    "GenList": [],
    "GenMsg1": "",
    "GenMsg2": "",
    "GenMsg3": ""
  },
  "items": [
    {
      "ItemCode": "1010",
      "Store": "001",
      "Quantity": 5,
      "LastDeliveryDate": null
    },
    {
      "ItemCode": "121010",
      "Store": "001",
      "Quantity": 50,
      "LastDeliveryDate": "2021-12-20T00:00:00"
    }
  ]
}