1. Home
  2. Docs
  3. Order API
  4. Detailed information
  5. Order submission scenarios

Order submission scenarios

When submitting orders via the API it is important that certain information related to the SKU attributes & non-SKU attributes is supplied in a defined manner. This will allow the order to successfully pass through each Nuvias distribution process.

The following scenarios highlight how orders should be placed with Nuvias.

Product SKU Orders

  • Define the product item SKUsand the required quantity
  • For delivery please provide one valid contact name and address per order
  • A valid PO number is required for the order

Consider the below items ordered for the above scenario:

Below is an example XML request for the above order scenario:

<ns2:submitOrder xmlns:ns2="urn:transactions_10.reseller.siphon.com" xmlns:ns3="urn:error.transactions_10.reseller.siphon.com">
    <submitOrderForm>
        <purchaseOrderID>PO123451</purchaseOrderID>
        <shipAddress>
            <attentionName>John Smith on 07943 123 001</attentionName>
            <companyName>Taylors Ltd</companyName>
            <addressLine1>Suite 3 Goose Court</addressLine1>
            <addressLine2>9 Blacksmith Street</addressLine2>
            <addressTown>London</addressTown>
            <addressCounty>London</addressCounty>
            <addressPostalCode>SW1 1XS</addressPostalCode>
        </shipAddress>
        <shippingMethod>UK Standard Next Day Delivery</shippingMethod>
        <shippingDate>2016-09-27T13:04:31.688+01:00</shippingDate>
        <deliveryInstructions>Main entrance at rear</deliveryInstructions>
        <insertType>TYPE_1</insertType>
        <submitOrderItemList>
            <partNumber>2200-46162-025</partNumber>
            <quantityRequired>5.0</quantityRequired>
        </submitOrderItemList>
    </submitOrderForm>
</ns2:submitOrder>
 
 
<ns2:submitOrderResponse xmlns:ns2="urn:transactions_10.reseller.siphon.com" xmlns:ns3="urn:error.transactions_10.reseller.siphon.com">
    <orderID>SO52315</orderID>
</ns2:submitOrderResponse>

Product SKU & Ancillary Items Orders

  • Define the product item SKUsand the required quantity
  • Define any additional items associated with each product item and the required quantity – e.g. PSUs
  • Define any additional licenses associated with each product item – the quantity must be the same as the product items being ordered, e.g. Polycom VQMON Software
  •  For delivery please provide one valid contact name and address per order
  • A valid PO number is required for the order

Consider the below items ordered for the above scenario:

Below is an example XML request for the above order scenario:

<ns2:submitOrder xmlns:ns2="urn:transactions_10.reseller.siphon.com" xmlns:ns3="urn:error.transactions_10.reseller.siphon.com">
    <submitOrderForm>
        <purchaseOrderID>PO123452</purchaseOrderID>
        <shipAddress>
            <attentionName>John Smith on 07943 123 001</attentionName>
            <companyName>Taylors Ltd</companyName>
            <addressLine1>Suite 3 Goose Court</addressLine1>
            <addressLine2>9 Blacksmith Street</addressLine2>
            <addressTown>London</addressTown>
            <addressCounty>London</addressCounty>
            <addressPostalCode>SW1 1XS</addressPostalCode>
        </shipAddress>
        <shippingMethod>UK Standard Next Day Delivery</shippingMethod>
        <shippingDate>2016-09-27T13:23:38.865+01:00</shippingDate>
        <deliveryInstructions>Main entrance at rear</deliveryInstructions>
        <insertType>TYPE_1</insertType>
        <submitOrderItemList>
            <partNumber>2200-46162-025</partNumber>
            <quantityRequired>5.0</quantityRequired>
        </submitOrderItemList>
        <submitOrderItemList>
            <partNumber>2200-46157-025</partNumber>
            <quantityRequired>3.0</quantityRequired>
        </submitOrderItemList>
        <submitOrderItemList>
            <partNumber>2200-46175-102</partNumber>
            <quantityRequired>3.0</quantityRequired>
        </submitOrderItemList>
        <submitOrderItemList>
            <partNumber>5150-47891-001</partNumber>
            <quantityRequired>8.0</quantityRequired>
        </submitOrderItemList>
    </submitOrderForm>
</ns2:submitOrder>

Product SKU, Ancillary Items & Provisioning Orders

  • Define the product item SKUsand the required quantity
  • Define any additional items associated with each product item and the required quantity – e.g. PSUs
  • Define any additional licenses associated with each product item – the quantity must be the same as the product items being ordered, e.g. Polycom VQMON Software
  • For provisioning include the appropriate Provisioning SKU – the quantity must be the same as the product items being ordered
    • It is recommended that Nuvias use an agreed default URL associated to each product item SKU
      • Any updates to the provisioning URL must be agreed in advance and provided in writing by the reseller
      • provisioningInstructions can be provided to overwrite the default URL in a future API release
  • For delivery please provide one valid contact name and address per order
  • A valid PO number is required for the order

These above items would then generate a Sales Order in Netsuite. From this order a “Provisioning Instruction” is sent to to the warehouse for configuration. This “Provisioning Instruction” will be the pre-agreed URL for each product item included in the order.

Consider the below items ordered for the above scenario:

Below is an example XML request for the above order scenario:

