Skip to content
Avetti Support
Avetti Support

Getting Started

  • Getting Started, Creating a new Supplier store in a marketplace
  • Access Methods for Admin Portal
  • Scanning QR Codes: A Step-by-Step Guide
  • ImageKit – Clearing Cache
  • How to setup a separate checkout on the marketplace
  • Getting Started Create a new Container store
  • Getting Started eShop
  • Getting Started Marketplace
  • Getting Started Multi Store Ecommerce
  • Getting Started With Website Performance
  • Getting Started With Google Analytics
  • Getting Started With Microsoft Clarity
  • Differences between Avetti Commerce, Magento, Shopify, and Woocommerce.
  • A Comprehensive Guide to Web Accessibility: Key Aspects and Top Testing Tools
  • a Comprehensive Guide to Web Accessibility Testing
  • HOW TO IMPLEMENT IMAGEKIT CUSTOM LOADER

Admin Pages

  • Create a New Supplier Store
  • Setup the Template/Default stores
  • Log in to a Supplier store
  • Avetti Shop Connect
    • Fulfillment
    • Supplier Connect / Reseller Registration Form
    • Shop Connect / Supplier Registration Form
    • Shopify 
    • Magento
    • WooCommerce
  • Catalog and Order Management
    • Catalog
      • Find Products to Sell
      • Prices
      • Manage Products
        • Products
        • Create Product
        • Edit Product
        • Edit Product Variations
    • Orders
      • Manage Orders
      • Quote Request
  • About Me
    • General Information
    • Pickup Locations
    • Payment Information
  • Marketplace
    • Auction
    • Design Document for Auctions
  • Appendix
    • Documentation Slides
      • About Me
      • Add Items – Suppliers
      • Create a Merchant Store
      • Customers
      • Manage Orders – Supplier
      • Prices – React Admin
  • Avetti Supplier Connect
    • Shopify

