Overview Last updated: 2023-03-17

Welcome Worldpac Web Partners! The Worldpac Developer Portal provides application developers documentation, sample code, and access to the API for the Worldpac Order Management System (OMS) - let's get you up and running fast! Have questions? Check out the FAQs or Support section.

Terms and Conditions

By accessing or using this site and the Worldpac APIs, you agree to be bound by the terms and conditions setforth herein. Please read the Terms of Use for complete information.

Terms of Use

Documentation

This documentation provides information to help application developers get started using the Order Management System REST API. Users of this documentation should have a general knowledge of APIs and how they are used to authenticate and interact with databases. Additional technical resources required are listed in the Resources section. The API Reference button above provides access the Worldpac Organization APIs in SwaggerHub. See API Requirements for complete information.

Order Management System REST API

REST APIs are a popular choice for building web services because they are flexible, scalable, and easy to understand and use. They also offer a wide range of benefits, such as improved performance, security, and platform independence. A replacement for the existing JAVA Fulfillment API, the OMS REST API utilizes the HTTP standard making it very fast and lightweight. Here are some of the features and benefits of RESTful APIs:

  Lightweight & Scalable

An enhancement compared to the legacy Fulfiller JAVA API, the WORLDPAC RESTful APIs are highly scalable due to their stateless nature. Each request contains all the necessary information to complete the request, so the server doesn't need to store any session state.

  Security

RESTful APIs can be secured using standard HTTPS encryption, which provides encryption and authentication for all communications between the client and server.

  Platform Independent

RESTful APIs are platform-independent and can be used by any client that supports HTTP and the required data format (such as JSON or XML). This makes it easy to integrate with different programming languages, platforms, and devices.


Worldpac OMS Diagram

About Worldpac

Headquartered in Newark, CA. USA, Worldpac is an importer and distributor of original equipment and quality aftermarket replacement automotive parts. Our speedDIAL catalog offering includes hundreds of thousands of products and millions of applications for all major vehicle makes. We provide product expertise and brand-recognized automotive parts directly to independent import and domestic service centers in the US, Canada and Puerto Rico with Same-Day delivery and Nationwide shipping options. Worldpac also offers customer services including our highly-praised technical and business training and other industry-leading events.

Getting Started

To get started integrating through our Order Management System API, you must be a Worldpac Web Partner and provided with a customer account and API access as described below.

Becoming a Web Partner

A Web Partner is a qualified online reseller of Worldpac products.  Please contact your Worldpac Sales representative to initiate your access request.

Don't have a Sales contact? Worldpac Sales Management Team

API Requirements

You must be an existing Worldpac customer with an account that is in good standing

Don't have an account? Register to Become a Worldpac Customer

You must be a member of the Worldpac SwaggerHub Organization and have a valid Worldpac OMS API Key

Need an invitation to the Worldpac SwaggerHub Organization? Need an OMS API Key? Contact your Sales representative to request an invitation to SwaggerHub and receive your OMS API Key.

Note

Worldpac 3rd-Party API partners must have a valid customer APIToken to make transactions on a customer's behalf. Go to How do I generate an API Token? in the FAQs for more information.

Code Development

The OMS API has two distinct environments, Test and Production. Developers are required to code and test OMS API integrations using the Test environment servers. Once your integration is complete, a Worldpac software Team member will review your integration and qualify it for Production use. Once approved for production, you will receive a production API Key for use in the production environment.

Use your SwaggerHub account to access the Worldpac OMS API to test sample code — or export the API in OAS standard JSON or YAML formats to develop in your favorite IDE or an online environment such as Postman.

SwaggerHub

API Environments

The Test and Production API environments for U.S. and Canada accounts each have a unique base-URL used for requests. Both environments also use an unique API Key that is used for authentication. See: Authentication section.

API Servers

API Server Name API Server URL
U.S. Test Environment https://api-qa.wpac.com/web/services/US_QUA
Canada Test Environment https://api-qa.wpac.com/web/services/CA_QUA
U.S. Production Environment https://api.wpac.com/web/services/US_PRD
Canada Production Environment https://api.wpac.com/web/services/CA_PRD

Production Approval

When an integration in test is complete, you may begin the approval process. Please contact Web Partner Support and request an OMS API Production Approval. Please include your Company Name, developer name, and registered SwaggerHub user ID in the request.

 [email protected]

Sample Code

Use the sample code below to get started with your API integration. Example code is provided for the following environments:


