Documentation
Order Statuses
Use this service if you would like to receive your order statuses.
Function: getStatuses()
The following parameters are accepted (parameters with a
* are required):
- customerNumber*: the Hit customer number.
- userCredential*: the key given to you when your registration was approved.
- orderNumber: the specific order number for which to receive an order status.(Optional param)
(If specified, this order will be searched, additionally the min and max dates if set will be used in the search query)
- poNumber: the specific purchase order number for which to receive an order status. (Optional param)
(If specified, this order will be searched, additionally the min and max dates if set will be used in the search query)
- minDate: the minimum date for the range (in yyyy-mm-dd format) for the order date.(Optional param)
- maxDate: the maximum date for the range (in yyyy-mm-dd format) for the order date. (Optional param)
(max date cannot be set without min date being specified)
****Note: There is a requirement to set at least one of the optional parameters: orderNumber, poNumber, or minDate.
You will receive the following data for each order status found:
- customerNumber: the Hit customer number.
- poNumber: the purchase order number.
- orderNumber: the Hit order number.
- status: the order status.
- orderDate: the order date (in yyyy-mm-dd format).
- shipDate: the scheduled ship date (in yyyy-mm-dd format).
Order Status Code List
Use this service if you would like to receive a list of all possible order statuses.
Function: getStatusCodeList()
The following parameters are accepted (parameters with a
* are required):
- customerNumber*: the Hit customer number.
- userCredential*: the key given to you when your registration was approved.
You will receive the following data for each order status found:
- code: the status code.
- description: the description of the status.
- promoStandardsCode: the Promo Standards code for the status.
Order Confirmations
Use this service if you would like to see what orders were entered for a particular date.
Function: getConfirmations()
The following parameters are accepted (parameters with a
* are required):
- customerNumber*: the Hit customer number.
- userCredential*: the key given to you when your registration was approved.
- date*: the date (in yyyy-mm-dd format).
You will receive the following data for each order found:
- customerNumber: the Hit customer number.
- poNumber: the purchase order number.
- orderNumber: the Hit order number.
Shipping Quote
Use this service if you would like to receive a shipping quote.
Function: getRates()
The following parameters are accepted (parameters with a
* are required):
- customerNumber*: the Hit customer number or username.
- userCredential*: the key given to you when your registration was approved.
- productNumber*: the product number.
- quantity*: the quantity.
- destZip*: the delivery zip code.
Please see type "Shipping Quote" in the WSDL for the response structure.
Advance Shipments
Use this service if you would like to receive advance shipment information for orders.
Function: getAdvanceShipments()
The following parameters are accepted (parameters with a
* are required):
- customerNumber*: the Hit customer number.
- userCredential*: the key given to you when your registration was approved.
- date*: the date (in yyyy-mm-dd format).
You will receive the following data for each shipment:
- customerNumber: the Hit customer number.
- poNumber: the purchase order number.
- orderNumber: the Hit order number.
- trackingNumber: the tracking number.
- service: the shipping service.
- zipCode: the destination zip code.
Order Shipments
Use this service if you would like to receive shipment information for an order.
Function: getOrderShipments()
The following parameters are accepted (parameters with a
* are required):
- customerNumber*: the Hit customer number.
- userCredential*: the key given to you when your registration was approved.
- poNumber*: the purchase order number.
You will receive the following data for each shipment:
- customerNumber: the Hit customer number.
- poNumber: the purchase order number.
- orderNumber: the Hit order number.
- trackingNumber: the tracking number.
- service: the shipping service.
- zipCode: the destination zip code.
Inventory Levels
Use this service if you would like to receive inventory levels for our products.
Function: getLevels()
The following parameters are accepted (parameters with a
* are required):
- customerNumber*: the Hit customer number or username.
- userCredential*: the key given to you when your registration was approved.
- productNumber*: the product number.
- includeOutlet: whether or no to include closeout inventory - defaults to false.
You will receive the following data:
- productNumber: the product number.
- productColorInventories: an array of inventory levels grouped by color.
Invoices
Use this service if you would like to receive your invoices.
Available Functions
Function: getInvoices()
The following parameters are accepted (parameters with a
* are required):
- customerNumber*: the Hit customer number.
- userCredential*: the key given to you when your registration was approved.
- invoiceNumber: the specific invoice number for which to receive an invoice.
- orderNumber: the specific Hit order number for which to receive an invoice.
- poNumber: the specific purchase order number for which to receive an invoice.
- fromDate: the from date for the range (in yyyy-mm-dd format) for the invoice date.
- toDate: the to date for the range (in yyyy-mm-dd format) for the invoice date.
You must provide an invoice number, order number, PO number, or from date. To date can be used if from date is given.
You will receive the following data for each invoice found:
- number: the invoice number.
- orderNumber: the Hit order number.
- orderSuffix: the Hit order suffix.
- poNumber: the purchase order number.
- customerNumber: the Hit customer number.
- invoiceDate: the iinvoice date.
- terms: the Hit customer number.
- mailToName: the mail-to name.
- mailToAddress1: the mail-to address line 1.
- mailToAddress2: the mail-to address line 2.
- mailToAddress3: the mail-to address line 3.
- mailToCity: the mail-to city.
- mailToState: the mail-to state.
- mailToCountry: the mail-to country.
- mailToZip: the mail-to zip.
- mailToCarrier: the mail-to carrier.
- subtotal: the invoice subtotal.
- freight: the freight amount.
- tax: the tax amount.
- total: the invoice total.
- shipToName: the ship-to name.
- shipToAddress1: the ship-to address liine 1.
- shipToAddress2: the ship-to address liine 2.
- shipToAddress3: the ship-to address liine 3.
- shipToCityStateZip: the ship-to city, state, zip.
- status: the status.
- type: the type.
-
items: an array of the following:
- shippedQuantity: the quantity shipped.
- item: the item.
- description: the item description.
- unitPrice: the item's unit price.
- extAmount: the item's extended amount (quantity x unit price).
- sequenceNumber: the item's sequence number.
Function: getInvoicesByInvoiceNumber()
The following parameters are accepted (parameters with a
* are required):
- customerNumber*: the Hit customer number.
- userCredential*: the key given to you when your registration was approved.
- invoiceNumber*: the specific invoice number for which to receive an invoice.
See the
getInvoices() function for the return type description.
Function: getInvoicesByOrderNumber()
The following parameters are accepted (parameters with a
* are required):
- customerNumber*: the Hit customer number.
- userCredential*: the key given to you when your registration was approved.
- orderNumber*: the specific Hit order number for which to receive an invoice.
See the
getInvoices() function for the return type description.
Function: getInvoicesByPoNumber()
The following parameters are accepted (parameters with a
* are required):
- customerNumber*: the Hit customer number.
- userCredential*: the key given to you when your registration was approved.
- poNumber*: the specific purchase order number for which to receive an invoice.
See the
getInvoices() function for the return type description.
Function: getInvoicesByDate()
The following parameters are accepted (parameters with a
* are required):
- customerNumber*: the Hit customer number.
- userCredential*: the key given to you when your registration was approved.
- fromDate*: the from date for the range (in yyyy-mm-dd format) for the invoice date.
- toDate: the to date for the range (in yyyy-mm-dd format) for the invoice date.
See the getInvoices() function for the return type description.
Function: getInvoicesByPoNumber()
The following parameters are accepted (parameters with a
* are required):
- customerNumber*: the Hit customer number.
- userCredential*: the key given to you when your registration was approved.
- poNumber*: the specific purchase order number for which to receive an invoice.
See the
getInvoices() function for the return type description.
Function: getCustomerPaymentTerms()
The following parameters are accepted (parameters with a
* are required):
- id*: the Hit customer number.
- credentials*: the key given to you when your registration was approved.
- customerNumber*: the customer number
You will receive the payment terms for the customer returned.
Function: getInvoiceBasicFull()
The following parameters are accepted (parameters with a
* are required):
- customerNumber*: the Hit customer number.
- userCredential*: the key given to you when your registration was approved.
- invoiceNumber: the specific invoice number for which to receive an invoice data.
- division: the division number.
- offset: the number of the records to skip from beginning.
- limit: the number of the records to request.
- field: the field to sort (all lowercase letters. E.G. invoicedate).
- sortOrder: the sort order (ASC, DESC).
You will receive the following data:
-
invoiceBasicFull: an array of the items.
- item: an array of the following:
- number: the invoice number.
- total: the total amount.
- orderNumber: the order number.
- poNumber: the PO number.
- invoiceDate: the invoice date.
- invoiceType: the invoice type.
- division: the invoice division.
- applied: the applied amount.
- status: the invoice status.
totalNumOfInvoices: the total number of the invoices (items) without the limit.
Active Products
Use this service to get a list of active products.
Function: getActiveProducts()
The following parameters are accepted (parameters with a
* are required):
- customerNumber*: the Hit customer number or username.
- userCredential*: the key given to you when your registration was approved.
- includeOutletAndCustom: whether or no to include closeout and custom product numbers - defaults to false.
You will receive the following data:
- number: the product number
- domain: the domain of the product. The possible values here are CATALOG, CUSTOM, OUTLET
Product Info
Use this service if you would like to receive product info for any of our current products.
Function: getInfo()
The following parameters are accepted (parameters with a
* are required):
- customerNumber*: the Hit customer number or username.
- userCredential*: the key given to you when your registration was approved.
- productNumber*: the product number.
- outlet: boolean used to check outlet domain, default = false.
You will receive the following data:
- number: the product number.
- productUrl: URL of the product on hitpromo.net.
- name: the product name.
- categories: primary categories.
- subcategories: secondary categories.
- descriptions: product descriptions with highlights.
- properties: various product properties, which may include product dimensions, imprint areas, colors, packaging, and costs.
- pricingGrid: prices with quantities, price-breaks, and discount levels, grouped by imprint types.
- images: URLs of hi-res images.
- mainImage: URLs of hi-res main image.
- colors: product colors.
- weightLbs: the weight of the product - use this field with weightPer (below) to get unit weight.
- weightPer: the quantity of product for the weight above.
Product Images
Use this service if you would like to receive product images for any of our current products.
Function: getImages()
The following parameters are accepted (parameters with a
* are required):
- customerNumber*: the Hit customer number or username.
- userCredential*: the key given to you when your registration was approved.
- productNumber*: the product number.
You will receive the following data:
- all: an array of all the hi-res image URLs.
- main: hi-res image URL for the main image.
Product Colors
Use this service if you would like to receive product colors for any of our current products.
Function: getColors()
The following parameters are accepted (parameters with a
* are required):
- customerNumber*: the Hit customer number or username.
- userCredential*: the key given to you when your registration was approved.
- productNumber*: the product number.
- includeOutlet: whether or not to include closeout colors - defaults to false.
You will receive the following data for each color (in an array of ProductColorData objects):
- color_id: the color ID.
- part_number: the part number (7050BLK).
- product_number: the product number (7050).
- color: the color name (Black).
Product Sizes
Use this service to get the manufactured sizes for a Hit product.
Function: getProductSizes()
The following parameters are accepted (parameters with a
* are required):
- customerNumber*: the Hit customer number or username.
- userCredential*: the key given to you when your registration was approved.
- productNumber*: the product number.
You will receive an object in the response which contains the following:
- productNumber: the requested product number.
- sizes: an array of the product's manufactured sizes. This will be an empty array if the product has no sizes.
Product Setup Charges
Use this service if you would like to receive product setup charges for any of our current products.
Function: getSetupCharges()
The following parameters are accepted (parameters with a
* are required):
- customerNumber*: the Hit customer number or username.
- userCredential*: the key given to you when your registration was approved.
- productNumber*: the product number.
You will receive an array of the following data:
- decoration_code: Decoration method code.
- decoration: Full decoration name.
- setup_charge: Decoration setup charge per location - one color included.
- run_charge: Decoration run charge per piece.
- extra_color_charge: Extra charge per decoration color beyond the first.
- extra_location_charge: Extra charge per decoration location beyond the first.
Product Packing Data
Use this service to get the packing information for a Hit product.
Function: getProductPackingData()
The following parameters are accepted (parameters with a
* are required):
- customerNumber*: the Hit customer number or username.
- userCredential*: the key given to you when your registration was approved.
- productNumber*: the product number.
You will receive an object in the response which contains the following:
- productNumber: the requested product number.
- quantityPerBox: the quantity of items per box
- weight: The weight of the box.
- boxLength: The length of the box.
- boxWidth: The width of the box.
- boxHeight: The height of the box.
Product Art Templates
Use this service to get the art templates for a product.
Function: getProductArtTemplates()
The following parameters are accepted (parameters with a
* are required):
- customerNumber*: the Hit customer number or username.
- userCredential*: the key given to you when your registration was approved.
- productNumber*: the product number.
You will receive an array with the urls to download each art template available for the product
Product Last Modified
Use this service if you would like to receive the times for all of the latest product updates.
Function: getLastModified()
The following parameters are accepted (parameters with a
* are required):
- customerNumber*: the Hit customer number or username.
- userCredential*: the key given to you when your registration was approved.
You will receive the following data for all active products:
- number: the product number.
- timeModified: Unix timestamp of the last time any data was modified for that particular product.
Top Sellers
Use this service if you would like to receive our top sellers.
Function: getTopSellers()
The following parameters are accepted (parameters with a
* are required):
- customerNumber*: the Hit customer number or username.
- userCredential*: the key given to you when your registration was approved.
- count: how many products returned, default = 50, max = 50.
You will receive the following data for sales and quantity, sorted by sales and quantity:
- product: the product number.
- description: product description.
Outlet Products
Use this service if you would like to receive a list of our active products that are in outlet.
Function: getOutletProductList()
The following parameters are accepted (parameters with a
* are required):
- customerNumber*: the Hit customer number or username.
- userCredential*: the key given to you when your registration was approved.
You will receive the following data for all active products in outlet:
- number: the product number.
- name: the product name.
Is Product Rush?
Use this service find out if a product is eligible for rush service.
Function: isProductRush()
The following parameters are accepted (parameters with a
* are required):
- customerNumber*: the Hit customer number or username.
- userCredential*: the key given to you when your registration was approved.
- productNumber*: the product number.
You will receive an object in the response which contains the following:
- productNumber: the requested product number.
- isRush: a boolean that lets you know if this product is rush eligible
List of deactivated products
Use this service to get a list of deactivated products.
Function: getProductsDeactivated()
The following parameters are accepted (parameters with a
* are required):
- customerNumber*: the Hit customer number or username.
- userCredential*: the key given to you when your registration was approved.
You will receive an array of objects in the response which contains the following:
- variation: The variation that got discontinued ex : 3041RED.
- partNumber: The part number ex: 3041
- deactivatedDate: The date the variation got deactivated
PIP3A4
Use this service if you would like to configure a product in PIP3A4
To configure a Product two elements (pair) must be present: The segment name and its corresponding value. A product could have just one pair(segment → value) or many pairs.
There are some segments that the corresponding values are setup by Hit Promotional. There are other segments that are the user choice. (free text)
Remember: If there is a Segment then there is a value. Values could be predefined by HIT or could be a Customer option.
Available Functions
Function: getSegmentsAndDescription()
The following parameters are accepted (parameters with a
* are required):
- customerNumber*: the Hit customer number.
- userCredential*: the key given to you when your registration was approved.
These are the only valid segments to use in the Configuration of a Product.
Select a segment from this table. If there is a Segment Link means a Hit value have to be choose.
- segment:The segment
- description:The description for the segment
- segmentlink:The link to the segment
Function: getColorsByProduct()
The following parameters are accepted (parameters with a
* are required):
- customerNumber*: the Hit customer number.
- userCredential*: the key given to you when your registration was approved.
- productNumber*: The product number ex: 5750 Product number should not have the # sign
These are the color values allow to match the segment. The linker of the segment must be the same linker for this value.
- product:The product
- product_descrp:The description of the product
- color_value:The value of the color
- color_descrp:The description of the color
- segment_link:The link to the segment
Function: getImprintLocations()
The following parameters are accepted (parameters with a
* are required):
- customerNumber*: the Hit customer number.
- userCredential*: the key given to you when your registration was approved.
- productNumber*: The product number ex: 5750 Product number should not have the # sign or be zero padded
These are the color values allow to match the segment. The linker of the segment must be the same linker for this value.
- location_description:The description of the location
- imprint_value:The value of the imprint
- segment_link:The link to the segment
Function: getOrderType()
The following parameters are accepted (parameters with a
* are required):
- customerNumber*: the Hit customer number.
- userCredential*: the key given to you when your registration was approved.
You will receive the following data for each order type:
- order_value:The value of the order
- segment_link:The link to the segment
- order_description:The description of the order
Function: getDisplayProcess()
The following parameters are accepted (parameters with a
* are required):
- customerNumber*: the Hit customer number.
- userCredential*: the key given to you when your registration was approved.
- productNumber*: The product number ex: 5750 Product number should not have the # sign or be zero padded
You will receive the following data for each process:
- process_value:The value of the process
- segment_link:The link to the segment
- process_description:The description of the process
Function: getLids()
The following parameters are accepted (parameters with a
* are required):
- customerNumber*: the Hit customer number.
- userCredential*: the key given to you when your registration was approved.
You will receive the following data for each lid:
- lid_value:The value of the lid
- segment_link:The link to the segment
- lid_description:The description of the lid
Function: getCarrierCodes()
The following parameters are accepted (parameters with a
* are required):
- customerNumber*: the Hit customer number.
- userCredential*: the key given to you when your registration was approved.
You will receive the following data for each carrier:
- carrier_code:The carrier code, which is an internal code we use to know which carrier is being referenced
- abbreviation:The abbreviation of the carrier
- carrier_name:The name of the carrier
- valid_carrier:Is it a valid carrier Y/N
Function: getCompanionProducts()
The following parameters are accepted (parameters with a
* are required):
- customerNumber*: the Hit customer number.
- userCredential*: the key given to you when your registration was approved.
- productNumber*: The product number ex: 5750 Product number should not have the # sign or be zero padded
You will receive an array of PipCompanionProduct:
- companion_product:The companion product assosciated to the product being queried
Function: getSizesByColorAndPart()
The following parameters are accepted (parameters with a
* are required):
- customerNumber*: the Hit customer number.
- userCredential*: the key given to you when your registration was approved.
- productNumber*: The product number ex: 5750 Product number should not have the # sign or be zero padded
- color*: Valid color accepted by our ERP ex: BLK, AQBLU, GRN etc
You will receive an array of PartSize:
- size:Valid ERP size ex: XL, M, 2XL etc
- sku:Valid SKU that can be used for ordering ex : 0PC54YAQBLUM
Product Object
Use this service if you would like to receive product info for any of our current products. This service is tailor made for clients which
auto generate stubs based on the wsdl. The data types returned should be compatible with any given client.
Available Functions
Function: getInfo()
Use this service if you would like to receive product info for any of our current products.
The following parameters are accepted (parameters with a
* are required):
- customerNumber*: the Hit customer number or username.
- userCredential*: the key given to you when your registration was approved.
- productNumber*: the product number.
- outlet: boolean used to check outlet domain, default = false.
You will receive the following data:
- number: the product number.
- productUrl: URL of the product on hitpromo.net.
- name: the product name.
- categories: primary categories.
- subcategories: secondary categories.
- descriptions: product descriptions with highlights.
- properties: various product properties, which may include product dimensions, imprint areas, colors, packaging, and costs.
- pricingGrid: prices with quantities, price-breaks, and discount levels, grouped by imprint types.
- images: URLs of hi-res images.
- mainImage: URLs of hi-res main image.
- colors: product colors.
- weightLbs: the weight of the product - use this field with weightPer (below) to get unit weight.
- weightPer: the quantity of product for the weight above.
Function: getImages()
Use this service if you would like to receive product images for any of our current products.
The following parameters are accepted (parameters with a
* are required):
- customerNumber*: the Hit customer number or username.
- userCredential*: the key given to you when your registration was approved.
- productNumber*: the product number.
You will receive the following data:
- all: an array of all the hi-res image URLs.
- main: hi-res image URL for the main image.
Function: getSetupCharges()
Use this service if you would like to receive product setup charges for any of our current products.
The following parameters are accepted (parameters with a
* are required):
- customerNumber*: the Hit customer number or username.
- userCredential*: the key given to you when your registration was approved.
- productNumber*: the product number.
You will receive an array with the following data:
- decoration_code: Decoration method code.
- decoration: Full decoration name.
- setup_charge: Decoration setup charge per location - one color included.
- run_charge: Decoration run charge per piece.
- extra_color_charge: Extra charge per decoration color beyond the first.
- extra_location_charge: Extra charge per decoration location beyond the first.
Function: getLastModified()
Use this service if you would like to receive the times for all of the latest product updates.
The following parameters are accepted (parameters with a
* are required):
- customerNumber*: the Hit customer number or username.
- userCredential*: the key given to you when your registration was approved.
You will receive the following data for all active products:
- number: the product number.
- timeModified: Unix timestamp of the last time any data was modified for that particular product.
Function: getTopSellers()
Use this service if you would like to receive our top sellers.
The following parameters are accepted (parameters with a
* are required):
- customerNumber*: the Hit customer number or username.
- userCredential*: the key given to you when your registration was approved.
- count: how many products returned, default = 50, max = 50.
You will receive the following data for sales and quantity, sorted by sales and quantity:
- product: the product number.
- description: product description.
Order Shipment
Use this service, if you would like to create an order header, update a shipping destination, add/update multi shipping
address and change a ship method.
Available Functions
The following parameters are accepted (parameters with a
* are required):
- userCredential*: The key given to you when your registration was approved.
- customerNumber*: The Hit customer number.
- purchaseOrderNumber*: The Purchase Order Number you want to use (Max of 20 chars)
- user*: The name of the user requesting the creation of the order header (Max of 10 chars)
- dups*: Possible values are 'Y' or 'N' . 'Y' = Allow dups PO# for that Customer. 'N' = don’t allow dups
- comments*: Any comments that needs to be added(Max of 74 chars)
This method will create an order header and will return a sales order number as an response.
- salesOrderNumber:The sales order number created from creating the order header. On failure
there will be a soap fault exception.
Function: updateShippingDestination()
The following parameters are accepted (parameters with a
* are required):
- userCredential*: The key given to you when your registration was approved.
- customerNumber*: The Hit customer number.
- salesOrderNumber*: The sales order number to update.
- suffix*: Back order level (Max of 2 chars)
- contactName*: The contact name for shipping address (Max of 30 chars).
- address1*: The address line 1 for the shipping address (Max of 30 chars).
- address2*: The address line 2 for the shipping address (Max of 30 chars).
- address3*: The address line 3 for the shipping address (Max of 30 chars).
- city*: The city for the shipping address (Max of 18 chars).
- state*: The state for the shipping address (Max of 2 chars).
- zip*: The zip for the shipping address (Max of 6 chars).
- user*: The name of the user requesting the creation of the order header (Max of 10 chars)
This method will update the shipping destination for a given sales order. On success it will return a 1 else a soapFault.
Function: addUpdateShippingDestination()
The following parameters are accepted (parameters with a
* are required):
- userCredential*: The key given to you when your registration was approved.
- customerNumber*: The Hit customer number.
- salesOrderNumber*: The sales order number to update.
- contactName*: The contact name for shipping address (Max of 30 chars).
- address1*: The address line 1 for the shipping address (Max of 30 chars).
- address2*: The address line 2 for the shipping address (Max of 30 chars).
- address3*: The address line 3 for the shipping address (Max of 30 chars).
- city*: The city for the shipping address (Max of 18 chars).
- state*: The state for the shipping address (Max of 2 chars).
- zip*: The zip for the shipping address (Max of 6 chars).
- quantity*: The quantity of the item in the PO (Max of 10 chars).
- country*: The country for the shipping address (Max of 2 chars).
- user*: The name of the user requesting the creation of the order header (Max of 10 chars)
- sequence*: The sequence of the shipping destination to update ex: 1,2,3 ...(Max of 3 chars).
- carrier*: The carrier for shipping(Max of 5 chars).
- instructions*: The instructions for shipping (Max of 20 chars).
- whatToDo*: Possible values are 'A' and 'D'. “A” to add a new destination, “U” to update fields . Update replace existent data with new data (Max of 1 chars).
This method will update/delete the shipping destination for a given sales order. On success it will return a 1 else a soapFault.
Function: changeShipMethod()
The following parameters are accepted (parameters with a
* are required):
- userCredential*: The key given to you when your registration was approved.
- customerNumber*: The Hit customer number.
- salesOrderNumber*: The sales order number to update.
- suffix*: Back order level (Max of 2 chars)
- carrier*: The carrier for shipping(Max of 5 chars).
- user*: The name of the user requesting the creation of the order header (Max of 10 chars)
This method will change the ship method for a given sales order. On success it will return a 1 else a soapFault.
Pricing
Use this service if you would like to get the product pricing based on your customer number.
This service returns the product price and additional charges if any for the product based on the customer number.
Available Functions
Function: getProductPricing()
The following parameters are accepted (parameters with a
* are required):
- customerNumber*: the Hit customer number.
- userCredential*: the key given to you when your registration was approved.
- product*: the product to query for pricing. Please append a #sign before the product number ex (#1001).
If you pass a SKU like (#7050BLK) , it will not return results, this param requires the raw product number like (#C5U)
- pricingType*: pass either 'D' for decoration pricing, 'S' for sample pricing and 'B' for blank pricing
The response will have an array of of the ProductPrice which contains the price a product can have and an array of AdditionalCharge which
is the additional charges that will be added based on the product configuration requested
-
ProductPrice: an array of the following:
- product: the product being queried.
- price: the price of the product.
- quantity: the unit to use for pricing (ex if you get 1, that means cost of the product is $XX per 1 unit).
- customerDiscount: the discount the customer will get for the product as a decimal.
- pricingCategory: the list price category like EQPMIS.
-
AdditionalCharge: an array of the following:
- chargeName: the name of the charge.
- chargeDescription: the description of the charge.
- additionalChargeAmount: The charge amount.
Order Detail
Use this service if you would like to get the order details based on your customer number, Hit order number. You can
also use this service to get the hit orders created in the system for a hit order number.
Available Functions
Function: getHitOrdersFromPoNumber()
The following parameters are accepted (parameters with a
* are required):
- customerNumber*: the Hit customer number.
- userCredential*: the key given to you when your registration was approved.
- Purchase Order*: The Purchase Order that you supplied, that is in our system
The response will have an array of HitOrder objects which contains the hit order number, the entered date of the order, as you might have sent
the same PO number in the past, is this is a back order or not and the order suffix , which if greater than 0 is a back order.
-
HitOrder: an object of the following:
- customerNumber: the customer number that created this order
- hitOrderNumber: the hit order number.
- hitOrderSuffix: the hit order suffix which if greater than 0 means a back order
- purchaseOrderNumber: the purchase order number part of the hit order.
- orderEnteredDate: the order entered date in ISO
- isBackOrder: boolean flag letting you know if this is a back order or not
Function: getProductsPerHitOrder()
The following parameters are accepted (parameters with a
* are required):
- customerNumber*: the Hit customer number.
- userCredential*: the key given to you when your registration was approved.
- Hit Order Number*: The Hit Order Number
The response will have an array of HitOrderDetail objects which contains the line number, the product, the product color, the product size
and the order quantity.
-
HitOrderDetail: an object of the following:
- lineNumber: the line number in our system
- productNumber: the product number.
- orderQuantity: the order quantity
- productColor: the product color.
- productSize: the product size
Get In Hands date estimate
Calculates the in hands date based on the transit time in shi[pping method and production time for the product by
taking into account
business days and Hit holidays. The rush time in transit overrides the default production time for the product.
Function: getInHandsDate()
The following parameters are accepted (parameters with a
* are required):
- customerNumber*: the Hit customer number or username.
- userCredential*: the key given to you when your registration was approved.
- transitDays*: the transit days in shipping service.
- productNumber*: the product number.
- rushTime: Pass the rush service in days ex: 1 for 1-Day Rush, this will override the default production
time for the product
You will receive an object in the response which contains the following:
- inHandsDate: the calculated inhands date (Takes in account Hit Holidays).
- productionTimeInCalculation: Number of production days taken into account for the product
Submit Order to Hit
Use this service if you would like to submit an order to Hit.
Function: submitOrder()
The following parameters are accepted (parameters with a
* are required):
- customerNumber*: the Hit customer number.
- userCredential*: the key given to you when your registration was approved.
- poNumber*: The Purchase Order Number
- payload*: Needs to be base 64 encoded xml payload(the raw xml needs to be transformed in to base 64
encoded data)
You will receive the following data for each order found:
- orderSubmitted: the Hit customer number.
- submissionTime: the purchase order number.
- orders: the Hit order numbers(It is an object that contains order numbers and errors)- Refer schema.
- errorMessage: IF any errors occurred(if this is filled, no order got created)
Check if PO is already on Hit
Use this service if you would like to check if your PO is already on Hit.
Function: checkPoIsDuplicate()
The following parameters are accepted (parameters with a
* are required):
- id*: the Hit customer number.
- credential*: the key given to you when your registration was approved.
- poNumber*: The Purchase Order Number
- customerNumber*: Special internal use.
You will receive the following data for each order found:
- errorMessage: if any errors occurred.
- customerNumber: the customer number.
- orderNumber: the Hit order number for PO number.
- isDuplicate: true/false if po is duplicate