API
Manage Incoming Orders
Manage your Catalog of products
SFTP
Manage your Catalog of products
Manage your Promotions
Testing Integration#
Click below to jump to the topics:
Prerequisites for Testing#
In order to test your integration, you’ll need to do the following:#
Have a test user
You must share with your Account Manager an email address you have access to, but that does not already exist in PedidosYa. This email will be used to create a test user so you can view your test store from the PedidosYa mobile app.
Have a test store
Your Account Manager must provide you with the ID, name, and address of your test store.
Have access to the test store in Partner Portal
Your Account Manager must ensure that you have access to the test store in Partner Portal.
Validate your integration
You can test the different functionalities you develop in your test store and see their impact in Partner Portal or in the PedidosYa app.
All testing for this integration is conducted in the live environment. Before creating a promotion, ensure that products you want to promote must be available in the catalog.
How do I perform E2E testing?#
It is important to go through the end-to-end testing process. To ensure a smooth integration, you need to test various scenarios by following these steps.
In order to send requests , please create a Bearer Token in Partner Portal. Please refer to the Token Management & Access Section.
As you send the request to update the product - an asynchronous job will be created in the background, meaning that the job is later sent to the configured webhook.
Creating a Promotion#
Prepare the Request:
Create the API request to create a promotion.
Ensure the request contains valid SKUs and promotion details.
Note!The active field is optional. If not provided, the system will automatically set the promotion as active
Send the Request: When the request is submitted, the status of the promotion will be queued, meaning it is in the process of being created.
Check Promotion Status: Use the GET endpoint to query the status of the promotion and confirm its completion.
Review the Promotion: Validate the promotion in the Vendor Portal or the Platform App to ensure it was successfully created.
Best Practices:#
To minimize operational impact, create promotions for one or two products with a small discount (e.g. a few cents).
Ensure the discounted price is always lower than the original price; otherwise, the promotion will not be created.
Check that the changes are displayed correctly in the store by accessing it through the app.
Modifying a Promotion#
Prepare the Modification Request:
Use the same API request as for the promotions creation.
To remove a SKU, set "active": false at the SKU level.
NoteYou don’t have to add the SKUs that stay active in the request. Just send SKUs you want to remove from the promotion.
Submit the Request: Send the request and ensure the job is processed.
Check the Update Status: Use the GET endpoint to confirm the job was completed.
Validate in the Vendor Portal or by accessing the test store through the app: Verify that the SKU was successfully removed from the promotion.
Deactivating a Promotion#
Prepare the Deactivation Request: Send the same request with "active": false at the campaign level.
Submit the Request: The promotion will be deactivated upon successful processing.
Confirm Deactivation: Use the GET endpoint to ensure the job was completed.
Verify in the Vendor Portal: Confirm that the promotion is no longer active.
If all updates are correctly processed without errors, the integration is ready to go live. You can schedule a meeting here with our Integrations Support team to certify your integration.