commerce

Manages monetary transactions using Xsolla

Authenticates and returns a user auth token for the given Xsolla project

POSThttp://admin.m2worlds.io/api/commerce/xsolla/{xsollaProjectId}/auth/

Authorization

BearerAuth

Path parameters

xsollaProjectId*string

Id of a Xsolla project.

Header parameters

Response

200400401403

Default Response

Body

application/json

token*string

Auth token for a user in a Xsolla project.

Request

JavaScriptCurl

const response = await fetch('http://admin.m2worlds.io/api/commerce/xsolla/{xsollaProjectId}/auth/', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "token": "text"
}

Returns the user's current cart in the project

GEThttp://admin.m2worlds.io/api/commerce/xsolla/{xsollaProjectId}/cart/

Authorization

BearerAuth

Path parameters

xsollaProjectId*string

Id of a Xsolla project.

Header parameters

Response

200400401403

Default Response

Body

application/json

id*string

price*xsollaItemPrice (any of)

Price details of a Xsolla item, if not free.

objectnull

items*array of object

Request

JavaScriptCurl

const response = await fetch('http://admin.m2worlds.io/api/commerce/xsolla/{xsollaProjectId}/cart/', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "id": "text",
  "price": {
    "amount": "text",
    "amount_without_discount": "text",
    "currency": "text"
  },
  "items": [
    {
      "datasourceId": "text",
      "objectDefId": "text",
      "itemVariantId": "text",
      "price": {
        "amount": "text",
        "amount_without_discount": "text",
        "currency": "text"
      }
    }
  ]
}

Clears user's current cart in the project

DELETEhttp://admin.m2worlds.io/api/commerce/xsolla/{xsollaProjectId}/cart/

Authorization

BearerAuth

Path parameters

xsollaProjectId*string

Id of a Xsolla project.

Header parameters

Response

200

Default Response

Request

JavaScriptCurl

const response = await fetch('http://admin.m2worlds.io/api/commerce/xsolla/{xsollaProjectId}/cart/', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Updates or adds an item to the user's current cart in the project

PUThttp://admin.m2worlds.io/api/commerce/xsolla/{xsollaProjectId}/cart/item/

Authorization

BearerAuth

Path parameters

xsollaProjectId*string

Id of a Xsolla project.

Header parameters

Body

application/json

datasourceId*string

The ID of a datasource

objectDefId*string

The ID of an object definition

itemVariantId*string

Id of an item variant for sale.

quantity*integer

Response

200

Default Response

Request

JavaScriptCurl

const response = await fetch('http://admin.m2worlds.io/api/commerce/xsolla/{xsollaProjectId}/cart/item/', {
    method: 'PUT',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "datasourceId": "text",
      "objectDefId": "text",
      "itemVariantId": "text"
    }),
});
const data = await response.json();

Deletes an item from the user's current cart in the project

DELETEhttp://admin.m2worlds.io/api/commerce/xsolla/{xsollaProjectId}/cart/item/

Authorization

BearerAuth

Path parameters

xsollaProjectId*string

Id of a Xsolla project.

Header parameters

Body

application/json

datasourceId*string

The ID of a datasource

objectDefId*string

The ID of an object definition

itemVariantId*string

Id of an item variant for sale.

Response

200

Default Response

Request

JavaScriptCurl

const response = await fetch('http://admin.m2worlds.io/api/commerce/xsolla/{xsollaProjectId}/cart/item/', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "datasourceId": "text",
      "objectDefId": "text",
      "itemVariantId": "text"
    }),
});
const data = await response.json();

Creates an order with all items in the user's current cart in a project

POSThttp://admin.m2worlds.io/api/commerce/xsolla/{xsollaProjectId}/checkout/cart

Authorization

BearerAuth

Path parameters

xsollaProjectId*string

Id of a Xsolla project.

Header parameters

Response

200400401403

Default Response

Body

application/json

orderId*integer

checkoutUrlstring

Request

JavaScriptCurl

const response = await fetch('http://admin.m2worlds.io/api/commerce/xsolla/{xsollaProjectId}/checkout/cart', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "checkoutUrl": "text"
}

Creates an order for a specific item in a project

POSThttp://admin.m2worlds.io/api/commerce/xsolla/{xsollaProjectId}/checkout/item

Authorization

BearerAuth

Path parameters

xsollaProjectId*string

Id of a Xsolla project.

Header parameters

Body

application/json

datasourceId*string

The ID of a datasource

objectDefId*string

The ID of an object definition

itemVariantId*string

Id of an item variant for sale.

quantity*integer

Response

200400401403

Default Response

Body

application/json

orderId*integer

checkoutUrlstring

Request

JavaScriptCurl

const response = await fetch('http://admin.m2worlds.io/api/commerce/xsolla/{xsollaProjectId}/checkout/item', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "datasourceId": "text",
      "objectDefId": "text",
      "itemVariantId": "text"
    }),
});
const data = await response.json();

Response

{
  "checkoutUrl": "text"
}

Creates a new item for sale in the project

POSThttp://admin.m2worlds.io/api/commerce/xsolla/{xsollaProjectId}/item/

Authorization

BearerAuth

Path parameters

xsollaProjectId*string

Id of a Xsolla project.

Header parameters

Body

application/json

