Click to navigate to a Shopatron-specific term or the Shopatron-approved spelling for another word or term:


  1. A
  2. B
  3. C
  4. D
  5. E
  6. F
  7. G
  8. H
  9. I
  10. J
  11. K
  12. L
  13. M
  14. N
  15. O
  16. P
  17. Q
  18. R
  19. S
  20. T
  21. U
  22. V
  23. W
  24. X
  25. Y
  26. Z


Shopatron API Glossary


Add to Cart API — An API that allows you to incorporate Shopatron's shopping cart and checkout into your online order system. Two versions of the Add to Cart API are available. A REST version allows you to incorporate Add to Cart buttons, quick cart views, and a Shopatron shopping cart into your marketing web pages using JSON or XML. The original Add to Cart API lets you gather order information in a Shopatron cart, pass cart information between your local website and the Shopatron site, transfer the cart to checkout for order completion, and remove the shopping cart from your system using XML-RPC.

AJAX — Asynchronous JavaScript and XML. A technique that uses JavaScript and new browser features to call Web APIs on a server to quickly add a user interface to Web applications.

API — An application programming interface (API; plural APIs) is a protocol intended to be used as an interface by software components to communicate with each other. An API may include specifications for routines, data structures, object classes, and variables. Depending on audience, may require explanation on first reference.

API key — Before you can use the Shopatron API functions for an API, you need to specify your API key, which serves as your authentication token. The API key gives you access to the API and identifies your site.

ASCII — Acronym for American Standard Code for Information Interchange.

ASP — Microsoft Active Server Page (ASP) is a server-side scripting technology that can be used to create dynamic and interactive Web applications. You can combine ASP with Extensible Markup Language (XML) and Hypertext Markup Language (HTML).

Available Order Download API — An XML-RPC API that you use to obtain information about your current Shopatron available (unassigned) orders.

available orders — Orders that are available for fulfillment partners to request.


backup fulfiller - A fulfiller who is chosen by the merchant to handle high-level fulfillment tasks, like accepting orders that are not requested by fulfillment partners and managing backorders.

bid — An obsolete term for a Shopatron order request.


Cannot Ship Order API-- An XML-RPC API that helps you manage orders when you discover that you cannot fulfill them.

Certified Partner fulfillment and Certified Partner orders — A Shopatron fulfillment process where a merchant assigns a Certification level to both fulfillers and products. Certified Partner orders can be viewed only by fulfillment partners who have the same Cerfitication level or higher than the highest Certification-level of any product in the order. Many of the guidelines and rules for these orders are set by the individual merchant. Resolve times for Certified Partner orders are the same as for Standard orders. Longer fulfillment times are allowed. Drop shipping and in-store pickup are sometimes supported, if specified by the merchant.

CFE — Obsolete name for Shopatron Custom Websites.

Checkout Integration — The new name for XML Checkout.

Coex Freedom — An obsolete name for Shopatron Manufacturer.

Coex Private — An obsolete name for Shopatron Retailer .

Cold Fusion — A complete Web application server for developing and delivering scalable e-business applications. ColdFusion uses a tag-based, server scripting language.

CSV — Abbreviation for comma-separated values, a file type.

Create Pro Customer API — An XML-RPC API that you can use to create the customer accounts for your VIP store.

Create Return Request API — The XML-RPC API used to create Return Requests (RMAs) and open or accept returns.

Create RMA API — An XML-RPC API used to automate the return initiation process. You can also accept returns with this API.

Custom Website — New name for CFE (or DynCat).



Express orders — A Shopatron fulfillment method where the consumer selects the date that items must be received (2-day or 3-day delivery) and an approved fulfillment partner or merchant must get the order to the consumer by this date or face a potential fine (which is assessed to the fulfiller and credited to the consumer).

  • Express orders are not delivered overnight; the real distinction is that they are guaranteed to arrive by the date promised.
  • Express orders were formerly called RushOps and Guaranteed Delivery orders.


fulfillment partners — The official name for Shopatron retailers.


Get Assigned Orders API — An XML-RPC API that youlets Ship to Store (Manual) fulfillers know which Ship to Store (Manual) orders are assigned to them.

Get Close Retailers API — If you use Ship to Store fulfillment, you can use this XML-RPC API to retrieve and display information about the retail fulfillment locations that are close to an order. The API is usually used from a product detail page to provide the customer with a list of available pick-up locations.

GET method — Requests data from a specified resource, whereby the form data is to be encoded (by a browser) into a URL. The following apply:

  • GET requests can be cached.
  • GET requests remain in the browser history.
  • GET requests can be bookmarked.
  • GET requests should never be used when dealing with sensitive data.
  • GET requests have length restrictions.
  • GET requests should be used only to retrieve data.

Get Order Step API — If you use Ship to Store (Manual) fulfillment, this XML-RPC API tells you or a fulfillment partner the next step in an order's fulfillment.

