{
  "opencollection": "1.0.0",
  "info": {
    "name": "Omniful Integration APIs Background Jobs Shipment API",
    "version": "v1"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Shipment",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Trigger Shipment",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://prodapi.omniful.com/sales-channel/public/v1/orders/:order_id/shipment",
            "params": [
              {
                "name": "order_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "📌 Create Shipment API – Overview The Create Shipment API is used to generate shipments for orders in Omniful. This API allows users to: Assign a shipping partner Generate tracking numbers (AWB) Set shipment details Note: The API only supports orders with the shipment type set to Omniful Generated. Orders with other shipment types are not eligible for shipment creation through this API. Request Body Parameters Field Data Type Description Required number_of_boxes number Total number of packages t"
        },
        {
          "info": {
            "name": "Add Shipment Details",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://prodapi.omniful.com/sales-channel/public/v1/orders/:order_id/shipment",
            "params": [
              {
                "name": "order_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "📌 Add Shipment Details API – Overview The Add Shipment Details API allows users to add existing shipment details for an order. This API is typically used to update shipment-related information such as: Tracking numbers (AWB) Courier service details Delivery tracking URLs 📌 Key Information This API applies only to orders where the shipment type is either: sales_channel_generated sales_channel_notified If the shipment was created by the sales channel, users can update the shipment details as req"
        },
        {
          "info": {
            "name": "Update Shipment Status",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://prodapi.omniful.com/sales-channel/public/v1/orders/:order_id/shipment/status",
            "params": [
              {
                "name": "order_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "📌 Update Shipment Status API - Overview The Update Shipment Status API allows users to update the shipment status of an order, ensuring real-time tracking updates for better shipment visibility. 📌 Supported Shipment Types: Manual Shipment (omniful_generated) – Shipments created manually by users. Sales Channel Generated Shipment (sales_channel_generated) – Shipments generated by the sales channel system. Sales Channel Notified Shipment (sales_channel_notified) – Shipments updated based on noti"
        },
        {
          "info": {
            "name": "Trigger Automatic Shipment Creation",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://prodapi.omniful.com/sales-channel/public/v1/tenants/sellers/:seller_code/orders/:id/shipment",
            "params": [
              {
                "name": "seller_code",
                "value": "",
                "type": "path"
              },
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This API endpoint is used to trigger the automatic creation of a shipment for a specific order within the Omniful platform. The shipment is generated when the details for a given order are provided, such as the number of boxes, weight, and any special remarks. This is used when the shipments are to be generated automatically by Omniful."
        },
        {
          "info": {
            "name": "Update Shipment Details",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://prodapi.omniful.com/sales-channel/public/v1/tenants/sellers/:seller_code/orders/:order_id/shipment",
            "params": [
              {
                "name": "seller_code",
                "value": "",
                "type": "path"
              },
              {
                "name": "order_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This API endpoint is used to update an existing shipment for a specific order within the Omniful platform. It allows you to modify shipment details such as shipping partner information, tracking URL, package details (e.g., dimensions, weight), and courier partner information. This is typically used to update shipment details after the initial creation by Sales Channel only."
        },
        {
          "info": {
            "name": "Update Shipment Status",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://prodapi.omniful.com/sales-channel/public/v1/tenants/sellers/:seller_code/orders/:order_id/shipment/status",
            "params": [
              {
                "name": "seller_code",
                "value": "",
                "type": "path"
              },
              {
                "name": "order_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This API is used to update shipment status when shipment type of the order is sales_channel_generated & omniful_generated. Allowed Shipment Status: [ dispatched, out_for_delivery, in_transit, delivered, return_to_origin]"
        },
        {
          "info": {
            "name": "Create Manual Shipment",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://prodapi.omniful.com/sales-channel/public/v1/tenants/sellers/:seller_code/orders/:oms_order_id/shipment/manual",
            "params": [
              {
                "name": "seller_code",
                "value": "",
                "type": "path"
              },
              {
                "name": "oms_order_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a manual shipment for an existing order by attaching tracking, AWB, and package details.Can be created only for order with the shipment type: omniful_generated"
        }
      ]
    }
  ],
  "bundled": true
}