datasourceId*string

The ID of a datasource

objectDefId*string

The ID of an object definition

itemVariantId*itemVariantId (string)

Id of an item variant for sale.

name*string

priceobject

disableItemboolean

Response

200

Default Response

Request

JavaScriptCurl

const response = await fetch('http://admin.m2worlds.io/api/commerce/xsolla/{xsollaProjectId}/item/', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "datasourceId": "text",
      "objectDefId": "text",
      "itemVariantId": "text",
      "name": "text"
    }),
});
const data = await response.json();

Returns a list of sellable items in the project

GEThttp://admin.m2worlds.io/api/commerce/xsolla/{xsollaProjectId}/items/

Authorization

BearerAuth

Path parameters

xsollaProjectId*string

Id of a Xsolla project.

Header parameters

Response

200400401403

Default Response

Body

application/json

datasourceId*string

The ID of a datasource

objectDefId*string

The ID of an object definition

itemVariantId*itemVariantId (string)

Id of an item variant for sale.

name*any of

stringnull

price*xsollaItemPrice (any of)

Price details of a Xsolla item, if not free.

objectnull

can_be_bought*boolean

is_free*boolean

Request

JavaScriptCurl

const response = await fetch('http://admin.m2worlds.io/api/commerce/xsolla/{xsollaProjectId}/items/', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

[
  {
    "datasourceId": "text",
    "objectDefId": "text",
    "itemVariantId": "text",
    "name": "text",
    "price": {
      "amount": "text",
      "amount_without_discount": "text",
      "currency": "text"
    },
    "can_be_bought": false,
    "is_free": false
  }
]

Returns details about a Xsolla order

GEThttp://admin.m2worlds.io/api/commerce/xsolla/{xsollaProjectId}/order/{xsollaOrderId}

Authorization

BearerAuth

Path parameters

xsollaProjectId*string

Id of a Xsolla project.

xsollaOrderId*integer

Id of a Xsolla Order.

Header parameters

Response

200400401403

Default Response

Body

application/json

orderId*integer

status*xsollaOrderStatus (any of)

The status of a Xsolla order.

enumenumenumenum

content*object

Request

JavaScriptCurl

const response = await fetch('http://admin.m2worlds.io/api/commerce/xsolla/{xsollaProjectId}/order/{xsollaOrderId}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "status": "new",
  "content": {
    "isFree": false,
    "price": {
      "amount": "text",
      "amount_without_discount": "text",
      "currency": "text"
    },
    "virtualPrice": {
      "amount": "text",
      "amount_without_discount": "text",
      "currency": "text"
    },
    "items": [
      {
        "datasourceId": "text",
        "objectDefId": "text",
        "itemVariantId": "text",
        "isFree": false,
        "price": {
          "amount": "text",
          "amount_without_discount": "text",
          "currency": "text"
        }
      }
    ]
  }
}

Validates a user buying from the xsolla web shop. Temporary while testing order flow

POSThttp://admin.m2worlds.io/api/commerce/xsolla/{xsollaProjectId}/webhook/validateUser

Path parameters

xsollaProjectId*string

Id of a Xsolla project.

Body

application/json

settings*object

user*object

Response

200

Default Response

Body

application/json

user*object

attributesarray of object

Request

JavaScriptCurl

const response = await fetch('http://admin.m2worlds.io/api/commerce/xsolla/{xsollaProjectId}/webhook/validateUser', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "settings": {},
      "user": {
        "id": "text"
      }
    }),
});
const data = await response.json();

Response

{
  "user": {
    "id": "text",
    "picture": "text",
    "name": "text"
  },
  "attributes": [
    {
      "key": "text",
      "value": "text"
    }
  ]
}

Xsolla webhook triggered by commerce actions

POSThttp://admin.m2worlds.io/api/commerce/xsolla/{xsollaProjectId}/webhook/

Path parameters

xsollaProjectId*string

Id of a Xsolla project.

Body

application/json

xsollaWebhookRequestSchema (any of)

The expected body for a webhook request from Xsolla.

objectobjectobject

Response

200

Default Response

Request

JavaScriptCurl

const response = await fetch('http://admin.m2worlds.io/api/commerce/xsolla/{xsollaProjectId}/webhook/', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "notification_type": "order_paid",
      "items": [
        {
          "sku": "text",
          "type": "virtual_good",
          "quantity": 0,
          "amount": "text",
          "promotions": [
            {
              "amount_without_discount": "text",
              "amount_with_discount": "text",
              "sequence": 0
            }
          ]
        }
      ],
      "order": {
        "id": 0,
        "mode": "default",
        "currency_type": "real",
        "currency": "text",
        "amount": "text",
        "status": "text",
        "platform": "xsolla",
        "promotions": [
          {
            "amount_without_discount": "text",
            "amount_with_discount": "text",
            "sequence": 0
          }
        ]
      },
      "user": {
        "external_id": "text",
        "email": "text"
      }
    }),
});
const data = await response.json();

Service health check

GEThttp://admin.m2worlds.io/api/commerce/healthz

Response

200

Default Response

Body

application/json

statusMessage (string)

Provides information about the service status.

Request

JavaScriptCurl

const response = await fetch('http://admin.m2worlds.io/api/commerce/healthz', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

"text"