System Admin Pages

  • Avetti Commerce Features
  • Ship Station Integration
  • B2C -Overview
    • Settings
      • Basket Preferences
      • Image Scaling
      • Item Properties
      • Languages
      • Tax Rates
      • Order Preferences
      • Page Parameters
      • Payment Gateways
      • Retail Location
      • Search Dictionary
      • Shipping Countries
      • Shipping Packages
      • Shipping Rates
      • Sitemaps
      • Store Currencies
      • Shipping Exceptions
      • Store Preferences
      • Store Properties
    • Advanced
      • Solr Items
      • Solr Categories
      • Site Admin Preferences
      • Shopper Pwd Security
      • Reports Configuration
      • Password Security Rules
      • Change Password
      • CDTO Editor
    • Audit Logs
      • Audit Log Views
    • Templates
      • Catalog Personalization
      • Reset CDTO Cache
      • Template Skins
    • People
      • Member Types
      • Customers
      • Customer Properties
      • Customer Activity
      • Allowances
    • Catalog
      • Categories
      • Downloadable Items
      • Inventory
      • Item Reviews
      • Item Size/Weight
      • How to attach products to a category in the MCW
      • Manage Facets
      • Manage FAQs
      • Manage Galleries/PDFs
      • Manage Products
      • Multilingual Content
      • Prices
      • Validate Catalog Data
      • View Store
      • Variations
    • Media
      • Manage Media
    • Marketing
      • A/B Split Tests
      • Add-ons
      • Basket Additions
      • Bundles
      • Coupons
      • Customer Discounts
      • Customer Segments
      • Customer Segment Prices
      • Customer Segment Ads
      • Gift Cards
      • Gift Certificates
      • Promotions
      • Sales Area Geolocation
      • Upsell/Cross-sell
      • Viral Promotions
    • Orders
      • Abandon Cart
      • Customer Messages
      • Email State
      • Manage Orders
      • Manage Refunds
      • Reports
  • B2B - Overview
    • Marketplace
      • Advanced
        • CDTO Editor
        • Change Password
        • Password Security Rules
        • Reports Configuration
        • Shopper Pwd Security
        • Site Admin Preferences
        • Solr Categories
        • Solr Items
      • Catalog
        • Categories
        • Inventory
        • Item Reviews
        • Item Size/Weight
        • Manage Facets
        • Prices
        • Item Options
        • Item Status Settings
      • Marketing
        • Bundles
        • Coupons
        • Customer Discounts
        • Customer Retargeting
        • Customer Segment Ads
        • Customer Segment Prices
        • Customer Segments
        • Gift Cards
        • Gift Certificates
        • Marketing Segments
        • Sales Area Geolocation
        • Shipping Exceptions
        • Upsell/Cross-sell
        • Viral Promotions
      • Market Place
        • Approve Products
        • Category Profit Margin
        • Marketplace Categories
        • Marketplace Payments
        • Marketplace Suppliers
        • Master Catalog Products
        • Notifications
      • Media
        • Manage Media
      • Order
        • Manage Orders
        • Manage Refunds
      • People
        • Customer Properties
        • Customers
      • Settings
        • Item Geolocation / Product Segmentation
        • Basket Preferences
        • Image Scaling
        • Item Properties
        • Order Preferences
        • Payment Gateways
        • Retail Location
        • Tax Rates
        • Store Preferences
        • Store Currencies
        • Shipping Countries
      • Templates
        • Catalog Personalization
        • Reset CDTO Cache
        • Manage Templates
    • Suppliers
      • Catalog
        • Manage Products
        • Inventory
        • Item Properties
      • Market Place
        • Notifications
        • Marketplace Payments
        • Approve Products
      • Media
        • Manage Media
      • Order
        • Manage Orders
        • Manage Refunds
        • Reports
        • Customer Messages
    • MCW
      • Advanced
        • Change Password
      • Market Place
        • Approve Products
        • Marketplace Suppliers
        • Notifications
      • Media
        • Manage Media
      • Order
        • Customer Messages
      • Settings
        • Item Properties
        • Shipping Countries
        • Store Currencies
        • Store Preferences
      • Catalog
        • Categories
        • Inventory
        • Item Options
        • Item Reviews
        • Item Size/Weight
        • Item Status Settings
        • Prices
  • B2B2C - Overview
    • B2B Integration
  • Import and Export Files
    • Export Orders
    • Import Price and Inventory
    • Importing/Exporting Shipping Rates Spreadsheet
    • Import/Exporting SpreadSheets
    • eShop Features
  • Appendix
    • Documentation Slides
      • Others
        • Creating a Supplier Store
        • Rebuild solr
        • Publish
      • People
        • Customer Data Management
        • Customers
        • Customer Properties
      • Settings
        • Basket Preferences
        • Item Properties
        • MULTI-VALUED PROPERTIES
        • Retail Location
        • Shipping Countries
        • Sitemaps
        • Store Currency
        • STORE PREFERENCES
        • Store Properties
        • Tax Rates
      • Advanced
        • Site Admin Preferences
      • Reports
        • Business Reports
      • Catalog
        • Advanced edit
        • Categories
        • Categories Spreadsheet
        • FREQUENTLY BOUGHT ITEMS
        • Import from XLS
        • Import-Export Advanced Spreadsheet
        • Inventory
        • Item Reviews
        • Manage Facets Manager
        • Simple Add
        • Prices
        • Validate Catalog Data
        • Variations
      • Marketing
        • Bundles
        • Basket Additions
        • Coupons
        • Customer Discounts
        • Customer Segments
        • Gift Cards
        • Gift Certificate
        • Promotions
        • Upsell-Cross sell
      • Marketplace
        • Approve Products
      • Templates
        • Reset CTDO Cache
      • Orders
        • Customer Messages
        • Export Orders
        • Email Settings
        • Manage Orders
        • SMS Settings
    • Documentation Videos
      • Payment Gateway
      • Retail Location
      • Validate Catalog Data
      • Site Admin Preferences
      • SMS Settings
      • Advanced Edit
      • Variations
      • Manage Orders
      • Categories
      • Basket Preferences
      • Customers
      • Upsell Cross Sell
      • Allowances
      • Customer Discounts
      • Order Preferences
      • Publish
      • Rebuild Solr
      • Email Setting
      • Store Preferences
      • Item Reviews
      • Tax Rates
      • Customer Segments
      • Store Currency
      • Product Data Spreadsheet
      • Export Orders
      • Sitemaps
      • Prices
      • Coupons
      • Bundles
      • Frequently Bought Items
      • Customer Properties
      • Store Properties
      • Multi Valued Properties
      • Gift Cards
      • Promotions
      • Manage Media
      • Gift Certificates
      • Manage Facets
      • Simple Add
      • Import and Export Using Spreadsheet
      • Customer Messages
      • Creating a Supplier Store
      • Approve Products
      • Import XLS
      • Business Reports
      • Item Properties

