Hit Xml Documentation

Hit Promotional Purchase Order Xml document structure description

PurchaseOrder: Root element.

DocVersion: Hit Xml Document version. The current version is 1.00.
PurchaseOrderNumber: Customer's Purchase Order Number.
SalesQuote: Hit Assigned Sales Quote.
PurchasOrderRemarks: Purchase Order Remarks. Any notes regarding the order.
CustomerInformation: Customer Information Block.

CustomerNumber: Customer's Hit Assigned Account Number.
CompanyName: Customer's Company Name.
CustomerFollowupInformation: Customer Contact Block.

FollowupName: Customer Contact Name.
FollowupEmail: Customer Contact Email.
FollowupPhone: Customer Contact Phone.

Shipments: Shipments Block.
- Shipment: Shipment Block. Multiple shipments will have multiple instances of this tag.
  - ShipToName: Either Business Name or Individual to ship to.
  - AttentionTo: Shipment Attention To Name.
  - Address1: Address 1 Line to ship to.
  - Address2: Address 2 Line (optional).
  - Address3: Address 3 Line (optional).
  - Address4: Address 4 Line (optional).
  - City: City Name to ship to.
  - State: State/Province Name. E.G.: US-FL or CA-ON. ISO 3166-2:US For United States, ISO 3166-2:CA For Canada, Etc. See https://www.iso.org/iso-3166-country-codes.html for details.
  - Country: Country Name. Use ISO 3166-1 Alpha 3 Codes. See https://www.iso.org/iso-3166-country-codes.html for details.
  - Zip: Postal code.
  - Remarks: Shipment Remarks.
  - ShippingMethod: Shipping Method Block.
    - Carrier: Carrier Code. Needs to be populated from our soap service or excel dump. Use getCarrierCodes() SOAP request
    - ShippingAccountNumber: Account Number if shipping Third Party
    - ShippingDate: Expected Shipping Date. The date format: yyyy-mm-dd
    - InHandsDate: Expected In Hands Date. The date format: yyyy-mm-dd
    - Remarks: Shipment Method Remarks.
  - ShipQuote: Optional Hit Assigned Shipping Quote Block.
    - QuoteID: Hit Assigned Quote ID.
    - Amount: Shipping Quote Amount.
  - ShipQuantity: Quantity to Ship.
  - ProductLineNumber: Product Line Number. Corresponding <Product> tag number: The first product has 1 as product line number, 2 for second,... etc.
Products: Products to order block.
- Product: Product Block. Multiple products will have multiple instances of this tag filled out.
  - ProductSKU: Product Part ID. Needs to be populated from our soap service or excel dump. Use Promostandards Product Data getProduct() SOAP request
  - Quantity: E.G.: 100. Quantity to Order.
  - UnitPrice: E.G.: 1.05. Unit Price in currency from <Currency> node.
  - TotalCost: E.G.: 105.00. Total Cost in currency from <Currency> node.
  - SetupCharge: E.G.: 25.00. Setup Charge in currency from <Currency> node. If you feel like there should be no setup charge, leave this field blank or 0.
  - SalesOrderType: Must be Decorated or Sample or Blank (not decorated) or Closeout.
  - PreProductionProof: Must be True or False! This would be for a physical sample of the item.
  - PaperProof: Paper Proof Block.
    - PaperProofRequired: Must be True or False.
    - PaperProofEmailAddress: Email Address for Paper Proof.
  - OrderType: Order Type Block.
    - OrderTypeValue: Must be New or Repeat or Refer.
    - PreviousOrderInformation: Previous Order Information Block. Only to be filled if it is a Repeat or Refer order.
      - PreviousPurchaseOrder: Previous Purchase Order Number.
      - PreviousPurchaseOrderDate: Previous Purchase Order Date. The date format: yyyy-mm-dd
  - Imprints: Imprints Block
    - Imprint: Imprint Block. You can put multiple imprint tags with the structure below, for multi imprint orders. You have to verify from our soap services or excel dump, how many imprint locations are possible for this product. Use Promostandards Product Pricing and Configuration getAvailableLocations() SOAP request
  - Charges: Charges Block
    - Charge: Charge Block. Any charges except Setup Charge. If multiple charges, then repeat charge tag.
      - ChargeCode: Charge ID. Needs to be populated from our soap service or excel dump. Use Promostandards Product Pricing and Configuration getConfigurationAndPricing() SOAP request
      - ChargeValue: E.G.: 0.05. Charge in currency from <Currency> node.
      - ChargeQty: E.G.: 100. Quantity of the charge.
      - ChargeTotal: E.G.: 5.00. Charge total in currency from <Currency> node.
    - ChargesTotal: E.G.: 5.00. Charges total in currency from <Currency> node
  - Accessories: Accessories Block
    - AccessoryProductInformation: Accessory Product Information Block. Only fill this tag, if the product needs to have an optional part, else leave it blank
      - ProductSKU: Product Part ID. Needs to be populated from our soap service or excel dump. Use Promostandards Product Data getProduct() SOAP request
      - Color: Product Color
      - Imprints: Imprints Block
        
        Imprint: Imprint Block. You can put multiple imprint tags with the structure below, for multi imprint orders. You have to verify from our soap services or excel dump, how many imprint locations are possible for this product. Use Promostandards Product Pricing and Configuration getAvailableLocations() SOAP request
        
        ImprintMethod: Decoration ID. Needs to be populated from our soap service or excel dump. Use Promostandards Product Pricing and Configuration getConfigurationAndPricing() SOAP request
        
        ImprintLocation: Imprint Location Block
        
        LocationName: Location ID. Needs to be populated from our soap service or excel dump. Use Promostandards Product Pricing and Configuration getConfigurationAndPricing() SOAP request
        
        ImprintColors: Imprint Colors Block
        
        ImprintColor: Imprint Color Block. This tag can be repeated for multiple colors
        
        Color: Imprint Color name.
        
        PMSMatch: PMS Match. Must be TRUE or FALSE.
        
        Art: Art Data Block
        
        FileName: Art File Name. E.G.: aaaa.pdf
        
        FileLocation: If not sure about the location can be left blank, valid options are ftp://, http://, ftps://, https://. E.G.: http://www.example.com/abcd.com/art/123456/aaaa.pdf
        
        Trademark: Textual Description of Artwork
        
        ArtworkInstructions: Put any Straight Line Copy here. Such as "Add 555-555-555 to bottom of logo"
      - Quantity: E.G.: 100. Accessory Product Quantity to Order
      - UnitPrice: E.G.: 1.36. Unit Price in currency from <Currency> node
      - TotalPrice: E.G.: 136.00. Total Cost in currency from <Currency> node
      - Art: Accessory Product Art Data Block
        
        FileName: Art File Name. E.G.: aadd.pdf
        
        FileLocation: If not sure about the location can be left blank, valid options are ftp://, http://, ftps://, https://. E.G.: http://www.example.com/abcd.com/art/123456/aadd.pdf
        
        Remarks: Any Art Remarks
POTotal: E.G.: 271.00. Purchase Order Total in currency from <Currency> node
Currency: USD or CAD. If CAD then assuming FOB Toronto Pricing

Useful Resources

Hit Promotional Products Standard Services (Hit's services based on industry standards)
Hit.xml (Hit Promotional Purchase Order Xml template file)