Worldpac Order Creation

 Windows CMD & PowerShell

 Linux Bash

 PHP

Authentication

Authentication is simple and secure. All OMS API transactions require an APIKey and an APIToken to authenticate. The APIKey is sent in the request header and the APIToken is sent in the request query string.

Using API Key and API Token

See example request below: 

curl -X 'GET' \
    'https://api-qa.wpac.com/web/services/US_QUA/accountDetails?APIToken=APIToken_here&customerAccountNo=Account#_here&submitDate=yyyyymmdd' \
    -H 'accept: application/json' \
    -H 'APIKey: Your APIKey Here' \

Price a Product

Create an Order

Orders are shipped to the defaultShippingAddress in your primary account. When creating an order for delivery to a customer, you must add a shippingAddress object to your request data. See Create a Drop-Ship Order

Create a Drop-Ship Order

Customer Shipping Address

When creating a drop-ship order for delivery to a customer, you must add a shippingAddress object to the createOrder request data. 

"shippingAddress": {
    "name": "CUSTOMER'\''S SHOP",
    "addressLine1": "37137 Hickory St",
    "addressLine2": "",
    "city": "Newark",
    "state": "CA",
    "zipCode": "94560",
    "country": "US",
    "phoneNumber": "1 (222) 333-4444",
    "emailAddress": "[email protected]"
}
Customer Shipping Address Validation

If the shipping address is invalid, you will receive a 500 error message stating the cause of the error. When available, a recommended address correction(s) are provided in the recommendedDropShipAddress object of the response.

{
    "status": {
        "code": 500,
        "message": {
            "ID": "API0327",
            "text": "Drop ship address update is recommended"
        }
    },
    "clientTransactionID": "fd05f7cd-1859-448a-bbdf-41b1a44eca66",
    "customerAccountNo": 34347,
    "orderHeader": {...},
    "orderLines": [],
    "recommendedDropShipAddress": {
        "inputAddress": {
            "name": "Worldpac",
            "addressLine1": "37137 Hickory St",
            "addressLine2": "",
            "city": "Fremont",
            "state": "CA",
            "zipCode": "94560",
            "country": "US",
            "phoneNumber": "5105520051",
            "emailAddress": ""
        },
        "recommendationText": "Address not standardized; see recommendation",
        "recommendedAddress": {
            "name": "Worldpac",
            "addressLine1": "37137 HICKORY ST",
            "addressLine2": "",
            "city": "NEWARK",
            "state": "CA",
            "zipCode": "94560 3340",
            "country": "US",
            "phoneNumber": "5105520051",
            "emailAddress": ""
        }
    }
}

Shipping Address Validation

Worldpac cannot not ship to an address that connot be validated.

By accessing or using this site and the Worldpac APIs, you agree to be bound by the terms and conditions setforth herein. Please read the Terms of Use for complete information.

Terms of Use

List Orders

Product Marketing Details

Product Marketing Details content is optional and varies among the different product brands. There may be up to two (2) levels of product details, the Brand level and the Category level. Brand level content normally contains brand information such as warranty and company info. Category information may contain more detailed information specific to the product's category such as features and benefits and manufacturing specifications.

API Endpoint Field Content
/productDetails  brand

Worldpac Brand Code associated to this product
  category

Worldpac Product Category designation. (If blank, the description field content contains only Brand level information)
  description

HTML formatted content for the brand and/or category indicated
Product Details

Product Digital Assets

Digital Assets

Digital asset information contains assetName, assetType, language and other PIES industry standard information. The <assetName> represents the filename of the asset that will be used in conjunction with a base URL described below.

Base URLs

Image assets: https://img.wp-static.com/wam?type=image&asset=<assetName>&size=<1500 | 110>

PDF assets: https://img.wp-static.com/wam?type=doc&asset=<assetName>

API Endpoint Field Content
/productDigitalAsset  assetName

Filename of the asset that will be used in conjunction with a base URL described above.

Sample assets:

Brochure (BRO)
https://img.wp-static.com/wam?type=doc&asset=2ba4d920-2598-4bf2-b027-3856bb6f7e6a.PDF

Image (P04)
https://img.wp-static.com/wam?type=image&asset=8b089a46-7b8b-4f53-a078-d6dda9c11362.JPG&size=1500

Error Messages

A list of error messages and descriptions:

