Table of Contents

Contents
- overview
- getting started
- references
- rate limit
- need support
Apis
- authentication
  - overview
  - post retrieve access token
- orders
  - overview
  - put change order status
  - post create new order
  - post create order note
  - delete delete order
  - get retrieve order detail
  - get retrieve order list
  - get retrieve status preview
  - put set order shipped
  - put update order
- others
  - get retrieve pickups addresses
- products
  - post create new product
  - delete delete product
  - put product batches update
  - put product batches upsert
  - get product report detail
  - get retrieve product detail
  - get retrieve products list
  - put update product
  - put update product status
- provisions
  - get retrieve product provisions
  - put update product provision
  - put update variation provision
- publications
  - overview
  - post create new publication
  - delete delete publication
  - get retrieve publication detail
  - get retrieve publication list
  - put update publication
  - put update publication status
- shippings
  - overview
  - post create new shipping
  - delete delete shipping
  - put generate shipping label
  - get retrieve shipping detail
  - get retrieve shipping list
  - post retrieve shipping services
- taxonomy
  - post create new brand
  - get retrieve brand detail
  - get retrieve brands list
  - get retrieve categories list
  - get retrieve category detail
- webhook
  - overview
  - post webhook
Objects
- authentication
  - access token
- images
  - image
- orders
  - order item
  - order state
  - fulfillment
  - order row
  - customer
  - order note
  - order
- others
  - address
- products
  - product type
  - attribute value
  - variation
  - tag
  - product
  - product update request
  - product batches report
  - product upsert request
- provisions
  - provision
- publications
  - marketplace order state
  - channel source
  - publication status
  - publication
- shippings
  - package
  - shipping item
  - shippings
  - shipping service
- taxonomy
  - brand
  - category
- webhook
  - webhook order
  - webhook order status
  - webhook shipment
  - webhook shipment status
  - webhook order row status

Poleepo API

Welcome to the Poleepo API documentation. Our REST API allows you to integrate your services with Poleepo, accessing its core features to manage products, listings, and orders.

Server

Main Server

These are the base URLs for the Poleepo API. All requests must be made to one of these endpoints.
Poleepo API (Production) https://api.poleepo.cloud
Poleepo API (Stage) https://api-stage.poleepo.cloud
DEPRECATED Poleepo API (Production) https://api.poleepo.cloud/2022-03

Security

Bearer Access Token

To make requests to the API, you must provide a Bearer Access Token.
First, generate a token using the Authentication endpoints.
Then, include it in the Authentication header for every request to protected resources.
Example Authentication: Bearer YOUR_ACCESS_TOKEN

With the Poleepo API, you can:

Manage your product catalog (create, update, and delete products in Poleepo)
Manage your online listings (adjust prices, handle times, and shipping costs)
Manage your orders (retrieve orders imported from your sales channels, update order statuses, send tracking information, and download carrier labels in PDF format)

We are constantly expanding the API's capabilities to help you automate repetitive tasks and grow your business.