Getting started

Get your API key and make your first onboarding call

You use onboarding to set up businesses on the Priority Commerce Engine (PCE).

Before you begin

Make sure you have the following in place before your first call:

ItemDescription
AccessContact Priority support to get access to the onboarding API.
API keySend your API key in the x-api-key header on every request: x-api-key: <your-key>. Contact Priority support to get sandbox and production keys.
Base URLs
  • Sandbox: https://sandbox-api.prioritycommerce.com for development and testing.
  • Production: https://api.prioritycommerce.com for live businesses once your integration is complete.
HTTPSSend every request over HTTPS.

API basics

ActionMethodWhat happens
CreatePOSTReturns 201 Created with the new record's id and uri.
ReadGETReturns the record. Add ?expand=true on a business to get its full details. See Query Parameters.
UpdatePATCHChanges only the fields you send. Services are turned on and off with PATCH.

PCE creates every ID. Store the IDs it returns. For what each ID prefix means, see Businesses.

API conventions

The cross-cutting conventions live on their own pages.

Next steps

See also


Did this page help you?