Omniful, Inc.

Omniful, Inc. Shipment Orders API

The Shipment Orders API from Omniful, Inc. — 18 operation(s) for shipment orders.

GitHub OpenAPI

Documentation

📖
Documentation
https://docs.omniful.tech
📖
APIReference
https://docs.omniful.tech
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/omniful-inc/refs/heads/main/authentication/omniful-inc-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/omniful-inc/refs/heads/main/openapi/omniful-inc-shipment-orders-api-openapi.yml

Other Resources

🔗
Postman
https://docs.omniful.tech
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/omniful-inc/refs/heads/main/asyncapi/omniful-inc-webhooks.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/omniful-inc/refs/heads/main/conventions/omniful-inc-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/omniful-inc/refs/heads/main/errors/omniful-inc-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/omniful-inc/refs/heads/main/data-model/omniful-inc-data-model.yml

OpenAPI Specification

omniful-inc-shipment-orders-api-openapi.yml Raw ↑ 
openapi: 3.0.3
info:
  title: Omniful Integration APIs Background Jobs Shipment Orders API
  version: v1
  description: Omniful unified supply chain and fulfillment platform integration APIs (Order Management, Warehouse/Inventory, Returns, Purchase Orders, Shipment/TMS, Webhooks). Derived faithfully from the provider-published Postman collection at docs.omniful.tech; paths, methods, parameters, and request examples are as published, response schemas are not enumerated in the source.
  contact:
    url: https://docs.omniful.tech