Get Order Step Log API — This XML-RPC API lets a Ship to Store (Manual) merchant or fulfillment partner find out where an order is in the fulfillment process and provides information about other steps in the fulfillment process.


Hybrid-Plus — Hybrid-Plus orders initially process as a standard order (i.e., fulfillment partners who request the order must have all inventory on hand). If no request is placed after the first resolve, the order transitions to a Certified Partner order and follows the Certified Partner order process.


Immediate Accept Orders API — This XML-RPC API allows Ship to Store (Manual) fulfillment partners to automatically accept orders that are assigned to them.

Immediate Order Processing API (IOPT) — This XML-RPC API gathers your consumers' order and payment information on your own website and transfers it to Shopatron, where the orders are processed and fulfilled.

In-Store Pickup — In-Store Pickup is the Shopatron group name for four different programs, each of which provides some way that a shopper can receive their orders at home. The four programs are Local Search First, Ship to Store (Manual), Ship to Store (Automated), and Shopper's Choice.

Inventory Inquiry API — This REST API allows you to share your real-time inventory information among multiple fulfillment locations. With the Inventory Inquiry API, you automatically assign orders to your stores based on up-to-date product availability data.


JavaScript (JS) — An open-source client-side scripting language commonly implemented as part of a web browser to create enhanced user interfaces and dynamic websites.

JSON — JavaScript Object Notation. A text-based open standard designed for human-readable data interchange. JSON is derived from the JavaScript scripting language for representing simple data structures and associative arrays, called objects. Despite its relationship to JavaScript, it is language-independent, with parsers available for many languages.

JSP — Java Server Page. JSP pages are similar to ASP pages in that they are compiled on the server, rather than in a user's Web browser. JSP pages are useful for building dynamic Web sites and accessing database information on a Web server.



Local Search First — This is Shopatron's original In-Store Pickup program. With Local Search First, as soon as the shopper places their order, the system begins searching for a local retail location that has the items in stock for immediate pickup. However, if no immediate local pickup location is available, the order changes to a Standard order and the items are shipped to the customer.


merchant — Shopatron manufacturers or brands.

Merchant Support — The Shopatron team that provides support to our merchants.

Move Order API — You can use this XML-RPC API to move certain orders to other order states and assign sales tax to orders.

Move Order Step API — Ship to Store (Manual) — This XML-RPC API lets Ship to Store (Manual) fulfillers move an order to a different point in the fulfillment process

Move Return Request API — You can use this XML-RPC API to process your product returns when you receive them.



onBlocks Checkout — Now called Checkout Integration.

onBlocks Site and Store Management System — Now called Shopatron Website Management System.

onBlocks Store — Now called Shopatron Online Store.

onBlocks website — Now called Shopatron Complete Website.

Online Order Processing API (OOPT) — You can use this XML-RPC API to gather your consumers' order information on your own website and transfer it to Shopatron, where the orders are processed and fulfilled.

Order Status API — You can use this XML-RPC API to obtain information about a particular order or about all events of a particular type (like cancellations) that occurred during a time period as well as to obtain complete information about a Shopatron order.


PCI Compliance — Payment Card Industry Data Security Standard (PCI DSS). This is a proprietary information security standard for organizations that handle cardholder information for the major debit, credit, prepaid, e-purse, ATM, and POS cards. Defined by the Payment Card Industry Security Standards Council, the standard was created to increase controls around cardholder data to reduce credit card fraud via its exposure.

PHP — Hypertext Preprocessor. A server-side scripting language designed for web development but also used as a general-purpose programming language.

PhysiBid — Now called an order request or a requested order.

Poll Order Status API — You can use this XML-RPC API to obtain information about a particular order or about all events of a specific type (like cancellations) that occurred during a time period.

POST method — Submits data to be processed to a specified resource involving storing or updating data, ordering a product, sending E-mail, and so on. The form data is to appear within a message body. The following apply:

  • POST requests are never cached.
  • POST requests do not remain in the browser history.
  • POST requests cannot be bookmarked.
  • POST requests have no restrictions on data length.

Pro Stores — Another name for VIP stores.

PUT method — Requests that the enclosed entity be stored under the supplied URL (for files that do not yet exist on the server).



Ready Order Download API — The XML-RPC API that you can use to get information about all of your orders that are in Ready status, across all of your product catalogs. Your fulfillment partners can also use this API to automate their fulfillment processes, too.

ready orders — Orders that have been assigned and successfully charged and are, therefore, ready to process or fulfill.

Ready to Run Website — This term is no longer used. This is now called a Best Practice Template.

request — A fulfillment partner must first request an order (or place an order request) to have a Standard, Certified Partner, or Local Search order awarded to them. Used to be called a PhysiBid or a bid.

Request Orders API — The XML-RPC API that you use to request orders you want to fulfill. Fulfillment partners can use this API to automate their fulfillment processes, too.

