Skip to main content
This guide shows you how to retrieve article details, update articles, manage product images, and search your catalog. After creating articles, you can manage them by updating details, uploading images, searching your catalog, and validating product data. Each article has a unique SKU that identifies it.

​
Prerequisites

Before you start, make sure you have:
All API examples in this guide use ${BASE_URL} as a placeholder. Replace it with the correct base URL configured for the correct environment. For more information see Environments page.

​
Retrieve article details

Retrieve article details using the article ID or article identifier. Use the GET /articles/{sellerId}/{articleId} endpoint to get details by article ID. Use the articleId returned when you created the article.
Use this request to retrieve the full details of an article by its ID:
curl -X GET "${BASE_URL}/articles/<YOUR_SELLER_ID>/<YOUR_ARTICLE_ID>" \
  -H "X-Api-Key: <YOUR_STATIC_API_KEY>" \
  -H "Authorization: <YOUR_SESSION_TOKEN>"
You can also retrieve an article by its identifier using the GET /articles/{sellerId}/identifier/{articleIdentifier} endpoint.

​
Search articles

Search for articles using the GET /articles endpoint. This endpoint supports query, sorting, and pagination parameters. Use the query parameter to filter results, sort to order them, and pageSize to limit the number of results.
Use this request to search for articles using query parameters:
curl -X GET "${BASE_URL}/articles?query=sku:<YOUR_SKU>&sort=created:desc&pageSize=50" \
  -H "X-Api-Key: <YOUR_STATIC_API_KEY>" \
  -H "Authorization: <YOUR_SESSION_TOKEN>"

​
Update an article

Update an existing article using the PUT /articles/{sellerId}/{articleId} endpoint. Provide the fields you want to update in the request body. Include all fields you want to keep, not just the ones you are updating. The request body should contain the complete article data.
Use this request to update an existing article with new information:
curl -X PUT "${BASE_URL}/articles/<YOUR_SELLER_ID>/<YOUR_ARTICLE_ID>" \
  -H "X-Api-Key: <YOUR_STATIC_API_KEY>" \
  -H "Authorization: <YOUR_SESSION_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "sku": "<YOUR_SKU>",
    "name": {
      "value": "<UPDATED_PRODUCT_NAME>",
      "language": "EN"
    },
    "grossWeight": {
      "value": <UPDATED_WEIGHT_VALUE>,
      "unit": "KG"
    }
  }'
Validation: Before updating an article, you can validate your request using the POST /articles/{sellerId}/validate endpoint. This helps catch errors before making changes.

​
Upload product images

You can upload product images to articles using the following endpoints:
  1. POST /articles/{sellerId}/{articleId}/images/upload endpoint - Get an upload URL
  2. Upload the image file to the provided URL
  3. POST /articles/{sellerId}/{articleId}/images endpoint - Store the image information
Request an upload link using the POST /articles/{sellerId}/{articleId}/images/upload endpoint:
Use this request to get an upload URL for a product image:
curl -X POST "${BASE_URL}/articles/<YOUR_SELLER_ID>/<YOUR_ARTICLE_ID>/images/upload?mimeType=image/jpeg" \
  -H "X-Api-Key: <YOUR_STATIC_API_KEY>" \
  -H "Authorization: <YOUR_SESSION_TOKEN>"

​
Step 2: Upload the image

Upload your image file to the uploadUrl using a PUT request:
Use this request to upload the image file to the provided upload URL:
curl -X PUT "<UPLOAD_URL>" \
  -H "Content-Type: image/jpeg" \
  --data-binary "@<PATH_TO_IMAGE_FILE>"
Replace <UPLOAD_URL> with the upload URL from Step 1. Replace <PATH_TO_IMAGE_FILE> with the path to your image file. Set the Content-Type header to match the mime type you specified in Step 1.

​
Step 3: Store image information

After uploading the image, store the image information using the POST /articles/{sellerId}/{articleId}/images endpoint:
Use this request to store the uploaded image information on the article:
curl -X POST "${BASE_URL}/articles/<YOUR_SELLER_ID>/<YOUR_ARTICLE_ID>/images" \
  -H "X-Api-Key: <YOUR_STATIC_API_KEY>" \
  -H "Authorization: <YOUR_SESSION_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "<IMAGE_UPLOAD_ID>"
  }'
Use the id value from Step 1. This is the only required field for storing the image information.

​
Delete an article image

Delete an article image using the DELETE /articles/{sellerId}/{articleId}/images/{uuid} endpoint. Use the image id from the article details.
Use this request to delete an image from an article:
curl -X DELETE "${BASE_URL}/articles/<YOUR_SELLER_ID>/<YOUR_ARTICLE_ID>/images/<IMAGE_ID>" \
  -H "X-Api-Key: <YOUR_STATIC_API_KEY>" \
  -H "Authorization: <YOUR_SESSION_TOKEN>"

​
Validate article data

Validate article data before creating or updating an article. Use the POST /articles/{sellerId}/validate endpoint to check your article data:
Use this request to validate article data before creating or updating:
curl -X POST "${BASE_URL}/articles/<YOUR_SELLER_ID>/validate" \
  -H "X-Api-Key: <YOUR_STATIC_API_KEY>" \
  -H "Authorization: <YOUR_SESSION_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "sku": "<YOUR_SKU>",
    "name": {
      "value": "<PRODUCT_NAME>",
      "language": "EN"
    },
    "grossWeight": {
      "value": <WEIGHT_VALUE>,
      "unit": "KG"
    }
  }'

​
Where to go next

Now that you can manage articles, continue with these guides:

Create Products

Learn how to create new articles in your catalog.

Send Inventory

Send your products to Quivo warehouses to make them available for fulfillment.