Push POS Reports APIs

The Push POS Reports API allows you to push the PJR file to your station into CStoreOffice®.

To learn how to use the API, use the sections below:

• Pre-Requisites: Make sure you have prepared all the data required to call the API.
• API Authorization: To be able to call the API, you need to authorize in it.
• Calling the API: Learn the step-by-step procedure on how to call the API.

Pre-Requisites

Before you start calling the Push POS Reports API, make sure the following conditions are met:

• Authorization token: You will need to receive it for getting access to Petrosoft APIs powered by Swagger.
  For more information, see Getting Authorization Data.
• You have prepared the data from CStoreOffice® to be provided to API request:
• Station ID: You can get your station identifier from the Locations list.

  

  For more information, see Setting Up Locations.

• PJR file: Make sure you have prepared the PJR file you need to push to your station in CStoreOffice®.

Authorizing in the Push POS Reports API

To authorize in the Push POS Reports API:

1. Go to the Cash Register Integration API by the following the link:
   https://api-docs.petrosoft.cloud/?service=cash_register_service
2. To the right of the PUSH movement (shift) and POS journal reports section, click the open lock icon.

   

   Result: The Available authorizations window opens.

3. In the Available authorizations window:
1. In the Value field, enter the access token received by your user.
2. Click Authorize.

   

3. Make sure the following elements are displayed which indicate that you have successfully authorized:

• The Authorized status.
• The Logout button.

  

4. Click Close.

The closed lock icon indicates that you are authorized in the API.

Calling Push POS Reports API

To call the Push POS Reports API:

1. Go to the Cash Register Integration API by the following the link:
   https://api-docs.petrosoft.cloud/?service=cash_register_service
2. Expand the PUSH movement (shift) and POS journal reports section.
3. Click the Try it out button, to enable fields in the Parameters section for entering data.

   

4. In the Parameters section > stationId field, enter your station ID.
5. In the Request body section:
1. Click the Add string item button.

   

2. Click Choose File and select the PJR file you need to push to your station in CStoreOffice®.

For more information about the station ID and PJR file, see Pre-Requisites.

6. Click the Execute button.

   

7. In the Responses section, make sure the PJR file has been pushed successfully:

• Server response section > Code field = 200
• Detail section > Response body message:
• status = true
• success = true

  

  For confidentiality reasons, the authorization data is blurred intentionally.