Session context modification

Deleting an attribute from a session context

delete

Removes a particular attribute from a specified session context. Recommended for performing calls on the management side.

Note: Optimistic locking is not taken into account here.

Required scopes

This endpoint requires the following scopes:

• : Manage session context

Authorizations

OAuth2

OAuth2clientCredentialsRequired

Token URL:

Path parameters

tenantstring · min: 3 · max: 16Required

Your Emporix tenant name.

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

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

sessionIdstringRequired

Customer session ID. The session context (and this ID) is created when a cart is created for the user; until then, only an anonymous or customer token is returned and there is no session context resource.

attributeNamestringRequired

Name of the attribute that should be deleted from the session context.

Responses

204

The request was successful. The attribute has been deleted from the session context.

404

A session context with the provided ID was not found.

application/json

500

A server-side error occurred.

application/json

delete

/session-context/{tenant}/context/{sessionId}/attributes/{attributeName}

HTTPcURLJavaScriptPython

DELETE /session-context/{tenant}/context/{sessionId}/attributes/{attributeName} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

Adding a new attribute to a session context

post

Adds an attribute to a session context file for a session with a given sessionId. Recommended for performing calls on the management side.

Note: Optimistic locking is not taken into account here.

Required scopes

This endpoint requires the following scopes:

• : Manage session context

Authorizations

OAuth2

OAuth2clientCredentialsRequired

Token URL:

Path parameters

tenantstring · min: 3 · max: 16Required

Your Emporix tenant name.

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

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

sessionIdstringRequired

Customer session ID. The session context (and this ID) is created when a cart is created for the user; until then, only an anonymous or customer token is returned and there is no session context resource.

Body

application/json

Context attribute

keystringRequired

Additional context information key

valueone ofRequired

Additional context information value

objectOptional

or

stringOptional

Responses

204

The request was successful. The attribute was added to the session context.

404

A session context with the provided ID was not found.

application/json

500

A server-side error occurred.

application/json

post

/session-context/{tenant}/context/{sessionId}/attributes

HTTPcURLJavaScriptPython

POST /session-context/{tenant}/context/{sessionId}/attributes HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 25

{
  "key": "text",
  "value": {}
}

No content