0% found this document useful (0 votes)
8 views4 pages

API Endpoints for Product Management

This document outlines the API version 0.1.0 using OAS 3.1, detailing various endpoints for managing products, users, and integrations. It includes methods for retrieving, creating, updating, and deleting resources such as products, users, and images. Additionally, it provides endpoints for handling promotions, stock, and activity logs, along with schemas for data validation.

Uploaded by

Gustavo Ribeiro
Copyright
© All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
8 views4 pages

API Endpoints for Product Management

This document outlines the API version 0.1.0 using OAS 3.1, detailing various endpoints for managing products, users, and integrations. It includes methods for retrieving, creating, updating, and deleting resources such as products, users, and images. Additionally, it provides endpoints for handling promotions, stock, and activity logs, along with schemas for data validation.

Uploaded by

Gustavo Ribeiro
Copyright
© All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd

API 0.1.0 OAS 3.

/[Link]

Authorize

Products

GET /products/ Get Products

GET /products/tags Get Tags

GET /products/{code} Get Product

GET /products/{code}/reviews Get Product Reviews

GET /products/{code}/similars Get Similar Products

User

GET /users/ Read Users

POST /users/ Create User

PUT /users/ Update Current User

DELETE /users/ Delete Current User

Auth

POST /token Login For Access Token

Integrations
GET /integrations/ml/auth Ml Auth
GET /integrations/ml/redirect Ml Redirect

GET /integrations/marketplaces/available Get Available Marketplaces

GET /integrations/products Get Products

POST /integrations/products/{product_code} Request New Product

GET /integrations/products/{product_code} Get Product

DELETE /integrations/products/{product_code} Remove Product Integration

PATCH
/integrations/products/{product_code}/{marketplace_type}
Edit Product Integration

PUT /integrations/publishes/{publish_id}/deploy Publishes Product

PATCH /integrations/publishes/{publish_id}/update Update Publishes

PATCH /integrations/publishes/{publish_id}/activate Activate Publishes

PATCH /integrations/publishes/{publish_id}/deactivate Deactivate Publishes

DELETE /integrations/publishes/{publish_id} Delete Publish

GET /integrations/images Get Images

POST /integrations/images Upload Image

DELETE /integrations/images/{image_id} Delete Image

GET /integrations/products/{product_code}/images Get Product Images

GET
/integrations/products/{product_code}/variations/images
Get Product Variations Images

GET /integrations/publishes/{publish_id}/images Get Publish Images

POST
/integrations/publishes/{publish_id}/images/{image_id}
Add Image To Publish

DELETE
/integrations/publishes/{publish_id}/images/{image_id}
Remove Image From Publish
/integrations/publishes/{publish_id}/images/{image_id}
PATCH /{new_image_id}
Update Image From Publish

/integrations/publishes/{publish_id}/variations/{variation_sku}
POST /images/{image_id}
Add Variation Image To Publish

/integrations/publishes/{publish_id}/variations/{variation_sku}
DELETE /images/{image_id}
Remove Variation Image From Publish

/integrations/publishes/{publish_id}/variations/{variation_sku}
PATCH /images/{image_id}/{new_image_id}
Update Variation Image From Publish

POST
/integrations/publishes/{publish_id}/images/reset
Reset Images From Publish

GET /integrations/products/{product_code}/variations Get Product Variations

GET /integrations/publishes/{publish_id}/variations Get Publish Variations

POST
/integrations/publishes/{publish_id}/variations
Create Publish Variations

PATCH
/integrations/publishes/{publish_id}/variations/{variation_sku}
Edit Publish Variations

DELETE
/integrations/publishes/{publish_id}/variations/{variation_sku}
Delete Publish Variations

PATCH
/integrations/publishes/{publish_id}/{variation_sku}/activate
Activate Publish Variations

PATCH
/integrations/publishes/{publish_id}/{variation_sku}/deactivate
Deactivate Publish Variations

POST
/integrations/publishes/{publish_id}/variations/reset
Reset Publish Variations

GET /integrations/publishes/{publish_id}/promotions Get Publish Promotions

POST
/integrations/publishes/{publish_id}/promotions
Create Publish Promotions

PATCH
/integrations/publishes/{publish_id}/promotions/{promotion_id}
Update Publish Promotions

DELETE
/integrations/publishes/{publish_id}/promotions/{promotion_id}
Delete Publish Promotions
GET /integrations/products/{product_code}/stock Get Product Stock

GET /integrations/products/{product_code}/reviews Get Product Reviews

GET /integrations/publishes/{publish_id}/history Get Publish History

GET /integrations/activity-log Get Activity Log

GET /integrations/export-data Export Data

default

GET / Read Root

Schemas

Body_login_for_access_token_token_post Expand all object

CompleteProductInfo Expand all object

CreateUser Expand all object

HTTPValidationError Expand all object

Images Expand all object

Message Expand all object

NameColumn Expand all object

ProductReviewSchema Expand all object

ProductReviewsSchema Expand all object

SimplifiedProductInfo Expand all object

SimplifiedProductsResponse Expand all object

You might also like