Orders

Creating and viewing orders

Get order by ID

get

Gets an order by the given ID in the store

Authorizations

Path parameters

storeIdstring · uuidrequired

The ID of the store to get the order in

orderIdstring · uuidrequired

The ID of the order to get

Responses

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.sellsn.io/stores/{storeId}/orders/{orderId}' \
  --header 'Authorization: Bearer JWT'

200

400

401

403

404

200

text/plain

application/json

text/json

text/plain

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "dateCreated": "2025-04-03T08:10:57.075Z",
  "products": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "dateCreated": "2025-04-03T08:10:57.075Z",
      "product": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "dateCreated": "2025-04-03T08:10:57.075Z",
        "name": "text",
        "slug": "text",
        "description": "text",
        "cost": 1,
        "amountSold": 1,
        "files": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "dateCreated": "2025-04-03T08:10:57.075Z",
            "friendlyName": "text"
          }
        ],
        "tags": [
          "text"
        ],
        "webhookUrl": "text",
        "visibility": 0,
        "isPinned": true,
        "isDynamic": true,
        "imageNames": [
          "text"
        ],
        "keyAuthOptions": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "dateCreated": "2025-04-03T08:10:57.075Z",
          "isEnabled": true,
          "mask": "text",
          "level": "text",
          "expiryDays": 1
        },
        "ignoreOutOfStock": true,
        "customValueKeys": [
          "text"
        ],
        "shouldBlockVirtualPrivateNetworks": true,
        "deliveryMessage": "text",
        "minimumQuantity": 1,
        "maximumQuantity": 1,
        "order": 1,
        "likes": 1,
        "isBestSeller": true,
        "blacklistedPaymentGateways": [
          "text"
        ],
        "additionalFees": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "metadata": "text",
        "category": "text",
        "discordServerId": 1,
        "discordRoleId": 1,
        "requireDiscordAuthorization": true,
        "type": 0,
        "subscriptionPeriod": "text",
        "listedUntil": "2025-04-03T08:10:57.075Z",
        "subscriptionId": "text",
        "buttonLabel": "text",
        "buttonLink": "text"
      },
      "quantity": 1
    }
  ],
  "deliveredItem": "text",
  "status": "text",
  "gateway": "text",
  "transactionId": "text",
  "countryCode": "text",
  "ipAddress": "text",
  "userAgent": "text",
  "customer": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "dateCreated": "2025-04-03T08:10:57.075Z",
    "emailAddress": "text",
    "ipAddress": "text",
    "subscriptions": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "dateCreated": "2025-04-03T08:10:57.075Z",
        "expirationDate": "2025-04-03T08:10:57.075Z",
        "startDate": "2025-04-03T08:10:57.075Z",
        "customerId": "123e4567-e89b-12d3-a456-426614174000",
        "storeId": "123e4567-e89b-12d3-a456-426614174000",
        "productId": "123e4567-e89b-12d3-a456-426614174000"
      }
    ]
  },
  "cost": 1,
  "amountPaid": 1,
  "gatewayFee": 1,
  "platformFee": 1,
  "cryptoPrice": 1,
  "customValues": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "dateCreated": "2025-04-03T08:10:57.075Z",
      "key": "text",
      "value": "text"
    }
  ],
  "cryptocurrencyAddress": "text",
  "hasWarranty": true,
  "isMarketplace": true,
  "coupon": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "dateCreated": "2025-04-03T08:10:57.075Z",
    "name": "text",
    "uses": 1,
    "maximumUses": 1,
    "percentageDecrease": 1,
    "isEnabled": true,
    "enabledProductIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "storeId": "123e4567-e89b-12d3-a456-426614174000"
  },
  "discordUserId": 1,
  "discordUserName": "text",
  "key": "text",
  "affiliateCustomerId": "123e4567-e89b-12d3-a456-426614174000"
}

The object was successfully returned.

Get orders

get

Gets all the orders associated with a store and returns them as a paginated response, there is no way to get all orders in one response. Requires the Scopes.ViewOrders permission

Authorizations

Path parameters

storeIdstring · uuidrequired

The ID of the store to get the orders for

pageinteger · int32required

The page to select when viewing the orders

Query parameters

countinteger · int32optional

The amount of orders to display in one page

Responses

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.sellsn.io/stores/{storeId}/orders/{page}' \
  --header 'Authorization: Bearer JWT'

200

400

401

403

404

200

text/plain

application/json

text/json

text/plain

{
  "success": true,
  "pages": 1,
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "dateCreated": "2025-04-03T08:10:57.075Z",
      "products": [
        {
          "product": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "dateCreated": "2025-04-03T08:10:57.075Z",
            "name": "text",
            "description": "text",
            "tags": [
              "text"
            ],
            "imageNames": [
              "text"
            ],
            "cost": 1,
            "type": 0,
            "subscriptionPeriod": "text",
            "stock": 1,
            "ignoreOutOfStock": true,
            "isDynamic": true,
            "rating": 1,
            "minimumQuantity": 1,
            "maximumQuantity": 1,
            "order": 1,
            "visibility": 0,
            "likes": 1,
            "customValueKeys": [
              "text"
            ],
            "store": "[Circular Reference]",
            "discordRoleId": 1,
            "requireDiscordAuthorization": true,
            "useDiscordIntegration": true,
            "deliveryMessage": "text",
            "slug": "text",
            "buttonLabel": "text",
            "buttonLink": "text"
          },
          "quantity": 1
        }
      ],
      "quantity": 1,
      "gateway": "text",
      "transactionId": "text",
      "cryptoAddress": "text",
      "customer": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "dateCreated": "2025-04-03T08:10:57.075Z",
        "emailAddress": "text",
        "linkedIntegrations": [
          "text"
        ]
      },
      "status": "text",
      "amountPaid": 1,
      "gatewayFee": 1,
      "hasWarranty": true,
      "isMarketplace": true,
      "customValues": [
        {
          "key": "text",
          "value": "text"
        }
      ],
      "cost": 1,
      "key": "text",
      "coupon": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "dateCreated": "2025-04-03T08:10:57.075Z",
        "name": "text",
        "percentageDecrease": 1
      },
      "deliveredItem": "text"
    }
  ]
}

