• Gets all the list of the PEZA accredited list of parties.
• The list of parties must be saved or persisted on the subscriber side as a transaction lookup instead of acquiring the list on every request.
• The list should be updated based on version in a timely manner, e.g. every 12 midnight. Read request parameter below.
• NOTE: Must have a valid API KEY to use.

Request Parameters:

fetch(
  https://stage-opceapi.ppa.com.ph/api/opce/GetPartyClientListAsync?ver=2,
  {
    method: "GET",
    headers: {
      "Content-Type": "application/json",
      "Authorization": "Bearer eyJhbGciOiJIUzI1Ni..."
    },
  }
)

JSON Response:

NOTE: The endpoint will emit the JSON record below depending on the version requested. If the version being requested is not equal to the version currently held in PPA server, it will emit JSON Figure A.Otherwise, it will emit a JSON record Figure B.

Figure A

Example Request:

https://stage-opceapi.ppa.com.ph/api/opce/GetPartyClientListAsync?ver=1.00

Below, the JSON property ListOfParties contains all the current updated list of companies. The subscriber client (e.g. ICTSI) must persist the version number on their part for requesting the next available updated list.

Figure B

Example Request:

https://stage-opceapi.ppa.com.ph/api/opce/GetPartyClientListAsync?ver=2.71

Below, the JSON property Below, the JSON property ListOfParties is null or empty because the version list being requested is the same with PPA records.

• Gets all the list of the commodities regardless of who is the party accredited with it.
• The list of commodities must be saved or persisted on the subscriber side as a transaction lookup instead of acquiring the list on every request.
• The list should be updated based on version in a timely manner, e.g. every 12 midnight. Read request parameter below.
• NOTE: Must be authorized or logged-in to use. Must have a valid API KEY to use.

Request Parameters:

fetch(
  https://stage-opceapi.ppa.com.ph/api/opce/GetCommodityListAsync?ver=2,
  {
    method: "GET",
    headers: {
      "Content-Type": "application/json",
      "Authorization": "Bearer eyJhbGciOiJIUzI1Ni..."
    },
  }
)

Figure A

Example Request:

https://stage-opceapi.ppa.com.ph/api/opce/GetCommodityListAsync?ver=1.00

Below, the JSON property OpceMasterDetailCommodities contains all the current updated list of commodities in master-id parent format. The subscriber client (e.g. ICTSI) must persist the version number on their part for requesting the next available updated list.

The fields:

• ATTRIBUTE1 - may contain "A" or "E". Meaning Added or Edited respectively.
• ATTRIBUTE2 - contains the Party or customer ID and useful when mapping commodity and party info in look-ups or other display information.
• ATTRIBUTE3 - contains the proprietary or internal company item code, if specified.
• ATTRIBUTE4 - system reserved.
• COMMODITY_LST_LST_CODE - is the parent of each commodity code on a 2 to 3 level parent-child nesting. reserved.
• POST_FLAG - internal use for PPA.
• STATUS - "A" means the commodity is currently being carried. "I" means a commodity is inactive or already retired.

Figure B

Example Request:

https://stage-opceapi.ppa.com.ph/api/opce/GetCommodityListAsync?ver=9.95

Below, the JSON property Below, the JSON property OpceMasterDetailCommodities is null or empty because the version list being requested is the same with PPA records.

Post a commodity item being requested from a particular party or company for exemption.The order and casing of each field/member must be in order and exact respectively.

Request Parameters (payload)

fetch(
  https://stage-opceapi.ppa.com.ph/api/opce/PostExemptionRequestAsync,
  {
    method: "POST",
    headers: {
      "Content-Type": "application/json",
      "Authorization": "Bearer eyJhbGciOiJIUzI1Ni..."
    },
    body: JSON.stringify(payload),
  }
)

JSON Response:

Post a batch of commodity items being requested from a particular party or company for exemption. The order and casing of each field/member must be in order and exact respectively.

Request Parameters (payload):

Definition of OpceCommodityDto

fetch(
  https://stage-opceapi.ppa.com.ph/api/opce/PostBatchExemptionRequestAsync,
  {
    method: "POST",
    headers: {
      "Content-Type": "application/json",
      "Authorization": "Bearer eyJhbGciOiJIUzI1Ni..."
    },
    body: JSON.stringify(payload),
  }
)

Sample JSON Response:

NOTES:

Should there be expired commodities inside the batch request, the CommodityListReponse, each REQ_REMARK_CODE will contain the value X1 which stands for COMMODITY IS EXPIRED.

The ATTRIBUTE5 of the response will also contain the effectivity date from and to, both in dates formats.

            REQ_REMARK_CODE": "X1",
            "REQ_PPA_REMARKS": "COMMODITY IS EXPIRED - PPA-UNC-0006299 | DEV - DESERTHILL LOGISTICS AND TERMINAL SERVICES INC. | TEST",
            "REQ_STATUS_ID": 0,
            "ATTRIBUTE1": "DEV - DESERTHILL LOGISTICS AND TERMINAL SERVICES INC.",
            "ATTRIBUTE2": "SVR-PTM-0:00:00.000",
            "ATTRIBUTE3": "SVR-DPRTR-16:25:01.044",
            "ATTRIBUTE4": "ip-addr",
            "ATTRIBUTE5": {
              "COMM_EFF_DT_FROM": "2020-11-14T07:25:31.215Z",
              "COMM_EFF_DT_TO": "2024-11-14T07:25:31.215Z"
            },,

Gets the version changes history of either commodity or the party/customer such as name modifications, additions, deletions, others.

• Emmits JSON List records.
• Acquires the last 800 changes or modifications only.

Request Parameters:

fetch(
  https://stage-opceapi.ppa.com.ph/api/opce/GetVerChanges?t=,
  {
    method: "GET",
    headers: {
      "Content-Type": "application/json",
      "Authorization": "Bearer eyJhbGciOiJIUzI1Ni..."
    },
  }
)

JSON Response: