Alephee developers portal
  • Introduction
    • 📘API documentation
      • Introduction to integrations
    • ⚙ī¸Using the API
      • 🔒Authentication
      • 🏹Swagger
    • 📡Overall index of methods
  • Usage limiting
    • 🕑Rate limiting
    • 🔃Limits per request
    • ♒Limits HTTP headers responses
    • ⚠ī¸Usage limits by endpoint
  • Accounts
    • GET methods
      • Accounts
        • ⚠ī¸Usage limiting
        • âŦ†ī¸Request and Respone
        • ⌨ī¸Type specifications
        • ⚙ī¸Examples
      • Marketplaces
        • ⚠ī¸Usage limiting
        • âŦ†ī¸Request and Response
        • ⌨ī¸Type specifications
        • ⚙ī¸Examples
      • Price Lists
        • ⚠ī¸Usage limiting
        • âŦ†ī¸Request and Responses
        • ⌨ī¸Type specifications
        • ⚙ī¸Examples
      • Stores
        • ⚠ī¸Usage limiting
        • âŦ†ī¸Request and Response
        • ⌨ī¸Type specifications
        • ⚙ī¸Examples
      • Login Token
        • ⚠ī¸Usage limiting
        • âŦ†ī¸Request and Response
        • 📊Business rules
        • Standard usage flow for Alephee B2B portal
        • ⌨ī¸Type specifications
        • ⚙ī¸Examples
    • PUT methods
      • Update account fiscal tax rules
        • ⚠ī¸Usage limiting
        • âŦ†ī¸Request and Response
        • ⌨ī¸Type specifications
        • ⚙ī¸Examples
  • Orders
    • Logical model
      • ℹī¸What is an order?
      • 📂Order model overview
      • 🛒Shopping cart orders
        • đŸ”ŗCart order model overview
        • ã€Ŋī¸Mercado Libre’s shopping cart orders
      • 💴Approved payments and pending payments
      • 🗒ī¸General notes
    • GET methods
      • 👩‍đŸ’ģOrders
        • ⚠ī¸Usage limiting
        • âŦ†ī¸Request and Response
        • ⌨ī¸Type specifications
        • ⚙ī¸Examples
        • ⁉ī¸Useful tips
      • 🛒Orders List From A Shopping Cart
        • ⚠ī¸Usage limiting
        • âŦ†ī¸Request and Response
        • ⌨ī¸Type specifications
        • ⚙ī¸Examples
      • 📄Orders Document
        • ⚠ī¸Usage limiting
        • âŦ†ī¸Request and Response
      • 🧾Order Shipping Label
        • ⚠ī¸Usage limiting
        • 📊Business rules
        • âŦ†ī¸Request and Response
        • ⚙ī¸Examples
    • PUT methods
      • 📑Update orders status
        • ⚠ī¸Usage limiting
        • 📊Business rules
        • âŦ†ī¸Request and Response
        • ⌨ī¸Type specifications
        • ⚙ī¸Examples
      • 👨‍đŸ’ŧMark orders as integrated
        • ⚠ī¸Usage limiting
        • âŦ†ī¸Request and Response
        • ⌨ī¸Type specifications
        • ⚙ī¸Examples
    • POST methods
      • 📑Attach document to an order
        • ⚠ī¸Usage limiting
        • Allowed document types and formats
        • âŦ†ī¸Request and Response
        • ⚙ī¸Examples
        • ⚙ī¸Example using POSTMAN via form-data
        • ⚙ī¸Example using POSTMAN via JSON body
      • 📑Split an order
        • ⚠ī¸Usage limiting
        • âŦ†ī¸Request and Response
        • ⌨ī¸Type specifications
      • 📨Send a message to a buyer
        • ⚠ī¸Usage limiting
        • 📊Business rules
        • âŦ†ī¸Request and Response
        • ⚙ī¸Examples
      • 📝Create a new order
        • ⚠ī¸Usage limiting
        • Introduction
        • 📊Business rules
        • 📑Order mandatory sections
        • âŦ†ī¸Request and Response
        • Page
        • ⌨ī¸Type specifications
        • ⚙ī¸Examples
    • DELETE methods
      • 📑Delete an order
        • ⚠ī¸Usage limiting
        • 📊Business rules
        • âŦ†ī¸Request and Response
        • ⚙ī¸Examples
  • Orders shipping
    • GET methods
      • Shipping Packaging Information
        • ⚠ī¸Usage limiting
        • âŦ†ī¸Request and Response
        • ⌨ī¸Type specifications
        • ⚙ī¸Examples
      • Shipping Scheduling Information
        • ⚠ī¸Usage limiting
        • âŦ†ī¸Request and Response
        • ⌨ī¸Type specifications
        • ⚙ī¸Examples
      • Shipping Transportation Information
        • ⚠ī¸Usage limiting
        • âŦ†ī¸Request and Response
        • ⌨ī¸Type specifications
        • ⚙ī¸Examples
    • POST methods
      • Set Shipping Packaging Information
        • ⚠ī¸Usage limiting
        • âŦ†ī¸Request and Response
        • ⚙ī¸Examples
  • Products
    • GET methods
      • Products
        • ⚠ī¸Usage limiting
        • âŦ†ī¸Request and Response
        • ⌨ī¸Type specifications
        • ⚙ī¸Examples
    • POST methods
      • Logical model
      • Business Rules
        • Prices considerations
        • Available prices attributes combinations to set prices
        • Stock considerations
        • Alephee B2B portals prices and stock considerations
        • Measurable quantity and price considerations
      • Update Products
        • ⚠ī¸Usage limiting
        • âŦ†ī¸Request and Response
        • ⌨ī¸Type specifications
        • ⚙ī¸Examples
    • PUT methods
      • Update product fiscal information
        • ⚠ī¸Usage limiting
        • 🗒ī¸Notes
        • âŦ†ī¸Request and Response
        • ⌨ī¸Type specifications
        • ⚙ī¸Examples
    • DELETE methods
      • Delete products from a price list
        • ⚠ī¸Usage limiting
        • 📊Business rules
        • â€ŧī¸Warnings
        • âŦ†ī¸Request and Response
        • ⌨ī¸Type specifications
        • ⌨ī¸Result type specifications
        • ⚙ī¸Examples
        • Most common validation error messages and how to fix them.
  • Product listings
    • GET methods
      • Product Listings
        • ⚠ī¸Usage limiting
        • âŦ†ī¸Request and Response
        • ⌨ī¸Type specifications
        • ⚙ī¸Examples
    • POST methods
      • Set product listings discounts
        • ⚠ī¸Usage limiting
        • 📊Business rules
        • âŦ†ī¸Request and Response
        • ⌨ī¸Type specifications
        • ⚙ī¸Examples
    • PUT methods
      • Update product listings
        • ⚠ī¸Usage limiting
        • 📊Business rules
        • âŦ†ī¸Request and Response
        • ⌨ī¸Type specifications
        • ⚙ī¸Examples
      • Set product listings status
        • ⚠ī¸Usage limiting
        • 📊Business rules
        • âŦ†ī¸Request and Response
        • ⌨ī¸Type specifications
        • ⚙ī¸Examples
  • GLOSSARY
    • Conventions
    • Response status codes
    • Marketplaces/Channels ID and names list
    • Product listings status list
    • Orders and shipping glossary
      • Available order statuses codes
      • State transitions diagram
      • Automatic and manual order status updates
      • Attaching documents to orders
      • Shipping labels
  • TROUBLESHOOTING
    • ❗Important tips
    • ✅Best integrations practices
Powered by GitBook