servers:
- url: https://prodapi.omniful.com
security:
- bearerAuth: []
tags:
- name: Shipment Orders
paths:
  /sales-channel/public/v1/seller/shipment_orders/{order_id}/return_orders:
    post:
      summary: Create Return Shipment Order
      operationId: postCreateReturnShipmentOrder
      tags:
      - Shipment Orders
      parameters:
      - name: order_id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json: {}
      responses:
        '200':
          description: Successful response
  /sales-channel/public/v1/seller/shipment_orders/return_orders:
    get:
      summary: Get Return Shipment Orders
      operationId: getGetReturnShipmentOrders
      tags:
      - Shipment Orders
      responses:
        '200':
          description: Successful response
  /sales-channel/public/v1/seller/shipment_orders/return_orders/{return_order_id}:
    get:
      summary: Get Return Shipment Order By ID
      operationId: getGetReturnShipmentOrderById
      tags:
      - Shipment Orders
      parameters:
      - name: return_order_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
  /sales-channel/public/v1/seller/shipment_orders/{order_id}/return_requests:
    post:
      summary: Create Return Shipment Request
      operationId: postCreateReturnShipmentRequest
      tags:
      - Shipment Orders
      parameters:
      - name: order_id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json: {}
      responses:
        '200':
          description: Successful response
  /sales-channel/public/v1/seller/shipment_orders/return_requests:
    get:
      summary: Get Return Shipment Requests
      operationId: getGetReturnShipmentRequests
      tags:
      - Shipment Orders
      responses:
        '200':
          description: Successful response
  /sales-channel/public/v1/seller/shipment_orders/return_requests/{order_id}/approve:
    put:
      summary: Approve Return Shipment Request
      operationId: putApproveReturnShipmentRequest
      tags:
      - Shipment Orders
      parameters:
      - name: order_id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json: {}
      responses:
        '200':
          description: Successful response
  /sales-channel/public/v1/seller/shipment_orders/return_requests/{return_request_id}/reject:
    put:
      summary: Reject Return Shipment Request
      operationId: putRejectReturnShipmentRequest
      tags:
      - Shipment Orders
      parameters:
      - name: return_request_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
  /sales-channel/public/v1/seller/shipment_orders:
    get:
      summary: Get Shipment Orders
      operationId: getGetShipmentOrders
      tags:
      - Shipment Orders
      responses:
        '200':
          description: Successful response
    post:
      summary: Create Shipment Order
      operationId: postCreateShipmentOrder
      tags:
      - Shipment Orders
      requestBody:
        content:
          application/json: {}
      responses:
        '200':
          description: Successful response
  /sales-channel/public/v1/seller/shipment_orders/{id}:
    get:
      summary: Get Shipment Orders By ID
      operationId: getGetShipmentOrdersById
      tags:
      - Shipment Orders
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
  /sales-channel/public/v1/tenants/sellers/{seller_code}/shipment_orders/{order_id}/return_orders:
    post:
      summary: Create Return Order
      operationId: postCreateReturnOrder3
      tags:
      - Shipment Orders
      parameters:
      - name: seller_code
        in: path
        required: true
        schema:
          type: string
      - name: order_id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            example:
              return_order_id: RO-106213
              return_items:
              - item_id: JOUFURH05082036
                return_item_id: Rqueen_bed
                sku_code: JOUFURH05082036
                return_quantity: 1
                return_reasons:
                - reason: Damaged item
                  quantity: 1
                  comment: Product arrived with broken packaging
                unit_price: 50.0
                discount: 0
                total: 100.0
              additional_charges:
              - type: cod_fee
                cost: 50.0
                tax_inclusive: true
                tax_percentage: 5.0
                is_applied: true
              - type: platform_fee
                cost: 30.0
                tax_inclusive: false
                tax_percentage: 0.0
                is_applied: false
      responses:
        '200':
          description: Successful response
  /sales-channel/public/v1/tenants/sellers/{seller_code}/shipment_orders/return_orders:
    get:
      summary: Get Return Orders
      operationId: getGetReturnOrders3
      tags:
      - Shipment Orders
      parameters:
      - name: seller_code
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
  /sales-channel/public/v1/tenants/sellers/{seller_code}/shipment_orders/return_orders/{return_order_id}:
    get:
      summary: Get Return Order by Id
      operationId: getGetReturnOrderById2
      tags:
      - Shipment Orders
      parameters:
      - name: seller_code
        in: path
        required: true
        schema:
          type: string
      - name: return_order_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
  /sales-channel/public/v1/tenants/sellers/{seller_code}/shipment_orders/{order_id}/return_requests:
    post:
      summary: Create Return Request
      operationId: postCreateReturnRequest3
      tags:
      - Shipment Orders
      parameters:
      - name: seller_code
        in: path
        required: true
        schema:
          type: string
      - name: order_id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            example:
              return_request_number: RRN-108
              return_reason: Customer dissatisfaction with product quality
              return_items:
              - seller_sku_code: JOUFURH528052406
                quantity: 1
                return_reason: Item defective
                refund_amount: 950.0
                return_reasons:
                - reason: Damaged packaging
                  quantity: 1
                  comment: Outer box torn on arrival
              additional_charges:
              - type: platform_fee
                cost_with_tax: 30.0
                tax_percentage: 0.0
      responses:
        '200':
          description: Successful response
  /sales-channel/public/v1/tenants/sellers/{seller_code}/shipment_orders/return_requests:
    get:
      summary: Get Return Request
      operationId: getGetReturnRequest
      tags:
      - Shipment Orders
      parameters:
      - name: seller_code
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
  /sales-channel/public/v1/tenants/sellers/{seller_code}/shipment_orders/return_requests/{return_request_id}/approve:
    put:
      summary: Approve Return Request
      operationId: putApproveReturnRequest4
      tags:
      - Shipment Orders
      parameters:
      - name: seller_code
        in: path
        required: true
        schema:
          type: string
      - name: return_request_id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json: {}
      responses:
        '200':
          description: Successful response
  /sales-channel/public/v1/tenants/sellers/{seller_code}/shipment_orders/return_requests/{return_request_id}/reject:
    put:
      summary: Reject Return Request
      operationId: putRejectReturnRequest3
      tags:
      - Shipment Orders
      parameters:
      - name: seller_code
        in: path
        required: true
        schema:
          type: string
      - name: return_request_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
  /sales-channel/public/v1/tenants/sellers/{seller_code}/shipment_orders:
    get:
      summary: Get Shipment Orders
      operationId: getGetShipmentOrders2
      tags:
      - Shipment Orders
      parameters:
      - name: seller_code
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
    post:
      summary: Create Shipment Order
      operationId: postCreateShipmentOrder2
      tags:
      - Shipment Orders
      description: Description 📦 Create Shipment Order API 📥 Request Body 1. Order Information Field Type Required Description display_order_id string ✅ Unique human-readable order ID shown in Omniful. client_reference_id string ❌ Client-provided reference ID for internal tracking. automatic_shipment_order_shipment_enabled boolean ❌ If true, shipment order will auto-generate a shipment. order_created_at string (ISO 8601) ❌ Date-time when the order was originally created. slot.delivery_date string (YYYY-MM-DD) ❌ Re
      parameters:
      - name: seller_code
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            example:
              id: SO-81211
              display_order_id: SO-ORDER-302
              client_reference_id: SO-REF-8123
              installation_required: true
              order_items:
              - item_id: item-001
                sku_code: SKU-123
                hs_code: HS999
                sku_id: SKU-ID-456
                name: Sample Product
                display_price: 100.0
                selling_price: 90.0
                is_substituted: false
                item_barcodes:
                - BAR123
                quantity: 2
                tax_percent: 5.0
                tax: 9.0
                unit_price: 45.5
                subtotal: 91.0
                total: 100.0
                discount: 0.0
                tax_inclusive: true
                installation_required: true
              slot:
                delivery_date: '2025-07-20'
                start_time: 1000
                end_time: 1200
              order_created_at: '2025-07-15T10:00:00Z'
              customer:
                id: CUST-001
                first_name: John
                last_name: Doe
                mobile: '1234567890'
                mobile_code: '+91'
                country_code: IN
                email: john.doe@example.com
                gender: male
                country: India
                country_calling_code: '+91'
              shipment:
                number_of_boxes: 2
                weight: 4.5
              payment_method: postpaid
              is_cash_on_delivery: true
              shipment_type: omniful_generated
              delivery_type: click_and_collect
              note: Handle with care
              no_of_boxes: 2
              labels:
              - fragile
              - priority
              fulfillment_type: shipment_only
              receiver_address:
                address1: 456 Customer Lane
                address2: Apt 202
                city: Delhi
                country: India
                first_name: Receiver
                last_name: Name
                phone: '9988776655'
                state: Delhi
                zip: '110001'
                state_code: DL
                country_code: IN
                latitude: 28.6139
                longitude: 77.209
                email: receiver@example.com
                country_calling_code: '+91'
                national_address_code: code
              product_description: Pack of electronics
              hub_detail:
                code: H211125-3261-HXMJV
                hub_type: virtual
                virtual_hub_type: pickup_loction
              payment_info:
                currency: INR
                payment_type: cash
                payment_mode: cod
                total: 100.0
                subtotal: 95.0
                total_paid: 100.0
                total_due: 0.0
                tax_percent: 5.0
                tax: 5.0
                discount: 0.0
                shipping_price: 10.0
                additional_charges:
                - type: platform_fee
                  cost: 5.0
                  tax_amount: 0.5
                  tax_inclusive: true
                  tax_percentage: 10.0
                  is_applied: true
      responses:
        '200':
          description: Successful response
  /sales-channel/public/v1/tenants/sellers/{seller_code}/shipment_orders/{id}:
    get:
      summary: Get Shipment Order By ID
      operationId: getGetShipmentOrderById
      tags:
      - Shipment Orders
      parameters:
      - name: seller_code
        in: path
        required: true
        schema:
          type: string
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer