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
        • ⌨️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
On this page

Was this helpful?

  1. Introduction
  2. API documentation

Introduction to integrations

PDF document

PreviousAPI documentationNextUsing the API

Last updated 9 months ago

Was this helpful?

📘
650KB
Alephee - Introduction to integrations.pdf
pdf
Introduction to integrations