OTO Global Products API

openapi: 3.0.3
info:
  title: OTO API V2 Account Products API
  version: 2.0.0
  description: 'Introduction OTO REST API provides seamless integration for managing shipments, tracking deliveries, and handling logistics operations. With powerful endpoints for creating, updating, and querying shipments, it ensures efficient and reliable communication between your systems and OTO''s platform. Overview We continuously analyze the e-commerce and logistics industries to enhance shipping and fulfillment processes, making them easier for vendors. OTO APIs are designed to automate and simplify key logistics operations, including: 🚀 Order Management – Process, update, and sync orders seamlessly. 🚀 Shipment Management – Create, manage, and track shipments effortlessly. 🚀 Return Management – Handle return requests and reverse logistics smoothly. 🚀 Stock Inventory Management – Keep inventory levels updated in real-time. 🚀 Product Management – Organize, update, and synchronize products efficiently. 🚀 Warehouse Management – Add, update, organize pickup locations. You can find guidance to assist you throughout the integration process here . Base URL: All API requests must be made over HTTPS to the following base endpoint: https://api.tryoto.com Meet our new OTO AI Assistant 🤖— a smart AI agent designed to help you navigate and use our REST API with ease. Whether you''re integrating for the first time or need help troubleshooting a request, our assistant is here to provide instant answers, example json responses, guide you through endpoints, and help you build faster.'
  contact:
    name: OTO Support
    url: https://help.tryoto.com/en/support/home
  x-source: derived from published OTO API V2 Postman collection (apis.tryoto.com)
servers:
- url: https://api.tryoto.com/rest/v2
  description: Production
- url: https://staging-api.tryoto.com/rest/v2
  description: Staging / sandbox
security:
- bearerAuth: []
tags:
- name: Products
  description: ''
paths:
  /rest/v2/createProduct:
    post:
      operationId: createProduct
      summary: Create Product
      tags:
      - Products
      description: 'This API endpointallows clients to add new products to the system by providing key product details. This endpoint is essential for catalog management, enabling businesses to define and register products for use in their operations, such as inventory management, sales, and order processing. Request Parameters: Name Required Type Description sku yes string SKU of the product productName yes string Name of the product price yes string Price of the product taxAmount no string Tax Amount of the produ'
      requestBody:
        content:
          application/json:
            example:
              productName: Pencil
              sku: 1234AB123CDEas
              price: '23.5'
              taxAmount: '11'
              barcode: '1245125123421'
              secondBarcode: '231412312'
              description: This is product description
              brandId: 6345
              category: Category of the product
              productImage: ''
              packagingMaterial: true
              customAttributes:
              - attributeName: '112'
                attributeValue: test product
            schema:
              type: object
      responses:
        '200':
          description: '200'
          content:
            application/json:
              example:
                productId: 6084100
                success: true
        '400':
          description: 400 wrong price value
          content:
            application/json:
              example:
                success: false
                otoErrorCode: OTO1009
                otoErrorMessage: Something went wrong
  /rest/v2/productList:
    post:
      operationId: productList
      summary: Product List
      tags:
      - Products
      description: 'This API endpoint provides a simple and efficient way to retrieve a list of products available in your inventory. This endpoint returns essential product details such as names, images, SKUs, and barcodes, enabling applications to display and manage product information effectively. Request Parameters: Name Required Type Description pageSize no number items per page, default is 100 currentPage no number page numbe to be called, default is 1'
      requestBody:
        content:
          application/json:
            example:
              pageSize: 100
              currentPage: 1
            schema:
              type: object
      responses:
        '200':
          description: '200'
          content:
            application/json:
              example:
                success: true
                productCount: 3
                products:
                - name: renegade
                  productImage: https://i.pinimg.com/564x/8b/46/bd/8b46bd024b6a53f09ad35c29f8ffb50b.jpg
                  sku: '001'
                  barcode: '1111'
                - name: football
                  productImage: https://i.pinimg.com/236x/e4/be/bb/e4bebbaf7a4b7efa305e198720248e9b.jpg
                  sku: '002'
                  barcode: '6120000210'
                - name: icecream
                  productImage: https://i.pinimg.com/236x/96/e7/ac/96e7accacdb0c1ec87c7ebfd2dc26f3b.jpg
                  sku: '003'
                  barcode: '46666588851222000574'
  /rest/v2/addBox:
    post:
      operationId: addBox
      summary: Add Box
      tags:
      - Products
      description: 'This API endpoint allows you to create new boxes with the dimensions you provided. Request Parameters: Name Required Type Description name yes string name of the box, name should be unique length yes double length of the package width yes double width of the package height yes double height of the package'
      requestBody:
        content:
          application/json:
            example:
              name: xsmall
              length: 25
              width: 24
              height: 9
            schema:
              type: object
      responses:
        '200':
          description: 200 OK
          content:
            application/json:
              example:
                success: true
                message: Box successfully created
        '409':
          description: 409-already exists
          content:
            application/json:
              example:
                success: false
                otoErrorCode: OTO1147
                otoErrorMessage: Box already exists
  /rest/v2/updateBox:
    post:
      operationId: updateBox
      summary: Update Box
      tags:
      - Products
      description: You can change the dimension information of an existing box. Since the name is unique, you can change the information of that box by entering the name information in the request.
      requestBody:
        content:
          application/json:
            example:
              name: xsmall
              length: 3
              width: 4
              height: 3
            schema:
              type: object
      responses:
        '200':
          description: 200 OK
          content:
            application/json:
              example:
                success: true
                message: Box successfully updated
        '409':
          description: 409-not found
          content:
            application/json:
              example:
                success: false
                otoErrorCode: OTO1149
                otoErrorMessage: Box could not be found
  /rest/v2/getBox:
    get:
      operationId: getBox
      summary: Get Box
      tags:
      - Products
      description: This API endpoint you to retrieve the name, id and dimension information of all boxes currently in your account.
      responses:
        '200':
          description: 200 OK
          content:
            application/json:
              example:
                boxes:
                - length: 10
                  width: 9
                  boxName: medium
                  id: 2642
                  height: 5
                success: true
        '409':
          description: 409-not found
          content:
            application/json:
              example:
                success: false
                otoErrorCode: OTO1149
                otoErrorMessage: Box could not be found
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'Obtain an access_token by POSTing your refresh_token to /refreshToken, then send Authorization: Bearer <access_token>.'