Message ID Message Description Full Description
API0200  Successful The API call was executed successfully.
API0202  Customer account not found             The customer account in the request does not exist or the account is disabled.
API0203  Missing selection criteria             Required data is missing from the request payload.
API0204  You are not authorized to this service  You are not authorized to make this request. Contact your Worldpac sales representative for more information. 
API0206  Invalid API key                      The API key in the request header does not exist.
API0207  API key expired                      The API key used in a request is expired - contact your Worldpac sales representative to resolve any issues and obtain a new key.
API0208  You exceeded use limit for the month The number of requests allowed for a period of time has been exceeded. See Terms of Use documentation for further information.
API0221  Return reason is invalid  The return reason in the request is not valid or cannot be used for that particular line item. See Terms of Use documentation for further information.
API0222  RMA/Line not found  The line item in the RMA request was not found/no longer available.
API0223  RMA/Customer do not match  The customer account in the request was not used to purchase RMA item. 
API0224  RMA line not available   …describe action...
API0225  RMA not available      An RMA is not available for an item in the request. 
API0226  Invalid vehicle group ID   The vehicle ID requested does not exist. Please refer to latest the AMA ACES specification.
API0227  Stock order is not available for this customer The customer account in the request is not allowed to create DC Direct (stock) orders.
API0230  Order number is invalid   The order number in the request was input incorrectly or does not exist.
API0231  Quantity must be greater than zero The quantity for an item in a request must be greater than 0.
API0232  Product not stocked  The SKU requested is not stocked. Contact your Worldpac sales representative for further inquiries.
API0234  Quantity requested is not available The quantity for an item in the request exeeds stock on-hand. 
API0235  Excessive order quantity The number of items in the requests exceeds the maximum amount allowed in a single order. Please contact your Worldpac Sales representative or see the Terms of Use documentation for further information.
API0236  This part/warehouse combination is on the order already The product requested to place on an order already exists. Edit the quantity on the order line item to change the quantity.
API0237  Part not available for stock order  The product requested is not eligible for DC Direct (stock order) pricing.
API0243  Price cannot be determined for this product  The requested product does not have a price associated to it - product is in development. 
API0244  Customer not found or inactive  The customer account in the request does not exist or the account is inactive.
API0246  Invalid order number  The order number in the request is invalid/does not exist.
API0247  Order has already been submitted  The order number in the request has already been submitted for fulfillment.
API0249  One or more items will be shipped separately due to carrier restrictions  Items on the order will be shipped separately, by different carriers, due to carrier restrictions.
API0250  A comment containing the P.O. number is required - Order not submitted A P.O. number is required to submit orders on this account. The request did not contain a P.O. number in the order comments. 
API0252  Invalid mode of transport. Order cannot be submitted The mode of transport, or shipping method, in the request is invavlid.
API0254  Invalid AAP SKU  For internal use only.
API0255  CustomerNo/OrderNo do not match The customer number and order number in the request payload do not match. 
API0256  Order not found or has already been deleted  The order number in the request was input incorrectly or does not exist.
API0257  Order cannot be deleted   The order number in the request cannot be deleted because it is in use or is already being fulfilled/delivered.
API0258  Order is locked by another job  The order number in the request is in use.
API0259  Customer PO is required for this account  A customer PO is required to create an order for this account. 
API0261  Could not decode …VIN…
API0262  No record found for the license plate Unable to find a match for the license plate supplied in the request.
API0263  fromDate is not valid The From date in the request is improperly formatted or later than today.
API0264  toDate is not valid The To date in the request is improperly formatted or later than today.
API0265  fromDate cannot be greater than toDate The From date in the request is greater than To date - an invalid date range.
API0266  Both fromDate and toDate must be provided if invoiceNo is not provided When requesting multiple invoices, you must include a valid From date and To date.
API0267  Invalid character for VIN at position <integer>            An improperly formatted VIN was submitted in the request.
API0268  Order has been processed, no change is allowed      A request to change an order that is already being processed is not allowed.
API0269   Submit date is not valid                            This order in this request was not submitted, the submit date is not valid.
API0270  Order line not found                                The requested action on this order line failed, the order line was not found.
API0272  Order is saved, cannot be submitted.                The order number in the request is in the saved state. Open the order to submit.
API0273  Order is in use, no change is allowed               The order number in the request is in use by another user of this account.
API0275  User not authorized to API creditCardCreation       Internal use only.
API0276  createCreditCardAuthorization error - see responseText Internal use only.
API0278  cybersourceToken company mismatch to endpoint company Internal use only.
API0282  Saved for later                       The order number in the request has been saved for later use. The status for item(s) in the order may change and no longer be available.
API0283  Order submitted                       The order number in the request has been submitted for fulfillment.
API0284  Processing order                      The status of the order in this request shows it is being: Processed, meaning it is in the process of being fulfilled.
API0285  Shipped, partial                      The status of the order in this request shows as Shipped, partial, meaning not all items on the order have shipped.
API0286  Shipped, complete                     The status of the order in this request shows as Shipped, complete, meaning all items on the order have shipped.
API0287  valid values are (1, 2, 3, 4, 5, 6)           Internal use only.
API0288  Invalid API parameters                             Request included invalid API parameters in the payload.
API0289  Invoice not found for customer                     The requested invoice number was not found for the customer account number.
API0291  No manifest found                                  The requested manifest was not found. 
API0297  System error in setting up beta environment    Internal developer use only.
API0300  RMA is being picked up                        The RMA number in the request is in the process of being picked up by a driver.
API0301  RMA is in use            The RMA number in the request is already in use by another user using the account.
API0302  RMA number is invalid                                 The RMA number in the request is invalid.
API0303  Invalid categoryCode The category code in the request is invalid. Please refer to latest the AMA ACES specification.
API0304  Invalid searchText - must be 3 or more characters         3 or more characters must be used for all searches. 
API0500  Something went wrong, that's all we know… Uncaught exception. Please report the API call, header, and payload for the request to [email protected] 

