Introduction
API

SFTP

Testing Integration#

Click below to jump to the topics:

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

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

  2. Create new products at store or chain level using POST /catalog endpoint

    1. Prepare the request body with product details, include list of vendors or use wild character( * ) to create products on all vendors at chain level

    2. Check for API response 202

    3. Save the job_id from the response

  3. Check the product creation status using GET /job_id endpoint

    1. On successful request check for 200 response with one of the following job statuses

      1. QUEUED the job has not yet been processed

      2. IN_PROGRESS the products/items are being added to your outlet

      3. COMPLETED the job is finished

      4. FAILED the job processing failed

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

  5. GET /categories
    Retrieves list of available vendor categories

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


APIUse Cases - Endpoints ExplainedAPITroubleshooting