Content Management Systems

  • WordPress
    • Getting Started
    • Document Checklist
    • How to create pages in Wordpress?
    • How to create New Menus?
    • How to edit the Home Page?
    • How to change Favicon and Site Title?
    • How to edit Header and Footer?
    • How to change Header and Footer?
    • How to edit Shipping Policy, Refund Policy and Privacy Policy pages?
    • How to add Google Analytics and Microsoft Clarity
    • Using Existing WP vs Using Fresh WP
    • How to change Logo URL
    • How to create Blog Posts?
    • Blog Look And Layout
    • Netlify Redirects
    • Caching Issues
    • Plugins
    • Plugins
      • Fluent Forms
      • Perfmatters
      • Blocksy
      • Change SEO Title and Meta Descriptions with Yoast SEO
      • Staging and Backup with WPVivid
      • Stackable
      • Custom Javascript and CSS plugin
    • Common Issues
      • Does Not Use Passive Listeners
      • Enable Text Compression
      • Preload Largest Content Paint Image
View Categories
  • Home
  • Docs
  • System Admin Pages
  • Ship Station Integration

Ship Station Integration

6 min read

Scope: Integrate with Shipstation so that we can stream orders and retrieve tracking numbers back.

We need to create two webservice endpoints:

GET

https://www.yourstore.com/shipstationxml.php?action=export&start_date=01%2f23%2f2012+17%3a28&end_date=01%2f23%2f2012+17%3a33&page=1

POST

https://www.yourstore.com/shipstationxml.php?action=shipNotify&start_date=01%2f23%2f2012+17%3a28&end_date=01%2f23%2f2012+17%3a33&page=1

action=export when Shipstation does a GET call to us to retrieve data for all orders between start and end dates.

action=shipNotify when Shipstation makes a POST call to the same endpoint to to send us tracking information

ShipStation uses Basic HTTP Authentication when calling your Web Endpoint. Use a Basic Authentication Header to pass the credentials.

NOTE: Please see reference link below for field formats and mandatory fields

Sample GET Response body ( to export Orders) #

