Authenticating Partner Commerce APIs

Basics

This page describes the headless Partner Commerce service that enables rapid experience-first commerce development and applications.

The Partner Commerce API follows a microservice architecture that enables commerce into any part of an application and is built on the JSON API specification, follows predictable REST URLs and supports cross-origin resource sharing.

Authentication

All requests to the API need to be accompanied by an authorization header with a standard salesforce authentication token.

Authorization: Bearer 00D230000000nZM!ARMAQHLLm33JxYYP.UJn1gF6FFmLv8sDYK_8szeckHWtbguztoBpF0HL8...

The SDK comes with built-in mechanisms for obtaining the above authentication token or you may use any standard Salesforce approach for obtaining a custom access token for use with the API.

Endpoint

The Partner Commerce API is installed with the Partner Commerce managed package and can be exposed to external applications via a Salesforce site or community. Once a community or site has been built, all API's will have the structure.

https://mycommunity.force.com/community/services/apexrest/Apttus_WebStore/apttus/:version/:api`

Versions

The Partner Commerce API ensures backward compatibility by properly versioning any changes to the APIs. Should changes to the API structure need to be made, it will occur within a new version and older functionality will be preserved.

X-Storefront Header Parameter

In order to match your API requests with a storefront, the x-storefront parameter must be used with all requests in the request header. It should match a storefront name record in SFDC.

x-storefront: my-storefront`

Content Type

Requests made to the API must be encoded as JSON and contain the header.

Content-Type: application/json

X-Account Header Parameter

In order to set the default account, the account value from header can be passed as query param, the x-account parameter is optional in the request header. If passed it should match the Id of the account record in SFDC.

x-account: 0011900000hnGsr`

Includes

You can easily include resource relationships on most top-level resources. Multiple includes are defined using comma delimited values.

Caching

Server side caching is used and can be configured per request using the cacheStrategy query parameter.

Errors

Any request that returns an error follows a standard format. The Partner Commerce API will return an array of errors that contains objects containing the status, title and data with the error details.


Code	Response
201	Created Successfully
200	Updated Successfully
204	Deleted Successfully
400	Invalid JSON
422	Validation Error
500	Something went wrong on our end

Conga Product Documentation

Welcome to the new doc site. Some of your old bookmarks will no longer work. Please use the search bar to find your desired topic.