resolve (v.), resolve time (n.) — The point in the order process when an order is awarded to a fulfillment partner.

resource — In REST APIs, a resource is an item of information (entity) that can be named and represented. Resources are identified using URIs.

REST — Representational State Transfer (REST) is a style of software architecture for distributed systems such as the World Wide Web. REST has emerged as a predominant Web service design model.

A RESTful web service (also called a RESTful web API) is a web service implemented using HTTP and the principles of REST. It is a collection of resources, with four defined aspects:

  • the base URI for the web service.
  • the Internet media type of the data supported by the web service. This is often XML but can be any other valid Internet media type provided that it is a valid hypertext standard.
  • the set of operations supported by the web service using HTTP methods (e.g., GET, PUT, POST, or DELETE).
  • the API must be hypertext driven.

Retrieve Order Status API — An XML-RPC API that allows you to get information about your Shopatron orders by order numbers or date range. Fulfillment partners can also obtain status information using this API.

RMA — Return Merchandise Authorization. The Return Number assigned by Shopatron when a return is initiated.


Ship to Store — A Shopatron fulfillment process where the shopper picks up their order at a store and chooses their pick-up location from a list of stores that is presented at checkout. The two unique characteristics of Ship to Store fulfillment, as compared to other In-Store Pickup solutions, are: the shopper chooses their specific pick-up location and the merchant (or brand) can, in some circumstances, provide the order to the fulfillment location. There are two flavors of Ship to Store fulfillment: Ship to Store (Manual) and Ship to Store (Automated). We are currently supporting both.

  • To consumers, Ship to Store (Automated) orders appear as Ship to Store orders. No difference.
  • Merchants can only offer one type of Ship to Store, so both can be called Ship to Store.
  • For fulfillment partners the difference is extremely important because a single fulfiller could potentially process both types of orders (for different merchants) and the fulfillment process is different.

Ship to Store (Automated) — Shopatron's newer version of Ship to Store. The fulfillment process for Ship to Store (Automated) is significantly different (and much simpler) than it is for Ship to Store (Manual). Ship to Store (Automated) also features different emails, provides automated IVR support, incorporates the sales representative role, requires merchants to sometimes automatically ship orders to fulfillment locations, better communicates fulfillment steps in the user interface, and requires items to be returned to stores. It does not include purchase order, lead time, or customization steps.

Ship to Store (Manual) — Shopatron's original Ship to Store solution, where fulfillers accept Ship to Store orders and complete a number of ordered fulfillment steps (including creating a purchase order, ordering items from another source, if needed, estimating a lead time, and entering a customization time).

Shipment Data Upload API — The XML-RPC API you use to enter shipment information for your orders. Fulfillment partners can use this API to enter their shipment information, too.

Shopatron Complete Website — The new name for an onBlocks Website.

Shopatron Online Store — The new name for an onBlocks Store.

Shopatron Website Management System — The new name for an onBlocks Site and Store Management System.

Shopper's Choice — A Shopatron In-Store Pickup process where orders fail over to another fulfillment method if they are not available for immediate pickup. The customer selects the fail-over method: Ship to Store (Manual) or Standard (ship to home) fulfillment. Like Ship to Store, the Shopper's Choice customer chooses a local pickup location from a list that we present at checkout.

SOAP — SOAP, originally defined as Simple Object Access Protocol, is a protocol specification for exchanging structured information in the implementation of Web Services in computer networks. It relies on Extensible Markup Language (XML) for its message format, and usually relies on other Application Layer protocols, most notably Hypertext Transfer Protocol (HTTP) and Simple Mail Transfer Protocol (SMTP), for message negotiation and transmission.

SMS — Abbreviation for Short Message Service, used for text messaging.

Standard fulfillment — The original Shopatron ship-to-home fulfillment process. Standard orders are awarded to fulfillment partners who request them based on the fulfillment partner's inventory and proximity to the customer.

Standard orders:

  • Can be viewed by any Shopatron fulfillment partner who has selected the industry of the order as a preferred industry.
  • Resolve every business day. The resolve occurs at 10:30 AM PST for North American orders. EU orders resolve at 10:30 AM in the specific time zone for your country.
  • Are usually assigned to the closest fulfillment partner (geographically) who has placed a request on the complete order.
  • Must be shipped within one business day of the time they attain a Ready status.
  • Must be shipped by carriers who provide tracking information or delivery confirmation.



UPC — Merchant's Universal Product Code for an item.


VIP Stores — The official name for Shopatron Pro Stores.



XML — Extensible Markup Language. A markup language that defines a set of rules for encoding documents in a format that is both human-readable and machine-readable.

XML Checkout — Now called Checkout Integration.

XML-RPC — A standard protocol that allows servers to communicate. XML-RPC works by sending an HTTP request to a server implementing the protocol. Many sources provide help and information about XML and RPC.