JavaScript
<?xml version="1.0" encoding="utf-8"?>
<Orders pages="1">
  <Order>
    <OrderID><![CDATA[123456]]></OrderID>
    <OrderNumber><![CDATA[ABC123]]></OrderNumber>
    <OrderDate>10/18/2019 21:56 PM</OrderDate>
    <OrderStatus><![CDATA[paid]]></OrderStatus>
    <LastModified>12/8/2011 12:56 PM</LastModified>
    <ShippingMethod><![CDATA[USPSPriorityMail]]></ShippingMethod>
    <PaymentMethod><![CDATA[Credit Card]]></PaymentMethod>
    <CurrencyCode>EUR</CurrencyCode>
    <OrderTotal>123.45</OrderTotal>
    <TaxAmount>0.00</TaxAmount>
    <ShippingAmount>4.50</ShippingAmount>
    <CustomerNotes><![CDATA[Please make sure it gets here by Dec. 22nd!]]></CustomerNotes>
    <InternalNotes><![CDATA[Ship by December 18th via Priority Mail.]]></InternalNotes>
    <Gift>false</Gift>
    <GiftMessage></GiftMessage>
    <CustomField1></CustomField1>
    <CustomField2></CustomField2>
    <CustomField3></CustomField3>
    <Customer>
      <CustomerCode><![CDATA[[email protected]]]></CustomerCode>
      <BillTo>
        <Name><![CDATA[The President]]></Name>
        <Company><![CDATA[US Govt]]></Company>
        <Phone><![CDATA[512-555-5555]]></Phone>
        <Email><![CDATA[[email protected]]]></Email>
      </BillTo>
      <ShipTo>
        <Name><![CDATA[The President]]></Name>
        <Company><![CDATA[US Govt]]></Company>
        <Address1><![CDATA[1600 Pennsylvania Ave]]></Address1>
        <Address2></Address2>
        <City><![CDATA[Washington]]></City>
        <State><![CDATA[DC]]></State>
        <PostalCode><![CDATA[20500]]></PostalCode>
        <Country><![CDATA[US]]></Country>
        <Phone><![CDATA[512-555-5555]]></Phone>
      </ShipTo>
    </Customer>
    <Items>
      <Item>
        <SKU><![CDATA[FD88821]]></SKU>
        <Name><![CDATA[My Product Name]]></Name>
        <ImageUrl><![CDATA[http://www.mystore.com/products/12345.jpg]]></ImageUrl>
        <Weight>8</Weight>
        <WeightUnits>Ounces</WeightUnits>
        <Quantity>2</Quantity>
        <UnitPrice>13.99</UnitPrice>
        <Location><![CDATA[A1-B2]]></Location>
        <Options>
          <Option>
            <Name><![CDATA[Size]]></Name>
            <Value><![CDATA[Large]]></Value>
            <Weight>10</Weight>
          </Option>
          <Option>
            <Name><![CDATA[Color]]></Name>
            <Value><![CDATA[Green]]></Value>
            <Weight>5</Weight>
          </Option>
        </Options>
      </Item>
      <Item>
        <SKU></SKU>
        <Name><![CDATA[$10 OFF]]></Name>
        <Quantity>1</Quantity>
        <UnitPrice>-10.00</UnitPrice>
        <Adjustment>true</Adjustment>
      </Item>
    </Items>
  </Order>
</Orders>

Sample POST response body ( to get tracking info back) #

JavaScript
<?xml version="1.0" encoding="utf-8"?>
<ShipNotice>
  <OrderNumber>ABC123</OrderNumber>
  <OrderID>123456</OrderID>
  <CustomerCode>[email protected]</CustomerCode>
  <CustomerNotes></CustomerNotes>
  <InternalNotes></InternalNotes>
  <NotesToCustomer></NotesToCustomer>
  <NotifyCustomer></NotifyCustomer>
  <LabelCreateDate>10/19/2019 12:56</LabelCreateDate>
  <ShipDate>10/19/2019</ShipDate>
  <Carrier>USPS</Carrier>
  <Service>Priority Mail</Service>
  <TrackingNumber>1Z909084330298430820</TrackingNumber>
  <ShippingCost>4.95</ShippingCost>
  <CustomField1></CustomField1>
  <CustomField2></CustomField2>
  <CustomField3></CustomField3>
  <Recipient>
    <Name>The President</Name>
    <Company>US Govt</Company>
    <Address1>1600 Pennsylvania Ave</Address1>
    <Address2></Address2>
    <City>Washington</City>
    <State>DC</State>
    <PostalCode>20500</PostalCode>
    <Country>US</Country>
  </Recipient>
  <Items>
    <Item>
      <SKU>FD88821</SKU>
      <Name>My Product Name</Name>
      <Quantity>2</Quantity>
      <LineItemID>25590</LineItemID>
    </Item>
  </Items>
</ShipNotice>
What are your Feelings
Still stuck? How can we help?

How can we help?

Updated on February 6, 2023
Avetti Commerce Features

Powered by BetterDocs

Table of Contents
  • Sample GET Response body ( to export Orders)
  • Sample POST response body ( to get tracking info back)

Copyright © 2022 Avetti.com Corporation.