<ns2:submitOrder xmlns:ns2="urn:transactions_10.reseller.siphon.com" xmlns:ns3="urn:error.transactions_10.reseller.siphon.com">
    <submitOrderForm>
        <purchaseOrderID>PO123453</purchaseOrderID>
        <shipAddress>
            <attentionName>John Smith on 07943 123 001</attentionName>
            <companyName>Taylors Ltd</companyName>
            <addressLine1>Suite 3 Goose Court</addressLine1>
            <addressLine2>9 Blacksmith Street</addressLine2>
            <addressTown>London</addressTown>
            <addressCounty>London</addressCounty>
            <addressPostalCode>SW1 1XS</addressPostalCode>
        </shipAddress>
        <shippingMethod>UK Standard Next Day Delivery</shippingMethod>
        <shippingDate>2016-09-27T13:29:50.627+01:00</shippingDate>
        <deliveryInstructions>Main entrance at rear</deliveryInstructions>
        <insertType>TYPE_1</insertType>
        <submitOrderItemList>
            <partNumber>2200-46162-025</partNumber>
            <quantityRequired>5.0</quantityRequired>
        </submitOrderItemList>
        <submitOrderItemList>
            <partNumber>2200-46157-025</partNumber>
            <quantityRequired>3.0</quantityRequired>
        </submitOrderItemList>
        <submitOrderItemList>
            <partNumber>2200-46175-102</partNumber>
            <quantityRequired>3.0</quantityRequired>
        </submitOrderItemList>
        <submitOrderItemList>
            <partNumber>5150-47891-001</partNumber>
            <quantityRequired>8.0</quantityRequired>
        </submitOrderItemList>
        <submitOrderItemList>
            <partNumber>UD-SIP-SER-PRV-PH</partNumber>
            <quantityRequired>8.0</quantityRequired>
        </submitOrderItemList>
    </submitOrderForm>
</ns2:submitOrder>
 
 
<ns2:submitOrderResponse
xmlns:ns2="urn:transactions_10.reseller.siphon.com" xmlns:ns3="urn:error.transactions_10.reseller.siphon.com">
    <orderID>SO52317</orderID>
</ns2:submitOrderResponse>

Product SKU, Ancillary Items, Provisioning & Firmware Upgrade Orders

  • Define the product item SKUsand the required quantity
  • Define any additional items associated with each product item and the required quantity – e.g. PSUs
  • Define any additional licenses associated with each product item – the quantity must be the same as the product items being ordered, e.g. Polycom VQMON Software
  • For provisioning include the appropriate Provisioning SKU – the quantity must be the same as the product items being ordered
    • It is recommended that Nuvias use an agreed default URL associated to each product item SKU
      • Any updates to the provisioning URL must be agreed in advance and provided in writing by the reseller
      • provisioningInstructions can be provided to overwrite the default URL in a future API release
  • For firmware upgrade include the appropriate SKU or provisioning information – the quantity must be the same as the product items being ordered
    • It is recommended that Nuvias use an agreed default firmware associated to each product item SKU – updates to the firmware version must be agreed in advance and provided in writing by the reseller
      • Any updates to the firmware version must be agreed in advance and provided in writing by the reseller
      • firmwareInstructions can be provided to overwrite the default firmware in a future API release
  • For delivery please provide one valid contact name and address per order
  • A valid PO number is required for the order

These above items would then generate a Sales Order in Netsuite. From this order a “Provisioning Instruction” is sent to to the warehouse for configuration. This “Provisioning Instruction” will be the pre-agreed URL & firmware version for each product item included in the order.

Consider the below items ordered for the above scenario:

Below is an example XML request for the above order scenario:

<ns2:submitOrder xmlns:ns2="urn:transactions_10.reseller.siphon.com" xmlns:ns3="urn:error.transactions_10.reseller.siphon.com">
    <submitOrderForm>
        <purchaseOrderID>PO123454</purchaseOrderID>
        <shipAddress>
            <attentionName>John Smith on 07943 123 001</attentionName>
            <companyName>Taylors Ltd</companyName>
            <addressLine1>Suite 3 Goose Court</addressLine1>
            <addressLine2>9 Blacksmith Street</addressLine2>
            <addressTown>London</addressTown>
            <addressCounty>London</addressCounty>
            <addressPostalCode>SW1 1XS</addressPostalCode>
        </shipAddress>
        <shippingMethod>UK Standard Next Day Delivery</shippingMethod>
        <shippingDate>2016-09-27T13:30:15.948+01:00</shippingDate>
        <deliveryInstructions>Main entrance at rear</deliveryInstructions>
        <insertType>TYPE_1</insertType>
        <submitOrderItemList>
            <partNumber>2200-46162-025</partNumber>
            <quantityRequired>5.0</quantityRequired>
        </submitOrderItemList>
        <submitOrderItemList>
            <partNumber>2200-46157-025</partNumber>
            <quantityRequired>3.0</quantityRequired>
        </submitOrderItemList>
        <submitOrderItemList>
            <partNumber>2200-46175-102</partNumber>
            <quantityRequired>3.0</quantityRequired>
        </submitOrderItemList>
        <submitOrderItemList>
            <partNumber>5150-47891-001</partNumber>
            <quantityRequired>8.0</quantityRequired>
        </submitOrderItemList>
        <submitOrderItemList>
            <partNumber>UD-SIP-SER-PRV-ADV-PH</partNumber>
            <quantityRequired>8.0</quantityRequired>
        </submitOrderItemList>
    </submitOrderForm>
</ns2:submitOrder>
 
<ns2:submitOrderResponse
xmlns:ns2="urn:transactions_10.reseller.siphon.com" xmlns:ns3="urn:error.transactions_10.reseller.siphon.com">
    <orderID>SO52318</orderID>
</ns2:submitOrderResponse>

Multiple Deliveries

All of the scenarios above assume there is only one delivery address. Each order must have a single delivery address per order. If more than one delivery address is required for any of the above scenarios, you must supply a separate order per address.

You can repeat the process for each of the scenarios above and simply select a separate delivery address for each order.

Was this article helpful to you? Yes No

How can we help?