Introduction
API

SFTP

Testing Integration#

Click below to jump to the topics:

In order to test your integration, you’ll need to:#

  1. 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.

  2. Have a test store

    Your Account Manager must provide you with the ID, name, and address of your test store.

  3. 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.

  4. 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.

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.

  1. Single product update using PUT /catalog endpoint
    Modify the request body with sku, price, active, and max_sales_quantity fields

    1. Check the API response as 200

    2. Check your catalog and frontend for changes to the sku

  2. Bulk product updates using PUT /catalog endpoint (recommended to configure webhook to visibility on job logs)

    1. Add multiple SKUs with the product attributes sku, price, active, and max_sales_quantity

    2. Check for API response 202

    3. Async job details are sent to configured webhook, containing downloadURL

    4. Use GET on the downloadURL with the bearer token

    5. Download the logs at sku level

  3. POST /export endpoint

    1. Request with vendor-id

    2. Check for API response 202

    3. Async job details are sent to configured webhook, containing downloadURL

    4. Use GET on the downloadURL with the bearer token

    5. Download the assortment data includes, SKU, price, active, max_sales_quantity fields

  4. GET /categories
    Retrieves list of available vendor categories

  5. GET /catalog
    Contains catalog information in paginated format SKU, translations, product descriptions, image URLs, etc

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.


APIUse Cases - Endpoints ExplainedAPITroubleshooting