Calling the Pull Price Book APIs

Depending on the file you need to receive, you can call the following Pull Price Book Rest APIs:

• To receive the file with price book updates—call the PULL maintenance (pricebook) updates API.
• To receive a certain batch with price book updates—call the PULL maintenance (pricebook) updates API (with the {batchId} prefix).
• To notify CStoreOffice® that the received price book was successfully applied on the CR—call the PUSH maintenance (pricebook) updates upload acknowledgment API.

Calling Pull Price Book Rest APIs for Receiving Price Book Updates

To call the Pull Price Book Rest API for receiving price book updates:

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 Perform accept changes on cr item update manager 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. Click Execute.

   

6. In the Responses section, make the successful message is displayed:

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

  

  For confidentiality reasons, the authorization data is blurred intentionally.

7. Wait until the batch file is generated in CStoreOffice®. It should take about 60 seconds.
8. Call the endpoint for receiving the batch file:
1. In the Cash Register Data Transport API, expand the PULL maintenance (pricebook) updates section (with the {stationId} prefix only, without the {batchId} prefix.
2. Click Try it out.

   

3. In the Parameters section > stationId field, enter your station ID.
4. Click Execute.

   

5. In the Responses section > Response body subsection, make sure the Download file link is displayed. It means that the batch file is received successfully.
6. Click the Download file link and save the batch file in ZIP format.

   

The examples of batches with the cash register files from different cash register types are listed below:

Calling Pull Price Book Rest APIs for Receiving a Certain Batch

To call the Pull Price Book Rest API for receiving a certain batch with price book updates:

1. Check the batch number in CStoreOffice®
1. Open the Accepted PLU Batch Updates report.
2. In the report, find your batch and get its number in the # column.

   

   For more information, see Viewing Accepted PLU Batch Updates.

2. Call the Pull Price Book Rest API with the batch parameter.
1. Go to the Cash Register Integration API by the following the link:
   https://api-docs.petrosoft.cloud/?service=cash_register_service
2. In the Cash Register Data Transport API, expand the PULL maintenance (pricebook) updates section (with the {batchId} prefix.
3. Click Try it out.

   

4. In the Parameters section, enter the following data:

• stationId: Enter your station ID.
• batchId: Enter the batch number you have received from CStoreOffice® in the Accepted PLU Batch Updates report at the step 1.

5. Click Execute.

   

6. In the Responses section > Response body subsection, make sure the Download file link is displayed. It means that the batch file is received successfully.
7. Click the Download file link and save the batch file in ZIP format.

   

Calling Pull Price Book Rest APIs for Acknowledging Applied Price Book Updates

To call the Pull Price Book Rest API for notifying CStoreOffice® that the received price book was successfully applied on the CR:

1. Go to the Cash Register Integration API by the following the link:
   https://api-docs.petrosoft.cloud/?service=cash_register_service
2. In the Cash Register Data Transport API, expand the PUSH maintenance (pricebook) updates upload acknowledgment section.
3. Click Try it out.

   

4. In the Parameters section > stationId field, enter your station ID.
5. Click Execute.

   

6. In the Responses section, make sure the acknowledgment has been pushed successfully:

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

  

7. Make sure there are no items in the Cash Register Updates Manager in the following subsections:

• Changes
• CR Pending