CommunitySupport PortalYouTubeFree trialSign Up!

Own session management

Retrieving own session context

get

Retrieves a session context associated with the sessionId derived from the Authorization token used in the call. Recommended for performing calls on the storefront.

Authorizations
Path parameters
tenantstring · min: 3 · max: 16Required

Your Emporix tenant's name.

Note: The tenant name should always be provided in lowercase.

Pattern: ^[a-z][a-z0-9]+$
Responses
200

The request was successful. Session context details are returned.

application/json
Responseall ofExample: {"Session context":{"sessionId":"62528895-b561-4518-bfdc-2cbf52a07845","customerId":"C87362407845","siteCode":"main","currency":"EUR","targetLocation":"DE","cartId":"61079711ce0eb90861357045","context":{"property1":{"property3":"propertyValue"},"property2":{"property3":"propertyValue"}},"metadata":{"version":1,"createdAt":"2022-09-20T12:33:52.456Z","modifiedAt":"2022-09-20T12:33:52.456Z"}}}
get
/session-context/{tenant}/me/context
GET /session-context/{tenant}/me/context HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "sessionId": "62528895-b561-4518-bfdc-2cbf52a07845",
  "customerId": "C87362407845",
  "siteCode": "main",
  "currency": "EUR",
  "targetLocation": "DE",
  "cartId": "61079711ce0eb90861357045",
  "context": {
    "property1": {
      "property3": "propertyValue"
    },
    "property2": {
      "property3": "propertyValue"
    }
  },
  "metadata": {
    "version": 1,
    "createdAt": "2022-09-20T12:33:52.456Z",
    "modifiedAt": "2022-09-20T12:33:52.456Z"
  }
}

Partially updating own session context

patch

Partially updates a session context associated with the sessionId derived from the Authorization token used in the call. Recommended for performing calls on the storefront.

Note: To update a session context, you need to provide its current metadata.version value in the request body.

Note: Only specific fields can be updated this way, and the rest is ignored. The fields allowed to be updated: siteCode, currency, targetLocation, context.

Authorizations
Path parameters
tenantstring · min: 3 · max: 16Required

Your Emporix tenant's name.

Note: The tenant name should always be provided in lowercase.

Pattern: ^[a-z][a-z0-9]+$
Body
all ofOptionalExample: {"Update of a session context":{"sessionId":"62528895-b561-4518-bfdc-2cbf52a07845","customerId":"C87362407845","siteCode":"main","currency":"EUR","cartId":"512950192-b561-4518-bfdc-2cbf52a07845","targetLocation":"DE","metadata":{"version":1}}}
Responses
204

The request was successful. The session context has been updated.

No content
patch
/session-context/{tenant}/me/context
PATCH /session-context/{tenant}/me/context HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 83

{
  "siteCode": "main",
  "currency": "EUR",
  "targetLocation": "DE",
  "metadata": {
    "version": 1
  }
}
No content
PreviousSession context modificationNextOwn session context modification

Last updated

Was this helpful?