Inbound | POST | /orders/outward/list

Summary

This API is used to create new outward orders in bulk in Increff system.

Description

• Shopfront systems can call this API to create outward orders in bulk in Increff system.
• One payload can create multiple orders and one SKU can be present only once per order.

<aside> ℹ️ The number of order items in an order should not be more than 2500.

</aside>

<aside> 🗒️ Note: Please note that the Custom Order or Order Item attribute key must be added in the OMS UI using screen Custom order/line Item Attribute, else it can result into failure of order creation in Increff OMS system.

In cases where the Custom order attribute key is not defined and custom order or order item attributes are part of the Inward/Outward order creation payloads then the order would move to FAILED status in CIMS.

</aside>

Request Body

{
  "outwardOrderClientFormList": [
    {
      "parentOrderCode": "PARENT-ORD-789",
      "locationCode": "WAREHOUSE-001",
      "orderCode": "ORD-123456",
      "orderTime": "2024-02-13T09:45:00Z",
      "orderType": "PO",
      "onHold": false,
      "isPriority": true,
      "gift": true,
      "qcStatus": "PASS",
      "dispatchByTime": "2024-02-15T14:30:00Z",
      "startProcessingTime": "2024-02-13T10:00:00Z",
      "paymentMethod": "COD",
      "shippingAddress": {
        "name": "Jane Smith",
        "line1": "456 Oak Street",
        "line2": "Suite 789",
        "line3": "Tower D",
        "phone": "+1-555-987-6543",
        "email": "[email protected]",
        "city": "Gotham",
        "state": "NY",
        "zip": "10001",
        "country": "United States"
      },
      "billingAddress": {
        "name": "John Doe",
        "line1": "123 Main Street",
        "line2": "Apt 456",
        "line3": "Building C",
        "phone": "+1-555-123-4567",
        "email": "[email protected]",
        "city": "Metropolis",
        "state": "CA",
        "zip": "90001",
        "country": "United States"
      },
      "orderItems": [
        {
          "channelSkuCode": "SKU-001",
          "orderItemCode": "ITEM-001",
          "quantity": 2,
          "sellerDiscountPerUnit": 3.00,
          "channelDiscountPerUnit": 5.00,
          "sellingPricePerUnit": 20.00,
          "shippingChargePerUnit": 8.00,
          "giftOptions": {
            "giftwrapRequired": true,
            "giftMessage": "Happy Birthday!",
            "giftChargePerUnit": 2.50,
            "giftDocument": "gift_document.pdf",
            "giftDocumentFormat": "PDF"
          },
          "minExpiry": "2025-01-01",
          "orderItemCustomAttributes": {
            "attribute1": "value1",
            "attribute2": "value2",
            "attribute3": "value3",
            "attribute4": "value4",
            "attribute5": "value5",
            "attribute6": "value6",
            "attribute7": "value7",
            "attribute8": "value8",
            "attribute9": "value9",
            "attribute10": "value10",
            "channelMetadata": {
              "key": "value"
            }
          }
        }
      ],
      "taxBreakupForms": [
        {
          "channelSkuId": "SKU-001",
          "baseSellingPricePerUnit": 25.00,
          "taxItemForms": [
            {
              "type": "VAT",
              "rate": 8.5,
              "taxPerUnit": 2.13
            }
          ]
        }
      ],
      "packType": "PIECE",
      "isSplitRequired": true,
      "orderCustomAttributes": {
        "attribute1": "value1",
        "attribute2": "value2",
        "attribute3": "value3",
        "attribute4": "value4",
        "attribute5": "value5",
        "attribute6": "value6",
        "attribute7": "value7",
        "attribute8": "value8",
        "attribute9": "value9",
        "attribute10": "value10",
        "channelMetadata": {},
        "currency": "USD"
      }
    },
    {
      "parentOrderCode": "PARENT-ORD-790",
      "locationCode": "WAREHOUSE-001",
      "orderCode": "ORD-123457",
      "orderTime": "2024-02-13T09:45:00Z",
      "orderType": "PO",
      "onHold": false,
      "isPriority": true,
      "gift": true,
      "qcStatus": "PASS",
      "dispatchByTime": "2024-02-15T14:30:00Z",
      "startProcessingTime": "2024-02-13T10:00:00Z",
      "paymentMethod": "COD",
      "shippingAddress": {
        "name": "Jane Smith",
        "line1": "456 Oak Street",
        "line2": "Suite 789",
        "line3": "Tower D",
        "phone": "+1-555-987-6543",
        "email": "[email protected]",
        "city": "Gotham",
        "state": "NY",
        "zip": "10001",
        "country": "United States"
      },
      "billingAddress": {
        "name": "John Doe",
        "line1": "123 Main Street",
        "line2": "Apt 456",
        "line3": "Building C",
        "phone": "+1-555-123-4567",
        "email": "[email protected]",
        "city": "Metropolis",
        "state": "CA",
        "zip": "90001",
        "country": "United States"
      },
      "orderItems": [
        {
          "channelSkuCode": "SKU-001",
          "orderItemCode": "ITEM-001",
          "quantity": 2,
          "sellerDiscountPerUnit": 3.00,
          "channelDiscountPerUnit": 5.00,
          "sellingPricePerUnit": 20.00,
          "shippingChargePerUnit": 8.00,
          "giftOptions": {
            "giftwrapRequired": true,
            "giftMessage": "Happy Birthday!",
            "giftChargePerUnit": 2.50,
            "giftDocument": "gift_document.pdf",
            "giftDocumentFormat": "PDF"
          },
          "minExpiry": "2025-01-01",
          "orderItemCustomAttributes": {
            "attribute1": "value1",
            "attribute2": "value2",
            "attribute3": "value3",
            "attribute4": "value4",
            "attribute5": "value5",
            "attribute6": "value6",
            "attribute7": "value7",
            "attribute8": "value8",
            "attribute9": "value9",
            "attribute10": "value10",
            "channelMetadata": {
              "key": "value"
            }
          }
        }
      ],
      "taxBreakupForms": [
        {
          "channelSkuId": "SKU-001",
          "baseSellingPricePerUnit": 25.00,
          "taxItemForms": [
            {
              "type": "VAT",
              "rate": 8.5,
              "taxPerUnit": 2.13
            }
          ]
        }
      ],
      "packType": "PIECE",
      "isSplitRequired": true,
      "orderCustomAttributes": {
        "attribute1": "value1",
        "attribute2": "value2",
        "attribute3": "value3",
        "attribute4": "value4",
        "attribute5": "value5",
        "attribute6": "value6",
        "attribute7": "value7",
        "attribute8": "value8",
        "attribute9": "value9",
        "attribute10": "value10",
        "channelMetadata": {},
        "currency": "USD"
      }
    }
  ]
}

Response Body

{
  "successList": [
    {
      "orderCode": "ORD-123456",
      "locationCode": "WAREHOUSE-001"
    }
  ],
  "failureList": [
    {
      "orderCode": "ORD-123457",
      "locationCode": "WAREHOUSE-001"
    }
  ]
}

HttpStatusCode200