Webhooks: Order Status Notification Events v7

Every event uses the top-level event code im::updated, with the sub-event code carrying the specific status. Order type indicates which statuses apply to Technology Solutions orders, Cloud orders, or both.

 

Technology Solutions and Cloud

V7 Order Status Sub-event Code Description
OPEN im::order_open Order has been received and created; processing has not started.
PROCESSING im::order_processing Order is being processed by Ingram Micro.
COMPLETED im::order_completed Order has been fully fulfilled. For cloud orders, provisioning is complete.
CANCELLED im::order_cancelled Order has been cancelled and will not be fulfilled.

Technology Solutions only

V7 Order Status Sub-event Code Description
SHIPPED im::order_shipped All lines on the order have shipped.
PARTIALLY_SHIPPED im::order_partially_shipped Some lines or quantities have shipped; the remainder is pending.
DELIVERED im::order_delivered Carrier has confirmed delivery of the full order.
PARTIALLY_DELIVERED im::order_partially_delivered Part of the order has been delivered; the remainder is in transit or pending.
BACKORDERED im::order_backordered One or more lines are awaiting stock and will ship when available.
READY_FOR_PICKUP im::order_ready_for_pickup A will-call order is ready for collection at the warehouse.
VOIDED im::order_voided Order has been voided and will not be fulfilled.
SALES_HOLD im::order_sales_hold Order is on hold pending review by the sales team.
CREDIT_REVIEW im::order_credit_review Order is held while the account's credit is reviewed.
CREDIT_CHECK im::order_credit_check Order is undergoing a credit check before release.
ORDER_REVIEW im::order_review_required Order requires internal review before it can proceed.
IN_PROGRESS im::order_in_progress Order has been released and is being fulfilled.
PARTIALLY_PROCESSED im::order_partially_processed Some lines have been processed; others are still pending.
READY_TO_SHIP im::order_ready_to_ship Order has been picked and packed and is awaiting carrier pickup.

Cloud and subscription only

V7 Order Status Sub-event Code Description
ACTION_REQUIRED im::order_action_required Reseller action is required before the order can proceed.
ACTION_REQUIRED_PROVISIONING_IN_PROGRESS im::order_action_required_provisioning Provisioning has started, but reseller action is required to complete it.
PROVISIONING_FAILED im::order_provisioning_failed The vendor could not provision the subscription; the order needs attention.
SCHEDULED im::order_scheduled Order is scheduled to process on a future date.
PENDING_APPROVAL im::order_pending_approval Order is awaiting approval before it is submitted to the vendor.
PENDING_TERMS_AND_ACCEPTANCE im::order_pending_terms End customer must accept the vendor's terms before provisioning.
ACTIVATION_DATE_VALIDATION_FAILED im::order_activation_date_failed The requested activation date failed validation; a valid date is required.
ORDER_FULFILLMENT im::order_fulfillment_started Order has been submitted to the vendor for fulfillment.

 

Sample JSON payload - V7 Cloud Order Sample


{
  "topic": "resellers/orders",
  "event": "im::updated",
  "evenTtimeStamp":"event_occured" --- UTC
  "eventId":"unique_event_id"
  "resource":       
    {
      "eventType":"im::order_completed (v3)",
      "orderNumber": "20-RD128",
      "customerOrderNumber": "ZENPO",
      "orderEntryTimeStamp": "2020-04-03T08:54:39-07:00",
      "orderType": "CLOUD",
      "orderstatus": "COMPLETED"
      "lines":[{
          "lineNumber":"01",
          "linestatus": "COMPLETED"
          "subOrderNumber":"20-RD128-21",
          "lineStatus": "IM::shipped",   -- use the proposed order status from this page - https://imonline.atlassian.net/wiki/spaces/B2BP/pages/772538423/Order+Status+Management
          "ingramPartNumber": "5CX895",
          "vendorPartNumber": "TC57HO-1PEZU4P-NA",
          "requestedQuantity": "3",
          "shippedQuantity": "2",   
          "backOrderedQuantity": "1",
          "shipmentDetails": [
            {
              "shipmentDate": "2019-11-06",
              "shipFromWarehouseId": "10",
              "warehouseName": "New York",
              "carrierCode": "4M",
              "carrierName": "SMARTPOST-BM",                  
              "packageDetails":[ --Array
              {
                  "cartonNumber":"",
                  "quantityInbox":"",
                  "trackingNumber":"",
                } ]
              }
            ], //shipmentdetails end
            "serialNumberDetails":[{
                "serialNumber":"123123123"
              }
              ],
          }
        ] // lines end
        "links":[. //array
          { 
            "topic":"orders",
            "href":"/resellers/v7/orders/20-RD128",
            "type": "GET"
          },
          { 
            "topic":"invoices",  -- shows only if the status is invoiced
            "href":"/resellers/v5/invoices/20-RD128",
            "type": "GET"
          },
        ]
      }
}

Sample V7 payload — Technology Solutions


{
  "topic": "resellers/orders",
  "event": "im::updated",
  "eventTimeStamp": "",
  "eventId": "",
  "resource": {
    "eventType": "im::order_shipped (v3)",
    "orderNumber": "",
    "customerOrderNumber": "",
    "orderEntryTimeStamp": "",
    "orderType": "TS",
    "orderStatus": "SHIPPED",
    "lines": [
      {
        "lineNumber": "01",
        "subOrderNumber": "",
        "lineStatus": "SHIPPED",
        "ingramPartNumber": "",
        "vendorPartNumber": "",
        "requestedQuantity": "3",
        "shippedQuantity": "2",
        "backOrderedQuantity": "1",
        "shipmentDetails": [
          {
            "shipmentDate": "",
            "shipFromWarehouseId": "",
            "warehouseName": "",
            "carrierCode": "",
            "carrierName": "",
            "packageDetails": [
              {
                "cartonNumber": "",
                "quantityInbox": "",
                "trackingNumber": ""
              }
            ]
          }
        ],
        "serialNumberDetails": [
          { "serialNumber": "" }
        ]
      }
    ],
    "links": [
      {
        "topic": "orders",
        "href": "/resellers/v7/orders/",
        "type": "GET"
      }
    ]
  }
}

Sample V7 payload — Cloud order provisioned


{
  "topic": "resellers/orders",
  "event": "im::updated",
  "eventTimeStamp": "",
  "eventId": "",
  "resource": {
    "eventType": "im::order_completed (v3)",
    "orderNumber": "",
    "customerOrderNumber": "",
    "orderEntryTimeStamp": "",
    "orderType": "CLOUD",
    "orderStatus": "COMPLETED",
    "lines": [
      {
        "lineNumber": "01",
        "lineStatus": "COMPLETED",
        "ingramPartNumber": "",
        "vendorPartNumber": "",
        "requestedQuantity": "25",
        "subscriptions": [
          {
            "subscriptionId": "",
            "subscriptionName": "",
            "vendorSubscriptionId": "",
            "provisioningStatus": "PROVISIONED"
          }
        ]
      }
    ],
    "links": [
      {
        "topic": "orders",
        "href": "/resellers/v7/orders/",
        "type": "GET"
      },
      {
        "topic": "subscriptions",
        "href": "/resellers/v7/subscriptions/",
        "type": "GET"
      }
    ]
  }
}