Orders Web Service

• Click on the +/- icons to expand / collapse entries.

  Web Service Details

  • vendorCode
  • vendorKey
  • Orders[]
    • Order
      • Addresses
        • ShipAddress
          • + - name

            • Required

              Field Type : String(255)

              This field can be used to enter company name here when applicable, otherwise, it can be the same as contact name

          • + - streetAddress
            • Required
            • Field Type : String(200)
            • Street, Building, Appartment Details as it appears on address label.
          • + - city
            • Required
            • Field Type : String(200)
            • City name as appears on address label
          • + - provState
            • Required for specific Countries (US, Canada etc)
            • Field Type : String(100)
          • + - postalZip
            • Required
            • Postal Code, or Zip Code  as it appears on address label
            • Field Type : String(20)
          • + - country
            • Required
            • Country Name as it appears on Address Label
            • Field Type : String(50)
          • + - phone
            • Optional
            • Field Type : String(50)
          • + - fax
            • Optional
            • Field Type : String(50)
          • + - email
            • Optional
            • Field Type : String(150)
          • + - web
            • Optional
            • URL for Company or Contact website
            • Field Type : String(80)
          • + - contact
            • Optional
            • Contact Persons full name.
            • Field Type : String(50)
        • BillAddress
          • Optional, If left out, assumed to be same as Ship To Address.
          • + - name

            • Required

              Field Type : String(255)

              This field can be used to enter company name here when applicable, otherwise, it can be the same as contact name

          • + - streetAddress
            • Required
            • Field Type : String(200)
            • Street, Building, Appartment Details as it appears on address label.
          • + - city
            • Required
            • Field Type : String(200)
            • City name as appears on address label
          • + - provState
            • Required for specific Countries (US, Canada etc)
            • Field Type : String(100)
          • + - postalZip
            • Required
            • Postal Code, or Zip Code  as it appears on address label
            • Field Type : String(20)
          • + - country
            • Required
            • Country Name as it appears on Address Label
            • Field Type : String(50)
          • + - phone
            • Optional
            • Field Type : String(50)
          • + - fax
            • Optional
            • Field Type : String(50)
          • + - email
            • Optional
            • Field Type : String(150)
          • + - web
            • Optional
            • URL for Company or Contact website
            • Field Type : String(80)
          • + - contact
            • Optional
            • Contact Persons full name.
            • Field Type : String(50)
      • Details
        • + - orderID

          • Required

            Field Type : String(200)

            This is the preferred Order ID that is assigned to the order in Blast Ramp.

            Use the value 'AUTO' to have the web service automatically assign the next available numerical order ID.

            If a numerical OrderID is assigned, this will affect the auto-increment value for all orders within Blast Ramp.

            You may pass in an Order ID of an existing order to overwrite the existing order, provided the current order in Blast Ramp is in the 'Created' or 'Awaiting Release' status.  This should only be used to correct values on the order, and should not be used to continually refresh batches of orders, as this renders users unable to edit their orders within Blast Ramp.

        • + - orderType

          • Optional

            Field Type : String(1)

            Valid values : 'P' or 'C', Defaults to 'P'

            P - Pick/Pack orders pull inventory from stock.  C - Cross Dock orders skip the inventory step, but work for regular invoicing purposes.

        • + - orderPriority

          • Optional

            Field Type : String(10)

            This field defines what priority category this order belongs to.  Should match a a priority code from Blast Ramp.  Defaults to Standard

        • + - season

          • Optional

            Field Type : String(10)

            This field defines the Season, or Linelist the order belongs to.  Should match a valid Season/Linelist code from Blast Ramp.

        • + - purchaseOrderNumber
          • Optional
          • Field Type : String(255)
          • This field defines the optional PO number for the order.
        • + - customerProfileID

          • Optional

            Field Type : Integer - ID number of the customer profile

            Used only if you want the order to be attached to an existing customer in Blast Ramp, that differs from the ship to customer address.  Must be a valid customer id that exists in Blast Ramp.

        • + - warehouseID

          • Required

            Field Type : String(4)

            This field defines which distribution center the order belongs to.  It must be a valid warehouse ID from Blast Ramp.

        • + - createdBy
          • Required
          • Field Type : String(255)
          • Name of Person or Process, to be identified as the creator of the order.
        • + - repName

          • Optional

            Field Type : String(50)

            Name of Sales Rep to be associated with the order.

            If applicable, this value should match exact rep name entered in Blast Ramp for reporting/commission purposes.

        • + - currency
          • Optional
          • Field Type : String. Must be a valid price list code from Blast Ramp
          • If not set, the order gets the default order price list as configured in Blast Ramp.
        • + - orderDate
          • Required
          • Field Type : String.  Format YYYY-MM-DD HH:mm:ss
          • This field acts as a timestamp for when the order was placed.
        • + - startDate

          • Required

            Field Type : String. Format YYYY-MM-DD

            This field defines the earliest date the order is expected to be released to the warehouse for processing.

        • + - cancelDate
          • Required
          • Field Type : String. Format YYYY-MM-DD
          • This field defines the latest date the order is expected to be released to the warehouse.
        • + - expectedShipDate
          • Optional
          • Field Type : String format YYYY-MM-DD
          • Preferred shipping date.
        • + - orderDiscount

          • Optional

            Field Type : String, formatted as a numeric value, optionally preceded by a '%', or '$' symbol.

            If the '%' character is passed it will be calculated as a percentage against the total value of goods, otherwise, the discount will be applied as a dollar value.

        • + - discountNote
          • Optional
          • Field Type : String(250)
          • Description of the reason for the discount
        • + - orderCredit
          • Optional
          • Field Type : String, formatted as a numeric value, optionally preceded by '$' symbol.
          • This field defines the value of credit to be applied towards the order.
        • + - creditNote
          • Optional
          • Field Type : String(250)
          • Description of the reason for the discount
        • + - orderTerms

          • Optional

            Field Type : String(50)

            This field defines the Order Terms to be applied to the order.  If this field is not passed, the web service attempts to pull Default Order Terms from the related customer profile.  If this isn't possible, it will defaults to 'Terms Unknown'.

            Suggested values : 'Web Order','Credit Card','Net 60' etc.

        • + - orderTax

          • Optional

            Field Type : String. Formatted as a numeric value, optionally preceded by a '%', or '$' symbol.

            This field defines the tax to be applied to the order.  If this field is left off, the web service tries to determine a default tax rate to apply.  It will look for a customer default to use if it exists, if not, it will check for a portal default to apply.  If it fails to find any defaults, it will leave the tax rate at 0%

            If the '%' symbol is present, the web service will pass the value in as is.  If not, it will compare the dollar value of the tax, against the total value of goods on the order, and convert the tax to a percentage based on that.  It is recommended to pass it as a percentage.

        • + - freightCharge

          • Optional

            This field defines the value charged to end customer for freight.  If this value is passed in, normal Blast Ramp process will avoid overwitting this charge.

        • + - freightTax

          • Optional

            Field Type : String. Formatted as a numeric value, optionally preceded by a '%', or '$' symbol.

            This field defines the tax to be applied to the shipping charges on the order.  If this field is left off, the web service tries to determine a default tax rate to apply.  It will look for a customer default to use if it exists, if not, it will check for a portal default to apply.  If it fails to find any defaults, it will leave the tax rate at 0%

            If the '%' symbol is present, the web service will pass the value in as is.  If not, it will compare the dollar value of the tax, against the freight charge on the order, and convert the tax to a percentage based on that.  It is recommended to pass it as a percentage.

            Please note, an error will be thrown if you pass in a $0 freight charge, and a dollar value for the freight tax.

        • + - freightService

          • Optional

            Field Type : String(200)

            This optional field defines the shipping method to use.

            If this field is not set on the incoming call, it checks for a customer default. If no default can be found, it will be left empty on the order in Blast Ramp.

            Suggested values :Rate Shop, Prepaid Ground, Collect Express, etc

        • + - carrier
          • Optional
          • Field Type : String(150)
          • This field defines the preferred carrier to use for shipping this order.
          • Fedex, Purolator etc
        • + - notes
          • Optional
          • Field Type : String(1000)
          • This field defines any order notes, or instructions that are to be attached to the order.
        • + - custom1
          • Optional
          • Field Type : String(255)
          • This field defines a value for a custom field, that is different for each Blast Ramp portal.  
          • + - custom1
            • Optional
            • Field Type : String(255)
            • This field defines a value for a custom field, that is different for each Blast Ramp portal.  
        • + - custom2
          • Optional
          • Field Type : String(255)
          • This field defines a value for a custom field, that is different for each Blast Ramp portal.  
          • + - custom1
            • Optional
            • Field Type : String(255)
            • This field defines a value for a custom field, that is different for each Blast Ramp portal.  
        • + - custom3
          • Optional
          • Field Type : String(255)
          • This field defines a value for a custom field, that is different for each Blast Ramp portal.  
          • + - custom1
            • Optional
            • Field Type : String(255)
            • This field defines a value for a custom field, that is different for each Blast Ramp portal.  
        • + - custom4
          • Optional
          • Field Type : String(255)
          • This field defines a value for a custom field, that is different for each Blast Ramp portal.  
          • + - custom1
            • Optional
            • Field Type : String(255)
            • This field defines a value for a custom field, that is different for each Blast Ramp portal.  
        • + - custom5
          • Optional
          • Field Type : String(255)
          • This field defines a value for a custom field, that is different for each Blast Ramp portal.  
          • + - custom1
            • Optional
            • Field Type : String(255)
            • This field defines a value for a custom field, that is different for each Blast Ramp portal.  
      • Items[]
        • Item
          • + - sku

            • Required

              Field Type : String(50)

              This field defines the SKU assigned to the item on the order. This must match an existing SKU within Blast Ramp.

          • + - quantity
            • Required
            • Field Type : Integer
            • This field defines the number of units of a given item on the order.
          • + - price

            • Optional

              Field Type : Decimal(16,2)

              If this value is not passed, Blast Ramp will use the price entered into Blast Ramp, using the same price list as was provided in the Details->currency field.

          • + - lineNote
            • Optional
            • Field Type : String(250)
            • This field can be used to pass information to the warehouse on a per item basis.
          • + - timeta
            • Optional
            • Field Type : Integer
            • If available, this value can be passed in to identify which carton a give product is in.