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:
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.
Product updates using PUT
/catalogendpoint (recommended to configure webhook to visibility on job logs)Add multiple SKUs with the product attributes
sku,price,active, andmax_sales_quantityCheck for API response
202Async job details are sent to configured webhook, containing downloadURL
Use GET on the
downloadURLwith the bearer tokenDownload the logs at
skulevel
Create new products at store or chain level using POST
/catalogendpointPrepare the request body with product details, include list of vendors or use wild character( * ) to create products on all vendors at chain level
Check for API response
202Save the
job_idfrom the response
Check the product creation status using GET
/job_idendpointOn successful request check for 200 response with one of the following job statuses
QUEUEDthe job has not yet been processedIN_PROGRESSthe products/items are being added to your outletCOMPLETEDthe job is finishedFAILEDthe job processing failed
POST
/exportendpointRequest with vendor-id
Check for API response 202
Async job details are sent to configured webhook, containing downloadURL
Use GET on the downloadURL with the bearer token
Download the assortment data includes,
SKU,price,active,max_sales_quantityfields
GET
/categories
Retrieves list of available vendor categoriesGET
/catalog
Contains catalog information in paginated format SKU, translations, product descriptions, image URLs, etc