Resources

The Resources section contains specifications and standards used by the Worldpac Order Management System. These resources should be used for reference only and are subject to change. The OpenAPI Specification (OAS) used by in the OMS API is Version 3.0 or greater.

REST API Definition

A REST (Representational State Transfer) API allows developers to execute operations on that system by exchanging copies of data (transferring the state) so that the server does not store any client session information (the server is stateless).

Methods (Verbs)

The OMS REST API Calls use the standard HTTP methods for CRUD (create, read, update, and delete) operations. Some methods may, or may not, apply:

  • GET - read an object
  • POST - create an object
  • PUT - update an entire object
  • PATCH - update part of an object
  • DELETE - delete an object

OAS 3.0.X Specification

The OpenAPI Specification defines a standard, language-agnostic interface to RESTful APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, documentation, or through network traffic inspection. When properly defined, a consumer can understand and interact with the remote service with a minimal amount of implementation logic.

OpenAPI Specification (OAS)

JSON Specification

JSON is a lightweight, text-based, language-independent syntax for defining data interchange formats. It was derived from the ECMAScript programming language, but is programming language independent. JSON defines a small set of structuring rules for the portable representation of structured data.

ECMA-404 - The JSON data interchange syntax
JSON.org

Aftermarket Catalog Exchange Standard (ACES®)

The Aftermarket Catalog Exchange Standard (ACES®) is the aftermarket industry data standard for the management and communication of product fitment data.

Aftermarket Catalog Exchange Standard (ACES®)

Note

While ACES® is an open-source standard, some attribute values require a paid subscription to access the latest automotive vehicle and part data.

Product Information Exchange Standard (PIES™)

The Product Information Exchange Standard (PIES™) is the aftermarket industry data standard for the management and communication of product information.

Product Information Exchange Standard (PIES™)

Note

While PIES™ is an open-source standard, some attribute values require a paid subscription to access the latest automotive vehicle and part data.

FAQs

Find Frequently Asked Questions below.

API Keys

How can I get an API Key?

Worldpac customers who wish to request access to the Order Management API and receieve an API Key, may do so by contacting their sales representative directly. Qualified customers will receive and email invitaton to join the Worldpac SwaggerHub OMS API and an API Token to access the API.

How do I generate an API Token?

Worldpac SpeedDIAL BETA users can manage API Tokens in the Settings panel. Some tips to follow when creating API Tokens for 3rd-party vendors:

Tip

Record the API Token immediately after generating, you cannot retrieve this token later
Be descriptive when naming your API Token - include the service name that will be using the token and the date provisioned

Warning

Use caution when deleting API tokens - the 3rd party using the token will no longer be able to authenticate on your behalf

Support

Contact your Worldpac Sales representative for answers to general questions about the Worldpac OMS API. See Getting Started if you want to become a Web Partner.


 Worldpac Sales Management Team
 Worldpac OMS SLA

Web Partner Support Team

Existing Web Partners can contact the Web Partner support team with any technical questions, concerns, or bug-reports regarding the OMS API.

 [email protected]

Note

While every effort is made to respond to questions as quickly as possible, please allow 2 business days for a response to API support questions.