The object was successfully returned.

Create order

post

Creates a new order and returns all the data. Requires the Scopes.CreateOrders permission

Authorizations

Path parameters

storeIdstring · uuidrequired

The ID of the store to create the order for

Responses

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.sellsn.io/stores/{storeId}/orders' \
  --header 'Authorization: Bearer JWT'

200

400

401

403

404

200

text/plain

application/json

text/json

text/plain

{
  "success": true,
  "pages": 1,
  "data": [
    {
      "order": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "dateCreated": "2025-04-03T08:10:57.075Z",
        "products": [
          {
            "product": "[Circular Reference]",
            "quantity": 1
          }
        ],
        "quantity": 1,
        "gateway": "text",
        "transactionId": "text",
        "cryptoAddress": "text",
        "customer": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "dateCreated": "2025-04-03T08:10:57.075Z",
          "emailAddress": "text",
          "linkedIntegrations": [
            "text"
          ]
        },
        "status": "text",
        "amountPaid": 1,
        "gatewayFee": 1,
        "hasWarranty": true,
        "isMarketplace": true,
        "customValues": [
          {
            "key": "text",
            "value": "text"
          }
        ],
        "cost": 1,
        "key": "text",
        "coupon": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "dateCreated": "2025-04-03T08:10:57.075Z",
          "name": "text",
          "percentageDecrease": 1
        },
        "deliveredItem": "text"
      },
      "checkoutUrl": "text"
    }
  ]
}

The object was successfully returned.

Manually deliver order

put

Delivers the given order manually as if the customer purchased it through regular means, requires the Scopes.DeliverOrders permission. This will not do anything if the order has already been delivered

Authorizations

Path parameters

storeIdstring · uuidrequired

The ID of the store the order belongs to

orderIdstring · uuidrequired

The ID of the order to deliver

Responses

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://api.sellsn.io/stores/{storeId}/orders/{orderId}/deliver' \
  --header 'Authorization: Bearer JWT'

200

401

403

404

200

text/plain

application/json

text/json

text/plain

{
  "success": true,
  "message": "text",
  "data": null
}

The operation was successfully completed.

Search for orders

get

Authorizations

Path parameters

storeIdstring · uuidrequired

The ID of the store to search for orders in

pageinteger · int32required

The page to select when viewing the orders

querystringrequired

The query to search when looking for orders, you can use an exact ID and get the first element to find an order by the ID and search by customer email address

Responses

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.sellsn.io/stores/{storeId}/orders/{page}/search/{query}' \
  --header 'Authorization: Bearer JWT'

200

400

401

403

404

200

text/plain

application/json

text/json

text/plain

{
  "success": true,
  "pages": 1,
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "dateCreated": "2025-04-03T08:10:57.075Z",
      "products": [
        {
          "product": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "dateCreated": "2025-04-03T08:10:57.075Z",
            "name": "text",
            "description": "text",
            "tags": [
              "text"
            ],
            "imageNames": [
              "text"
            ],
            "cost": 1,
            "type": 0,
            "subscriptionPeriod": "text",
            "stock": 1,
            "ignoreOutOfStock": true,
            "isDynamic": true,
            "rating": 1,
            "minimumQuantity": 1,
            "maximumQuantity": 1,
            "order": 1,
            "visibility": 0,
            "likes": 1,
            "customValueKeys": [
              "text"
            ],
            "store": "[Circular Reference]",
            "discordRoleId": 1,
            "requireDiscordAuthorization": true,
            "useDiscordIntegration": true,
            "deliveryMessage": "text",
            "slug": "text",
            "buttonLabel": "text",
            "buttonLink": "text"
          },
          "quantity": 1
        }
      ],
      "quantity": 1,
      "gateway": "text",
      "transactionId": "text",
      "cryptoAddress": "text",
      "customer": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "dateCreated": "2025-04-03T08:10:57.075Z",
        "emailAddress": "text",
        "linkedIntegrations": [
          "text"
        ]
      },
      "status": "text",
      "amountPaid": 1,
      "gatewayFee": 1,
      "hasWarranty": true,
      "isMarketplace": true,
      "customValues": [
        {
          "key": "text",
          "value": "text"
        }
      ],
      "cost": 1,
      "key": "text",
      "coupon": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "dateCreated": "2025-04-03T08:10:57.075Z",
        "name": "text",
        "percentageDecrease": 1
      },
      "deliveredItem": "text"
    }
  ]
}

The object was successfully returned.