API ReferenceView as MarkdownOpenAPI

Orders & checkout

View as Markdown

Orders are completed purchases from the store - products, programs, tickets, donations - with their payment, delivery and status. Carts and checkout sessions lead to them.

Endpoints that need a token: the site owner creates it in their admin (Developers > API reference). AI assistants: how to ask the user for one.

69 endpoints in 13 parts: Boxnow Settings, Cart, Econt Settings, Order, Origin Address, Payment, Payment Metod, Receipt Adjustment, Shipping, Speedy Settings, Tax, User Payment Settings, AI builder.

Endpoints
GET/boxnow-officesPOST/boxnow-settingsGET/boxnow-settings/:deliveryPATCH/boxnow-settings/:idDELETE/boxnow-settings/:idPATCH/boxnow-shipping-id/:idGET/cartsPOST/cartsPATCH/carts/:idDELETE/carts/:idGET/carts/countGET/my_cartsPOST/econt-settingsGET/econt-settings/:deliveryPATCH/econt-settings/:idPATCH/econt-shipping-id/:idGET/abandoned-ordersGET/ordersPOST/ordersGET/orders/:idGET/origin-addressPOST/origin-addressGET/origin-address/:idPATCH/origin-address/:idDELETE/origin-address/:idPOST/checkoutGET/client_tokenPATCH/finalize-orderGET/paymentGET/payment-receiptGET/ticket-pdf/:idGET/merchant_account_link/:status/:idPOST/payment_methodsGET/payment_methods/:idPATCH/payment_methods/:idDELETE/payment_methods/:idGET/receipt-adjustmentsPOST/receipt-adjustmentsGET/receipt-adjustments/:idGET/shippingsPOST/shippingsGET/shippings-by-id/:idPATCH/shippings/:idDELETE/shippings/:idGET/shippings/:regionGET/speedy-integration/:orderGET/speedy-login/:delivery/:username/:passwordGET/speedy-offices-by-product/:product/:country/:cityGET/speedy-offices/:delivery/:country/:cityGET/speedy-offices/:orderGET/speedy-services/:deliveryPOST/speedy-settingsGET/speedy-settings/:deliveryPATCH/speedy-settings/:idDELETE/speedy-settings/:idPATCH/speedy-shipping-id/:idPOST/validate-speedy-address/:orderGET/taxPOST/taxGET/tax/:idGET/currencyGET/currencyGET/user_merchant_account_link/:status/:idGET/user-payment-settingsPOST/user-payment-settingsGET/user-payment-settings/:idPATCH/user-payment-settings/:idDELETE/user-payment-settings/:idPOST/generate-origin-addresses

List all boxnow offices

Returns the site's boxnow offices, newest first unless a sort is given.

Public

Public - no token needed.

Status codes

200 500

GET/boxnow-offices
curl -X GET 'http://nd.max-media.io/boxnow-offices?ionic=true'

Create a boxnow setting

Creates a boxnow setting from the fields sent.

User token

Needs the token of a signed-in user.

Parameters
on_behalf_ofstring

The boxnow setting's on behalf of.

Returns

Returns the BoxNowSettings object.

Status codes

200 400 401 403 500

POST/boxnow-settings
curl -X POST 'http://nd.max-media.io/boxnow-settings?ionic=true' \
  -H 'Authorization: Bearer <TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{ "on_behalf_of": "..." }'
Response
{
  "shipping": "6543210fedcba98765432100",
  "create_label": false,
  "client_id": "example",
  "contactNumber": "example",
  "contactEmail": "jane@example.com",
  "contactName": "Example",
  "locationId": "example",
  "owner_id": "6543210fedcba98765432100",
  "box": [
    {
      "height": 1,
      "length": 1,
      "width": 1,
      "_id": "6543210fedcba98765432100"
    }
  ],
  "multiple_items": "box",
  "divide_by": 1,
  "_id": "6543210fedcba98765432100",
  "updatedAt": "2026-11-04T12:00:00.000Z",
  "createdAt": "2026-11-04T12:00:00.000Z",
  "product_default_dimensions": {
    "height": 0,
    "width": 0,
    "length": 0,
    "weight": 0
  }
}

List all boxnow settings

Returns the site's boxnow settings, newest first unless a sort is given.

User token

Needs the token of a signed-in user.

Path parameters
deliverystringRequired

The boxnow setting's delivery.

Returns

Returns a list of BoxNowSettings objects.

Status codes

200 401 500

GET/boxnow-settings/:delivery
curl -X GET 'http://nd.max-media.io/boxnow-settings/{delivery}?ionic=true' \
  -H 'Authorization: Bearer <TOKEN>'
Response
[
  {
    "shipping": "6543210fedcba98765432100",
    "create_label": false,
    "client_id": "example",
    "contactNumber": "example",
    "contactEmail": "jane@example.com",
    "contactName": "Example",
    "locationId": "example",
    "owner_id": "6543210fedcba98765432100",
    "box": [
      {
        "height": 1,
        "length": 1,
        "width": 1,
        "_id": "6543210fedcba98765432100"
      }
    ],
    "multiple_items": "box",
    "divide_by": 1,
    "_id": "6543210fedcba98765432100",
    "updatedAt": "2026-11-04T12:00:00.000Z",
    "createdAt": "2026-11-04T12:00:00.000Z",
    "product_default_dimensions": {
      "height": 0,
      "width": 0,
      "length": 0,
      "weight": 0
    }
  }
]

Update a boxnow setting

Changes the fields sent; the others stay as they are.

User token

Needs the token of a signed-in user.

Path parameters
idstringRequired

The ID of the boxnow setting.

Returns

Returns the BoxNowSettings object.

Status codes

200 400 401 404 500

PATCH/boxnow-settings/:id
curl -X PATCH 'http://nd.max-media.io/boxnow-settings/{id}?ionic=true' \
  -H 'Authorization: Bearer <TOKEN>'
Response
{
  "shipping": "6543210fedcba98765432100",
  "create_label": false,
  "client_id": "example",
  "contactNumber": "example",
  "contactEmail": "jane@example.com",
  "contactName": "Example",
  "locationId": "example",
  "owner_id": "6543210fedcba98765432100",
  "box": [
    {
      "height": 1,
      "length": 1,
      "width": 1,
      "_id": "6543210fedcba98765432100"
    }
  ],
  "multiple_items": "box",
  "divide_by": 1,
  "_id": "6543210fedcba98765432100",
  "updatedAt": "2026-11-04T12:00:00.000Z",
  "createdAt": "2026-11-04T12:00:00.000Z",
  "product_default_dimensions": {
    "height": 0,
    "width": 0,
    "length": 0,
    "weight": 0
  }
}

Delete a boxnow setting

Deletes the boxnow setting. This cannot be undone.

User token

Needs the token of a signed-in user.

Path parameters
idstringRequired

The ID of the boxnow setting.

Returns

Returns an empty answer on success.

Status codes

200 401 403 404 500

DELETE/boxnow-settings/:id
curl -X DELETE 'http://nd.max-media.io/boxnow-settings/{id}?ionic=true' \
  -H 'Authorization: Bearer <TOKEN>'

Update a boxnow shipping

Changes the fields sent; the others stay as they are.

User token

Needs the token of a signed-in user.

Path parameters
idstringRequired

The ID of the boxnow shipping.

Parameters
shippingstring

The boxnow shipping's shipping.

Status codes

200 401 404 500

PATCH/boxnow-shipping-id/:id
curl -X PATCH 'http://nd.max-media.io/boxnow-shipping-id/{id}?ionic=true' \
  -H 'Authorization: Bearer <TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{ "shipping": "..." }'
Response
{
  "shipping": "6543210fedcba98765432100",
  "create_label": false,
  "client_id": "example",
  "contactNumber": "example",
  "contactEmail": "jane@example.com",
  "contactName": "Example",
  "locationId": "example",
  "owner_id": "6543210fedcba98765432100",
  "box": [
    {
      "height": 1,
      "length": 1,
      "width": 1,
      "_id": "6543210fedcba98765432100"
    }
  ],
  "multiple_items": "box",
  "divide_by": 1,
  "_id": "6543210fedcba98765432100",
  "updatedAt": "2026-11-04T12:00:00.000Z",
  "createdAt": "2026-11-04T12:00:00.000Z",
  "product_default_dimensions": {
    "height": 0,
    "width": 0,
    "length": 0,
    "weight": 0
  }
}

List all carts

Returns the site's carts, newest first unless a sort is given.

User token

Needs the token of a signed-in user.

Returns

Returns a list of Cart objects.

Status codes

200 401 500

GET/carts
curl -X GET 'http://nd.max-media.io/carts?ionic=true' \
  -H 'Authorization: Bearer <TOKEN>'
Response
[
  {
    "session": "example",
    "items": [
      {
        "item": "6543210fedcba98765432100",
        "options": "example",
        "_id": "6543210fedcba98765432100"
      }
    ],
    "coupon": "6543210fedcba98765432100",
    "discount_value": 0,
    "_id": "6543210fedcba98765432100",
    "updatedAt": "2026-11-04T12:00:00.000Z",
    "createdAt": "2026-11-04T12:00:00.000Z",
    "ip_guessed": {
      "country": "example",
      "country_code": "example",
      "city": "example",
      "state": "example",
      "zip_code": "example",
      "dialing_code": "example"
    }
  }
]

Create a cart

Creates a cart from the fields sent.

User token

Needs the token of a signed-in user.

Returns

Returns the Cart object.

Status codes

201 400 401 500

POST/carts
curl -X POST 'http://nd.max-media.io/carts?ionic=true' \
  -H 'Authorization: Bearer <TOKEN>'
Response
{
  "session": "example",
  "items": [
    {
      "item": "6543210fedcba98765432100",
      "options": "example",
      "_id": "6543210fedcba98765432100"
    }
  ],
  "coupon": "6543210fedcba98765432100",
  "discount_value": 0,
  "_id": "6543210fedcba98765432100",
  "updatedAt": "2026-11-04T12:00:00.000Z",
  "createdAt": "2026-11-04T12:00:00.000Z",
  "ip_guessed": {
    "country": "example",
    "country_code": "example",
    "city": "example",
    "state": "example",
    "zip_code": "example",
    "dialing_code": "example"
  }
}

Update a cart

Changes the fields sent; the others stay as they are.

User token

Needs the token of a signed-in user.

Path parameters
idstringRequired

The ID of the cart.

Returns

Returns the Cart object.

Status codes

200 400 401 404 500

PATCH/carts/:id
curl -X PATCH 'http://nd.max-media.io/carts/{id}?ionic=true' \
  -H 'Authorization: Bearer <TOKEN>'
Response
{
  "session": "example",
  "items": [
    {
      "item": "6543210fedcba98765432100",
      "options": "example",
      "_id": "6543210fedcba98765432100"
    }
  ],
  "coupon": "6543210fedcba98765432100",
  "discount_value": 0,
  "_id": "6543210fedcba98765432100",
  "updatedAt": "2026-11-04T12:00:00.000Z",
  "createdAt": "2026-11-04T12:00:00.000Z",
  "ip_guessed": {
    "country": "example",
    "country_code": "example",
    "city": "example",
    "state": "example",
    "zip_code": "example",
    "dialing_code": "example"
  }
}

Delete a cart

Deletes the cart. This cannot be undone.

User token

Needs the token of a signed-in user.

Path parameters
idstringRequired

The ID of the cart.

Returns

Returns an empty answer on success.

Status codes

200 401 404 500

DELETE/carts/:id
curl -X DELETE 'http://nd.max-media.io/carts/{id}?ionic=true' \
  -H 'Authorization: Bearer <TOKEN>'

Count carts

Count carts.

Public

Public - no token needed.

Returns

Returns a list of Cart objects.

Status codes

200 500

GET/carts/count
curl -X GET 'http://nd.max-media.io/carts/count?ionic=true'
Response
[
  {
    "session": "example",
    "items": [
      {
        "item": "6543210fedcba98765432100",
        "options": "example",
        "_id": "6543210fedcba98765432100"
      }
    ],
    "coupon": "6543210fedcba98765432100",
    "discount_value": 0,
    "_id": "6543210fedcba98765432100",
    "updatedAt": "2026-11-04T12:00:00.000Z",
    "createdAt": "2026-11-04T12:00:00.000Z",
    "ip_guessed": {
      "country": "example",
      "country_code": "example",
      "city": "example",
      "state": "example",
      "zip_code": "example",
      "dialing_code": "example"
    }
  }
]

List all carts

Returns the site's carts, newest first unless a sort is given.

Optional user

Works without a token; with a user token the answer is personal.

Query parameters
sessionIdstring

Only carts with this session id.

pending_couponstring

Only carts with this pending coupon.

regionstring

Only carts with this region.

cart_onlystring

Only carts with this cart only.

Returns

Returns a list of Cart objects.

Status codes

200 500

GET/my_carts
curl -X GET 'http://nd.max-media.io/my_carts?ionic=true&sessionId=...&pending_coupon=...&region=...'
Response
[
  {
    "session": "example",
    "items": [
      {
        "item": "6543210fedcba98765432100",
        "options": "example",
        "_id": "6543210fedcba98765432100"
      }
    ],
    "coupon": "6543210fedcba98765432100",
    "discount_value": 0,
    "_id": "6543210fedcba98765432100",
    "updatedAt": "2026-11-04T12:00:00.000Z",
    "createdAt": "2026-11-04T12:00:00.000Z",
    "ip_guessed": {
      "country": "example",
      "country_code": "example",
      "city": "example",
      "state": "example",
      "zip_code": "example",
      "dialing_code": "example"
    }
  }
]

Create an econt setting

Creates an econt setting from the fields sent.

User token

Needs the token of a signed-in user.

Parameters
on_behalf_ofstring

The econt setting's on behalf of.

Returns

Returns the EcontSettings object.

Status codes

200 400 401 403 500

POST/econt-settings
curl -X POST 'http://nd.max-media.io/econt-settings?ionic=true' \
  -H 'Authorization: Bearer <TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{ "on_behalf_of": "..." }'
Response
{
  "shipping": "6543210fedcba98765432100",
  "create_label": false,
  "username": "Example",
  "from_office": false,
  "automatic_courier": false,
  "sender": "example",
  "payAfterAccept": false,
  "multiple_items": "box",
  "divide_by": 1,
  "box": [
    {
      "height": 1,
      "length": 1,
      "width": 1,
      "_id": "6543210fedcba98765432100"
    }
  ],
  "email_delivery": false,
  "sms_delivery": false,
  "free_delivery_method": "cash",
  "invoice_num": "example",
  "cdPayOptionsTemplate": "example",
  "owner_id": "6543210fedcba98765432100",
  "connected_account_owner_id": "6543210fedcba98765432100",
  "_id": "6543210fedcba98765432100",
  "sender_address": {
    "quarter": "example",
    "street": "example",
    "other": "example",
    "num": "example"
  },
  "sender_office": {
    "code": "example",
    "name": "Example"
  },
  "sender_agent": {
    "name": "Example",
    "phones": "+359 888 123 456",
    "email": "jane@example.com"
  },
  "product_default_dimensions": {
    "height": 0,
    "width": 0,
    "length": 0
  }
}

List all econt settings

Returns the site's econt settings, newest first unless a sort is given.

User token

Needs the token of a signed-in user.

Path parameters
deliverystringRequired

The econt setting's delivery.

Returns

Returns a list of EcontSettings objects.

Status codes

200 401 500

GET/econt-settings/:delivery
curl -X GET 'http://nd.max-media.io/econt-settings/{delivery}?ionic=true' \
  -H 'Authorization: Bearer <TOKEN>'
Response
[
  {
    "shipping": "6543210fedcba98765432100",
    "create_label": false,
    "username": "Example",
    "from_office": false,
    "automatic_courier": false,
    "sender": "example",
    "payAfterAccept": false,
    "multiple_items": "box",
    "divide_by": 1,
    "box": [
      {
        "height": 1,
        "length": 1,
        "width": 1,
        "_id": "6543210fedcba98765432100"
      }
    ],
    "email_delivery": false,
    "sms_delivery": false,
    "free_delivery_method": "cash",
    "invoice_num": "example",
    "cdPayOptionsTemplate": "example",
    "owner_id": "6543210fedcba98765432100",
    "connected_account_owner_id": "6543210fedcba98765432100",
    "_id": "6543210fedcba98765432100",
    "sender_address": {
      "quarter": "example",
      "street": "example",
      "other": "example",
      "num": "example"
    },
    "sender_office": {
      "code": "example",
      "name": "Example"
    },
    "sender_agent": {
      "name": "Example",
      "phones": "+359 888 123 456",
      "email": "jane@example.com"
    },
    "product_default_dimensions": {
      "height": 0,
      "width": 0,
      "length": 0
    }
  }
]

Update an econt setting

Changes the fields sent; the others stay as they are.

User token

Needs the token of a signed-in user.

Path parameters
idstringRequired

The ID of the econt setting.

Returns

Returns the EcontSettings object.

Status codes

200 400 401 404 500

PATCH/econt-settings/:id
curl -X PATCH 'http://nd.max-media.io/econt-settings/{id}?ionic=true' \
  -H 'Authorization: Bearer <TOKEN>'
Response
{
  "shipping": "6543210fedcba98765432100",
  "create_label": false,
  "username": "Example",
  "from_office": false,
  "automatic_courier": false,
  "sender": "example",
  "payAfterAccept": false,
  "multiple_items": "box",
  "divide_by": 1,
  "box": [
    {
      "height": 1,
      "length": 1,
      "width": 1,
      "_id": "6543210fedcba98765432100"
    }
  ],
  "email_delivery": false,
  "sms_delivery": false,
  "free_delivery_method": "cash",
  "invoice_num": "example",
  "cdPayOptionsTemplate": "example",
  "owner_id": "6543210fedcba98765432100",
  "connected_account_owner_id": "6543210fedcba98765432100",
  "_id": "6543210fedcba98765432100",
  "sender_address": {
    "quarter": "example",
    "street": "example",
    "other": "example",
    "num": "example"
  },
  "sender_office": {
    "code": "example",
    "name": "Example"
  },
  "sender_agent": {
    "name": "Example",
    "phones": "+359 888 123 456",
    "email": "jane@example.com"
  },
  "product_default_dimensions": {
    "height": 0,
    "width": 0,
    "length": 0
  }
}

Update an econt shipping

Changes the fields sent; the others stay as they are.

User token

Needs the token of a signed-in user.

Path parameters
idstringRequired

The ID of the econt shipping.

Parameters
shippingstring

The econt shipping's shipping.

Status codes

200 401 404 500

PATCH/econt-shipping-id/:id
curl -X PATCH 'http://nd.max-media.io/econt-shipping-id/{id}?ionic=true' \
  -H 'Authorization: Bearer <TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{ "shipping": "..." }'
Response
{
  "shipping": "6543210fedcba98765432100",
  "create_label": false,
  "username": "Example",
  "from_office": false,
  "automatic_courier": false,
  "sender": "example",
  "payAfterAccept": false,
  "multiple_items": "box",
  "divide_by": 1,
  "box": [
    {
      "height": 1,
      "length": 1,
      "width": 1,
      "_id": "6543210fedcba98765432100"
    }
  ],
  "email_delivery": false,
  "sms_delivery": false,
  "free_delivery_method": "cash",
  "invoice_num": "example",
  "cdPayOptionsTemplate": "example",
  "owner_id": "6543210fedcba98765432100",
  "connected_account_owner_id": "6543210fedcba98765432100",
  "_id": "6543210fedcba98765432100",
  "sender_address": {
    "quarter": "example",
    "street": "example",
    "other": "example",
    "num": "example"
  },
  "sender_office": {
    "code": "example",
    "name": "Example"
  },
  "sender_agent": {
    "name": "Example",
    "phones": "+359 888 123 456",
    "email": "jane@example.com"
  },
  "product_default_dimensions": {
    "height": 0,
    "width": 0,
    "length": 0
  }
}

List all abandoned orders

Returns the site's abandoned orders, newest first unless a sort is given.

User token

Needs the token of a signed-in user.

Returns

Returns a list of Order objects.

Status codes

200 401 500

GET/abandoned-orders
curl -X GET 'http://nd.max-media.io/abandoned-orders?ionic=true' \
  -H 'Authorization: Bearer <TOKEN>'
Response
[
  {
    "organization_name": "Example",
    "firstname": "Example",
    "lastname": "Example",
    "email": "jane@example.com",
    "phone_number": "+359 888 123 456",
    "address": "example",
    "city": "example",
    "state": "example",
    "country": "example",
    "zip_code": "example",
    "tax_identification_number": "example",
    "notes": "Text shown on the site.",
    "products": [
      "example"
    ],
    "products_obj": [
      {
        "product_id": "6543210fedcba98765432100",
        "name": "Example",
        "options": "example",
        "price": 49.9,
        "quantity": 1,
        "_id": "6543210fedcba98765432100"
      }
    ],
    "programs": [
      "example"
    ],
    "programs_obj": [
      {
        "program_id": "6543210fedcba98765432100",
        "title": "Example",
        "price": 49.9,
        "_id": "6543210fedcba98765432100"
      }
    ],
    "tickets": [
      "6543210fedcba98765432101"
    ],
    "donations": [
      "6543210fedcba98765432101"
    ],
    "donations_obj": [
      {
        "donation_id": "6543210fedcba98765432100",
        "name": "Example",
        "options": "example",
        "price": 49.9,
        "quantity": 1,
        "_id": "6543210fedcba98765432100"
      }
    ],
    "value": 49.9,
    "finalized": false,
    "fulfilled": false,
    "paid": false,
    "delivery_method": "example"
  }
]

List all orders

Returns the site's orders, newest first unless a sort is given.

User token

Needs the token of a signed-in user.

Returns

Returns a list of Order objects.

Status codes

200 401 500

GET/orders
curl -X GET 'http://nd.max-media.io/orders?ionic=true' \
  -H 'Authorization: Bearer <TOKEN>'
Response
[
  {
    "organization_name": "Example",
    "firstname": "Example",
    "lastname": "Example",
    "email": "jane@example.com",
    "phone_number": "+359 888 123 456",
    "address": "example",
    "city": "example",
    "state": "example",
    "country": "example",
    "zip_code": "example",
    "tax_identification_number": "example",
    "notes": "Text shown on the site.",
    "products": [
      "example"
    ],
    "products_obj": [
      {
        "product_id": "6543210fedcba98765432100",
        "name": "Example",
        "options": "example",
        "price": 49.9,
        "quantity": 1,
        "_id": "6543210fedcba98765432100"
      }
    ],
    "programs": [
      "example"
    ],
    "programs_obj": [
      {
        "program_id": "6543210fedcba98765432100",
        "title": "Example",
        "price": 49.9,
        "_id": "6543210fedcba98765432100"
      }
    ],
    "tickets": [
      "6543210fedcba98765432101"
    ],
    "donations": [
      "6543210fedcba98765432101"
    ],
    "donations_obj": [
      {
        "donation_id": "6543210fedcba98765432100",
        "name": "Example",
        "options": "example",
        "price": 49.9,
        "quantity": 1,
        "_id": "6543210fedcba98765432100"
      }
    ],
    "value": 49.9,
    "finalized": false,
    "fulfilled": false,
    "paid": false,
    "delivery_method": "example"
  }
]

Create an order

Creates an order from the fields sent.

Public

Public - no token needed.

Parameters
productsstring[]

The order's products.

Returns

Returns the Order object.

Status codes

200 400 500

POST/orders
curl -X POST 'http://nd.max-media.io/orders?ionic=true' \
  -H 'Content-Type: application/json' \
  -d '{ "products": "..." }'
Response
{
  "organization_name": "Example",
  "firstname": "Example",
  "lastname": "Example",
  "email": "jane@example.com",
  "phone_number": "+359 888 123 456",
  "address": "example",
  "city": "example",
  "state": "example",
  "country": "example",
  "zip_code": "example",
  "tax_identification_number": "example",
  "notes": "Text shown on the site.",
  "products": [
    "example"
  ],
  "products_obj": [
    {
      "product_id": "6543210fedcba98765432100",
      "name": "Example",
      "options": "example",
      "price": 49.9,
      "quantity": 1,
      "_id": "6543210fedcba98765432100"
    }
  ],
  "programs": [
    "example"
  ],
  "programs_obj": [
    {
      "program_id": "6543210fedcba98765432100",
      "title": "Example",
      "price": 49.9,
      "_id": "6543210fedcba98765432100"
    }
  ],
  "tickets": [
    "6543210fedcba98765432101"
  ],
  "donations": [
    "6543210fedcba98765432101"
  ],
  "donations_obj": [
    {
      "donation_id": "6543210fedcba98765432100",
      "name": "Example",
      "options": "example",
      "price": 49.9,
      "quantity": 1,
      "_id": "6543210fedcba98765432100"
    }
  ],
  "value": 49.9,
  "finalized": false,
  "fulfilled": false,
  "paid": false,
  "delivery_method": "example"
}

Retrieve an order

Returns one order, found by its ID.

Public

Public - no token needed.

Path parameters
idstringRequired

The ID of the order.

Returns

Returns the Order object.

Status codes

200 404 500

GET/orders/:id
curl -X GET 'http://nd.max-media.io/orders/{id}?ionic=true'
Response
{
  "organization_name": "Example",
  "firstname": "Example",
  "lastname": "Example",
  "email": "jane@example.com",
  "phone_number": "+359 888 123 456",
  "address": "example",
  "city": "example",
  "state": "example",
  "country": "example",
  "zip_code": "example",
  "tax_identification_number": "example",
  "notes": "Text shown on the site.",
  "products": [
    "example"
  ],
  "products_obj": [
    {
      "product_id": "6543210fedcba98765432100",
      "name": "Example",
      "options": "example",
      "price": 49.9,
      "quantity": 1,
      "_id": "6543210fedcba98765432100"
    }
  ],
  "programs": [
    "example"
  ],
  "programs_obj": [
    {
      "program_id": "6543210fedcba98765432100",
      "title": "Example",
      "price": 49.9,
      "_id": "6543210fedcba98765432100"
    }
  ],
  "tickets": [
    "6543210fedcba98765432101"
  ],
  "donations": [
    "6543210fedcba98765432101"
  ],
  "donations_obj": [
    {
      "donation_id": "6543210fedcba98765432100",
      "name": "Example",
      "options": "example",
      "price": 49.9,
      "quantity": 1,
      "_id": "6543210fedcba98765432100"
    }
  ],
  "value": 49.9,
  "finalized": false,
  "fulfilled": false,
  "paid": false,
  "delivery_method": "example"
}

Retrieve the origin address

Returns the origin address.

Public

Public - no token needed.

Returns

Returns the OriginAddress object.

Status codes

200 500

GET/origin-address
curl -X GET 'http://nd.max-media.io/origin-address?ionic=true'
Response
{
  "title": "Example",
  "_id": "6543210fedcba98765432100",
  "updatedAt": "2026-11-04T12:00:00.000Z",
  "createdAt": "2026-11-04T12:00:00.000Z"
}

Create an origin address

Create new origin_addres.

Admin token

Needs a site admin token.

Returns

Returns the OriginAddress object.

Status codes

201 401 500

POST/origin-address
curl -X POST 'http://nd.max-media.io/origin-address?ionic=true' \
  -H 'Authorization: Bearer <TOKEN>'
Response
{
  "title": "Example",
  "_id": "6543210fedcba98765432100",
  "updatedAt": "2026-11-04T12:00:00.000Z",
  "createdAt": "2026-11-04T12:00:00.000Z"
}

Retrieve an origin address

Returns one origin address, found by its ID.

Public

Public - no token needed.

Path parameters
idstringRequired

The ID of the origin address.

Returns

Returns the OriginAddress object.

Status codes

200 500

GET/origin-address/:id
curl -X GET 'http://nd.max-media.io/origin-address/{id}?ionic=true'
Response
{
  "title": "Example",
  "_id": "6543210fedcba98765432100",
  "updatedAt": "2026-11-04T12:00:00.000Z",
  "createdAt": "2026-11-04T12:00:00.000Z"
}

Update an origin address

Update OriginAddress by id.

Admin token

Needs a site admin token.

Path parameters
idstringRequired

The ID of the origin address.

Returns

Returns the OriginAddress object.

Status codes

200 400 401 404 500

PATCH/origin-address/:id
curl -X PATCH 'http://nd.max-media.io/origin-address/{id}?ionic=true' \
  -H 'Authorization: Bearer <TOKEN>'
Response
{
  "title": "Example",
  "_id": "6543210fedcba98765432100",
  "updatedAt": "2026-11-04T12:00:00.000Z",
  "createdAt": "2026-11-04T12:00:00.000Z"
}

Delete an origin address

Delete OriginAddress record by id.

Admin token

Needs a site admin token.

Path parameters
idstringRequired

The ID of the origin address.

Returns

Returns an empty answer on success.

Status codes

200 401 404 500

DELETE/origin-address/:id
curl -X DELETE 'http://nd.max-media.io/origin-address/{id}?ionic=true' \
  -H 'Authorization: Bearer <TOKEN>'

Create a checkout

Creates a checkout from the fields sent.

Public

Public - no token needed.

Query parameters
sessionIdstring

Only checkouts with this session id.

Parameters
order_idstring

The checkout's order id.

use_admin_pmstring

The checkout's use admin pm.

Status codes

201 400 404 500

POST/checkout
curl -X POST 'http://nd.max-media.io/checkout?ionic=true&sessionId=...' \
  -H 'Content-Type: application/json' \
  -d '{ "order_id": "...", "use_admin_pm": "..." }'
Response
{
  "has_cash": false,
  "cash_locale": "Pay by cash",
  "cash_instructions": "example",
  "cash_increase": 0,
  "has_card": false,
  "card_locale": "Pay with credit card",
  "email": "jane@example.com",
  "country": "example",
  "has_invoicing": false,
  "invoice_locale": "Pay via invoice",
  "invoicing_instructions": "example",
  "currency": "EUR",
  "agreedToTerms": false,
  "agreedToTermsAt": "example",
  "merchant_id": "example",
  "has_paypal": false,
  "paypal_increase": 0,
  "paypal_id": "example",
  "lock_currency": false,
  "commission_percentage": 4.4,
  "two_currencies": false,
  "second_currency": "EUR",
  "calculate_rate": false,
  "currency_rate": 1
}

Retrieve the client token

Returns the client token.

Public

Public - no token needed.

Status codes

200 500

GET/client_token
curl -X GET 'http://nd.max-media.io/client_token?ionic=true'

Update the finalize order

Changes the fields sent; the others stay as they are.

Public

Public - no token needed.

Parameters
order_idstring

The finalize order's order id.

payment_intentstring

The finalize order's payment intent.

ads_creditsstring

The finalize order's ads credits.

user_idstring

The finalize order's user id.

post_idstring

The finalize order's post id.

Returns

Returns the Order object.

Status codes

200 401 500

PATCH/finalize-order
curl -X PATCH 'http://nd.max-media.io/finalize-order?ionic=true' \
  -H 'Content-Type: application/json' \
  -d '{ "order_id": "...", "payment_intent": "...", "ads_credits": "...", "user_id": "...", "post_id": "..." }'
Response
{
  "organization_name": "Example",
  "firstname": "Example",
  "lastname": "Example",
  "email": "jane@example.com",
  "phone_number": "+359 888 123 456",
  "address": "example",
  "city": "example",
  "state": "example",
  "country": "example",
  "zip_code": "example",
  "tax_identification_number": "example",
  "notes": "Text shown on the site.",
  "products": [
    "example"
  ],
  "products_obj": [
    {
      "product_id": "6543210fedcba98765432100",
      "name": "Example",
      "options": "example",
      "price": 49.9,
      "quantity": 1,
      "_id": "6543210fedcba98765432100"
    }
  ],
  "programs": [
    "example"
  ],
  "programs_obj": [
    {
      "program_id": "6543210fedcba98765432100",
      "title": "Example",
      "price": 49.9,
      "_id": "6543210fedcba98765432100"
    }
  ],
  "tickets": [
    "6543210fedcba98765432101"
  ],
  "donations": [
    "6543210fedcba98765432101"
  ],
  "donations_obj": [
    {
      "donation_id": "6543210fedcba98765432100",
      "name": "Example",
      "options": "example",
      "price": 49.9,
      "quantity": 1,
      "_id": "6543210fedcba98765432100"
    }
  ],
  "value": 49.9,
  "finalized": false,
  "fulfilled": false,
  "paid": false,
  "delivery_method": "example"
}

Retrieve the payment

Returns the payment.

Optional user

Works without a token; with a user token the answer is personal.

Query parameters
order_idstring

Only payments with this order id.

skip_checkstring

Only payments with this skip check.

sessionIdstring

Only payments with this session id.

Status codes

200 500

GET/payment
curl -X GET 'http://nd.max-media.io/payment?ionic=true&order_id=...&skip_check=...&sessionId=...'
Response
{
  "organization_name": "Example",
  "firstname": "Example",
  "lastname": "Example",
  "email": "jane@example.com",
  "phone_number": "+359 888 123 456",
  "address": "example",
  "city": "example",
  "state": "example",
  "country": "example",
  "zip_code": "example",
  "tax_identification_number": "example",
  "notes": "Text shown on the site.",
  "products": [
    "example"
  ],
  "products_obj": [
    {
      "product_id": "6543210fedcba98765432100",
      "name": "Example",
      "options": "example",
      "price": 49.9,
      "quantity": 1,
      "_id": "6543210fedcba98765432100"
    }
  ],
  "programs": [
    "example"
  ],
  "programs_obj": [
    {
      "program_id": "6543210fedcba98765432100",
      "title": "Example",
      "price": 49.9,
      "_id": "6543210fedcba98765432100"
    }
  ],
  "tickets": [
    "6543210fedcba98765432101"
  ],
  "donations": [
    "6543210fedcba98765432101"
  ],
  "donations_obj": [
    {
      "donation_id": "6543210fedcba98765432100",
      "name": "Example",
      "options": "example",
      "price": 49.9,
      "quantity": 1,
      "_id": "6543210fedcba98765432100"
    }
  ],
  "value": 49.9,
  "finalized": false,
  "fulfilled": false,
  "paid": false,
  "delivery_method": "example"
}

Retrieve the payment receipt

Returns the payment receipt.

Optional user

Works without a token; with a user token the answer is personal.

Query parameters
idstring

The ID of the payment receipt.

Status codes

200 500

GET/payment-receipt
curl -X GET 'http://nd.max-media.io/payment-receipt?ionic=true&id=...'
Response
{
  "organization_name": "Example",
  "firstname": "Example",
  "lastname": "Example",
  "email": "jane@example.com",
  "phone_number": "+359 888 123 456",
  "address": "example",
  "city": "example",
  "state": "example",
  "country": "example",
  "zip_code": "example",
  "tax_identification_number": "example",
  "notes": "Text shown on the site.",
  "products": [
    "example"
  ],
  "products_obj": [
    {
      "product_id": "6543210fedcba98765432100",
      "name": "Example",
      "options": "example",
      "price": 49.9,
      "quantity": 1,
      "_id": "6543210fedcba98765432100"
    }
  ],
  "programs": [
    "example"
  ],
  "programs_obj": [
    {
      "program_id": "6543210fedcba98765432100",
      "title": "Example",
      "price": 49.9,
      "_id": "6543210fedcba98765432100"
    }
  ],
  "tickets": [
    "6543210fedcba98765432101"
  ],
  "donations": [
    "6543210fedcba98765432101"
  ],
  "donations_obj": [
    {
      "donation_id": "6543210fedcba98765432100",
      "name": "Example",
      "options": "example",
      "price": 49.9,
      "quantity": 1,
      "_id": "6543210fedcba98765432100"
    }
  ],
  "value": 49.9,
  "finalized": false,
  "fulfilled": false,
  "paid": false,
  "delivery_method": "example"
}

Retrieve a ticket pdf

Returns one ticket pdf, found by its ID.

Optional user

Works without a token; with a user token the answer is personal.

Path parameters
idstringRequired

The ID of the ticket pdf.

Query parameters
download_onlystring

Only ticket pdfs with this download only.

Status codes

200 500

GET/ticket-pdf/:id
curl -X GET 'http://nd.max-media.io/ticket-pdf/{id}?ionic=true&download_only=...'
Response
{
  "organization_name": "Example",
  "firstname": "Example",
  "lastname": "Example",
  "email": "jane@example.com",
  "phone_number": "+359 888 123 456",
  "address": "example",
  "city": "example",
  "state": "example",
  "country": "example",
  "zip_code": "example",
  "tax_identification_number": "example",
  "notes": "Text shown on the site.",
  "products": [
    "example"
  ],
  "products_obj": [
    {
      "product_id": "6543210fedcba98765432100",
      "name": "Example",
      "options": "example",
      "price": 49.9,
      "quantity": 1,
      "_id": "6543210fedcba98765432100"
    }
  ],
  "programs": [
    "example"
  ],
  "programs_obj": [
    {
      "program_id": "6543210fedcba98765432100",
      "title": "Example",
      "price": 49.9,
      "_id": "6543210fedcba98765432100"
    }
  ],
  "tickets": [
    "6543210fedcba98765432101"
  ],
  "donations": [
    "6543210fedcba98765432101"
  ],
  "donations_obj": [
    {
      "donation_id": "6543210fedcba98765432100",
      "name": "Example",
      "options": "example",
      "price": 49.9,
      "quantity": 1,
      "_id": "6543210fedcba98765432100"
    }
  ],
  "value": 49.9,
  "finalized": false,
  "fulfilled": false,
  "paid": false,
  "delivery_method": "example"
}

Create a payment method

Creates a payment method from the fields sent.

Admin token

Needs a site admin token.

Returns

Returns the PaymentMethod object.

Status codes

201 400 401 500

POST/payment_methods
curl -X POST 'http://nd.max-media.io/payment_methods?ionic=true' \
  -H 'Authorization: Bearer <TOKEN>'
Response
{
  "has_cash": false,
  "cash_locale": "Pay by cash",
  "cash_instructions": "example",
  "cash_increase": 0,
  "has_card": false,
  "card_locale": "Pay with credit card",
  "email": "jane@example.com",
  "country": "example",
  "has_invoicing": false,
  "invoice_locale": "Pay via invoice",
  "invoicing_instructions": "example",
  "currency": "EUR",
  "agreedToTerms": false,
  "agreedToTermsAt": "example",
  "merchant_id": "example",
  "has_paypal": false,
  "paypal_increase": 0,
  "paypal_id": "example",
  "lock_currency": false,
  "commission_percentage": 4.4,
  "two_currencies": false,
  "second_currency": "EUR",
  "calculate_rate": false,
  "currency_rate": 1
}

Retrieve a payment method

Returns one payment method, found by its ID.

Admin token

Needs a site admin token.

Path parameters
idstringRequired

The ID of the payment method.

Returns

Returns the PaymentMethod object.

Status codes

200 401 404 500

GET/payment_methods/:id
curl -X GET 'http://nd.max-media.io/payment_methods/{id}?ionic=true' \
  -H 'Authorization: Bearer <TOKEN>'
Response
{
  "has_cash": false,
  "cash_locale": "Pay by cash",
  "cash_instructions": "example",
  "cash_increase": 0,
  "has_card": false,
  "card_locale": "Pay with credit card",
  "email": "jane@example.com",
  "country": "example",
  "has_invoicing": false,
  "invoice_locale": "Pay via invoice",
  "invoicing_instructions": "example",
  "currency": "EUR",
  "agreedToTerms": false,
  "agreedToTermsAt": "example",
  "merchant_id": "example",
  "has_paypal": false,
  "paypal_increase": 0,
  "paypal_id": "example",
  "lock_currency": false,
  "commission_percentage": 4.4,
  "two_currencies": false,
  "second_currency": "EUR",
  "calculate_rate": false,
  "currency_rate": 1
}

Update a payment method

Changes the fields sent; the others stay as they are.

Admin token

Needs a site admin token.

Path parameters
idstringRequired

The ID of the payment method.

Parameters
has_cardboolean

Whether the payment method is has card.

emailstring

An email address.

countrystring

The payment method's country.

Returns

Returns the PaymentMethod object.

Status codes

200 400 401 404 500

PATCH/payment_methods/:id
curl -X PATCH 'http://nd.max-media.io/payment_methods/{id}?ionic=true' \
  -H 'Authorization: Bearer <TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{ "has_card": "...", "email": "...", "country": "..." }'
Response
{
  "has_cash": false,
  "cash_locale": "Pay by cash",
  "cash_instructions": "example",
  "cash_increase": 0,
  "has_card": false,
  "card_locale": "Pay with credit card",
  "email": "jane@example.com",
  "country": "example",
  "has_invoicing": false,
  "invoice_locale": "Pay via invoice",
  "invoicing_instructions": "example",
  "currency": "EUR",
  "agreedToTerms": false,
  "agreedToTermsAt": "example",
  "merchant_id": "example",
  "has_paypal": false,
  "paypal_increase": 0,
  "paypal_id": "example",
  "lock_currency": false,
  "commission_percentage": 4.4,
  "two_currencies": false,
  "second_currency": "EUR",
  "calculate_rate": false,
  "currency_rate": 1
}

Delete a payment method

Deletes the payment method. This cannot be undone.

Admin token

Needs a site admin token.

Path parameters
idstringRequired

The ID of the payment method.

Returns

Returns an empty answer on success.

Status codes

200 401 404 500

DELETE/payment_methods/:id
curl -X DELETE 'http://nd.max-media.io/payment_methods/{id}?ionic=true' \
  -H 'Authorization: Bearer <TOKEN>'

List all receipt adjustments

Returns the site's receipt adjustments, newest first unless a sort is given.

Admin token

Needs a site admin token.

Returns

Returns a list of ReceiptAdjustment objects.

Status codes

200 401 500

GET/receipt-adjustments
curl -X GET 'http://nd.max-media.io/receipt-adjustments?ionic=true' \
  -H 'Authorization: Bearer <TOKEN>'
Response
[
  {
    "about_page": "6543210fedcba98765432100",
    "_id": "6543210fedcba98765432100",
    "updatedAt": "2026-11-04T12:00:00.000Z",
    "createdAt": "2026-11-04T12:00:00.000Z"
  }
]

Create a receipt adjustment

Create new receipt_adjustment.

Admin token

Needs a site admin token.

Returns

Returns the ReceiptAdjustment object.

Status codes

201 400 401 500

POST/receipt-adjustments
curl -X POST 'http://nd.max-media.io/receipt-adjustments?ionic=true' \
  -H 'Authorization: Bearer <TOKEN>'
Response
{
  "about_page": "6543210fedcba98765432100",
  "_id": "6543210fedcba98765432100",
  "updatedAt": "2026-11-04T12:00:00.000Z",
  "createdAt": "2026-11-04T12:00:00.000Z"
}

Retrieve a receipt adjustment

Returns one receipt adjustment, found by its ID.

Admin token

Needs a site admin token.

Path parameters
idstringRequired

The ID of the receipt adjustment.

Returns

Returns the ReceiptAdjustment object.

Status codes

200 401 404 500

GET/receipt-adjustments/:id
curl -X GET 'http://nd.max-media.io/receipt-adjustments/{id}?ionic=true' \
  -H 'Authorization: Bearer <TOKEN>'
Response
{
  "about_page": "6543210fedcba98765432100",
  "_id": "6543210fedcba98765432100",
  "updatedAt": "2026-11-04T12:00:00.000Z",
  "createdAt": "2026-11-04T12:00:00.000Z"
}

List all shippings

Returns the site's shippings, newest first unless a sort is given.

Public

Public - no token needed.

Returns

Returns a list of Shipping objects.

Status codes

200 500

GET/shippings
curl -X GET 'http://nd.max-media.io/shippings?ionic=true'
Response
[
  {
    "region": "example",
    "has_store_pickup": false,
    "pickup_title": "Example",
    "pickup_address": "example",
    "pickup_available": "example",
    "pickup_instructions": "example",
    "delivery": [
      {
        "name": "Example",
        "estimated_delivery_time": "example",
        "fixed_rate": 1,
        "rate_per_total": 49.9,
        "rate_per_unit": 1,
        "has_free_delivery": false,
        "free_delivery_requirement": 0,
        "delivery_days": 3,
        "hasIntegration": true,
        "has_time_window": false,
        "available_from": "example",
        "available_to": "example",
        "timezone": "example",
        "_id": "6543210fedcba98765432100"
      }
    ],
    "owner_id": "6543210fedcba98765432100",
    "connected_account_owner_id": "6543210fedcba98765432100",
    "min_order_value": 0,
    "_id": "6543210fedcba98765432100",
    "updatedAt": "2026-11-04T12:00:00.000Z",
    "createdAt": "2026-11-04T12:00:00.000Z"
  }
]

Create a shipping

Create new shipping.

User token

Needs the token of a signed-in user.

Parameters
on_behalf_ofstring

The shipping's on behalf of.

Returns

Returns the Shipping object.

Status codes

201 400 401 403 500

POST/shippings
curl -X POST 'http://nd.max-media.io/shippings?ionic=true' \
  -H 'Authorization: Bearer <TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{ "on_behalf_of": "..." }'
Response
{
  "region": "example",
  "has_store_pickup": false,
  "pickup_title": "Example",
  "pickup_address": "example",
  "pickup_available": "example",
  "pickup_instructions": "example",
  "delivery": [
    {
      "name": "Example",
      "estimated_delivery_time": "example",
      "fixed_rate": 1,
      "rate_per_total": 49.9,
      "rate_per_unit": 1,
      "has_free_delivery": false,
      "free_delivery_requirement": 0,
      "delivery_days": 3,
      "hasIntegration": true,
      "has_time_window": false,
      "available_from": "example",
      "available_to": "example",
      "timezone": "example",
      "_id": "6543210fedcba98765432100"
    }
  ],
  "owner_id": "6543210fedcba98765432100",
  "connected_account_owner_id": "6543210fedcba98765432100",
  "min_order_value": 0,
  "_id": "6543210fedcba98765432100",
  "updatedAt": "2026-11-04T12:00:00.000Z",
  "createdAt": "2026-11-04T12:00:00.000Z"
}

Retrieve a shipping

Returns one shipping, found by its ID.

Public

Public - no token needed.

Path parameters
idstringRequired

The ID of the shipping.

Returns

Returns the Shipping object.

Status codes

200 404 500

GET/shippings-by-id/:id
curl -X GET 'http://nd.max-media.io/shippings-by-id/{id}?ionic=true'
Response
{
  "region": "example",
  "has_store_pickup": false,
  "pickup_title": "Example",
  "pickup_address": "example",
  "pickup_available": "example",
  "pickup_instructions": "example",
  "delivery": [
    {
      "name": "Example",
      "estimated_delivery_time": "example",
      "fixed_rate": 1,
      "rate_per_total": 49.9,
      "rate_per_unit": 1,
      "has_free_delivery": false,
      "free_delivery_requirement": 0,
      "delivery_days": 3,
      "hasIntegration": true,
      "has_time_window": false,
      "available_from": "example",
      "available_to": "example",
      "timezone": "example",
      "_id": "6543210fedcba98765432100"
    }
  ],
  "owner_id": "6543210fedcba98765432100",
  "connected_account_owner_id": "6543210fedcba98765432100",
  "min_order_value": 0,
  "_id": "6543210fedcba98765432100",
  "updatedAt": "2026-11-04T12:00:00.000Z",
  "createdAt": "2026-11-04T12:00:00.000Z"
}

Update a shipping

Update Shipping by id.

User token

Needs the token of a signed-in user.

Path parameters
idstringRequired

The ID of the shipping.

Returns

Returns the Shipping object.

Status codes

200 400 401 403 404 500

PATCH/shippings/:id
curl -X PATCH 'http://nd.max-media.io/shippings/{id}?ionic=true' \
  -H 'Authorization: Bearer <TOKEN>'
Response
{
  "region": "example",
  "has_store_pickup": false,
  "pickup_title": "Example",
  "pickup_address": "example",
  "pickup_available": "example",
  "pickup_instructions": "example",
  "delivery": [
    {
      "name": "Example",
      "estimated_delivery_time": "example",
      "fixed_rate": 1,
      "rate_per_total": 49.9,
      "rate_per_unit": 1,
      "has_free_delivery": false,
      "free_delivery_requirement": 0,
      "delivery_days": 3,
      "hasIntegration": true,
      "has_time_window": false,
      "available_from": "example",
      "available_to": "example",
      "timezone": "example",
      "_id": "6543210fedcba98765432100"
    }
  ],
  "owner_id": "6543210fedcba98765432100",
  "connected_account_owner_id": "6543210fedcba98765432100",
  "min_order_value": 0,
  "_id": "6543210fedcba98765432100",
  "updatedAt": "2026-11-04T12:00:00.000Z",
  "createdAt": "2026-11-04T12:00:00.000Z"
}

Delete a shipping

Delete Shipping record by id.

User token

Needs the token of a signed-in user.

Path parameters
idstringRequired

The ID of the shipping.

Returns

Returns an empty answer on success.

Status codes

200 401 403 404 500

DELETE/shippings/:id
curl -X DELETE 'http://nd.max-media.io/shippings/{id}?ionic=true' \
  -H 'Authorization: Bearer <TOKEN>'

List all shippings

Returns the site's shippings, newest first unless a sort is given.

Public

Public - no token needed.

Path parameters
regionstringRequired

The shipping's region.

Returns

Returns a list of Shipping objects.

Status codes

200 404 500

GET/shippings/:region
curl -X GET 'http://nd.max-media.io/shippings/{region}?ionic=true'
Response
[
  {
    "region": "example",
    "has_store_pickup": false,
    "pickup_title": "Example",
    "pickup_address": "example",
    "pickup_available": "example",
    "pickup_instructions": "example",
    "delivery": [
      {
        "name": "Example",
        "estimated_delivery_time": "example",
        "fixed_rate": 1,
        "rate_per_total": 49.9,
        "rate_per_unit": 1,
        "has_free_delivery": false,
        "free_delivery_requirement": 0,
        "delivery_days": 3,
        "hasIntegration": true,
        "has_time_window": false,
        "available_from": "example",
        "available_to": "example",
        "timezone": "example",
        "_id": "6543210fedcba98765432100"
      }
    ],
    "owner_id": "6543210fedcba98765432100",
    "connected_account_owner_id": "6543210fedcba98765432100",
    "min_order_value": 0,
    "_id": "6543210fedcba98765432100",
    "updatedAt": "2026-11-04T12:00:00.000Z",
    "createdAt": "2026-11-04T12:00:00.000Z"
  }
]

List all speedy integrations

Returns the site's speedy integrations, newest first unless a sort is given.

Public

Public - no token needed.

Path parameters
orderstringRequired

The speedy integration's order.

Query parameters
productIdstring

Only speedy integrations with this product id.

regionstring

Only speedy integrations with this region.

Status codes

200 404 500

GET/speedy-integration/:order
curl -X GET 'http://nd.max-media.io/speedy-integration/{order}?ionic=true&productId=...&region=...'
Response
{
  "organization_name": "Example",
  "firstname": "Example",
  "lastname": "Example",
  "email": "jane@example.com",
  "phone_number": "+359 888 123 456",
  "address": "example",
  "city": "example",
  "state": "example",
  "country": "example",
  "zip_code": "example",
  "tax_identification_number": "example",
  "notes": "Text shown on the site.",
  "products": [
    "example"
  ],
  "products_obj": [
    {
      "product_id": "6543210fedcba98765432100",
      "name": "Example",
      "options": "example",
      "price": 49.9,
      "quantity": 1,
      "_id": "6543210fedcba98765432100"
    }
  ],
  "programs": [
    "example"
  ],
  "programs_obj": [
    {
      "program_id": "6543210fedcba98765432100",
      "title": "Example",
      "price": 49.9,
      "_id": "6543210fedcba98765432100"
    }
  ],
  "tickets": [
    "6543210fedcba98765432101"
  ],
  "donations": [
    "6543210fedcba98765432101"
  ],
  "donations_obj": [
    {
      "donation_id": "6543210fedcba98765432100",
      "name": "Example",
      "options": "example",
      "price": 49.9,
      "quantity": 1,
      "_id": "6543210fedcba98765432100"
    }
  ],
  "value": 49.9,
  "finalized": false,
  "fulfilled": false,
  "paid": false,
  "delivery_method": "example"
}

Sign in

Sign in.

User token

Needs the token of a signed-in user.

Path parameters
deliverystringRequired

The speedy login's delivery.

usernamestringRequired

The speedy login's username.

passwordstringRequired

The account password.

Status codes

200 401 500

GET/speedy-login/:delivery/:username/:password
curl -X GET 'http://nd.max-media.io/speedy-login/{delivery}/{username}/{password}?ionic=true' \
  -H 'Authorization: Bearer <TOKEN>'
Response
{
  "shipping": "6543210fedcba98765432100",
  "create_label": false,
  "username": "Example",
  "account_id": "example",
  "owner_id": "6543210fedcba98765432100",
  "connected_account_owner_id": "6543210fedcba98765432100",
  "from_office": false,
  "contactName": "Example",
  "multiple_items": "box",
  "divide_by": 1,
  "box": [
    {
      "height": 1,
      "length": 1,
      "width": 1,
      "_id": "6543210fedcba98765432100"
    }
  ],
  "payAfterAccept": false,
  "returnShipmentServiceId": "example",
  "returnShipmentPayer": "SENDER",
  "bank_transfer_payment": false,
  "cash_receipt": false,
  "cash_vat_group": "example",
  "_id": "6543210fedcba98765432100",
  "address": {
    "countryId": 0,
    "country": "example",
    "stateId": "example",
    "siteId": "example",
    "postCode": "example",
    "streetName": "Example",
    "streetNo": "example",
    "blockNo": "example",
    "entranceNo": "example",
    "floorNo": "example",
    "apartmentNo": "example",
    "complexName": "Example"
  }
}

List all speedy offices products

Returns the site's speedy offices products, newest first unless a sort is given.

Public

Public - no token needed.

Path parameters
productstringRequired

The speedy offices product's product.

countrystringRequired

The speedy offices product's country.

citystringRequired

The speedy offices product's city.

Returns

Returns a list of Product objects.

Status codes

200 404 500

GET/speedy-offices-by-product/:product/:country/:city
curl -X GET 'http://nd.max-media.io/speedy-offices-by-product/{product}/{country}/{city}?ionic=true'
Response
[
  {
    "name": "Example",
    "url": "example-item",
    "static_url": "example-item",
    "ribbon": "example",
    "striked": "example",
    "price": 49.9,
    "description": "Text shown on the site.",
    "product_informations": [
      {
        "name": "Example",
        "description": "Text shown on the site.",
        "_id": "6543210fedcba98765432100"
      }
    ],
    "product_options": [
      {
        "name": "Example",
        "options": [],
        "informations": [],
        "_id": "6543210fedcba98765432100"
      }
    ],
    "published": true,
    "available_for_purchase": true,
    "medias": [
      {
        "media": "6543210fedcba98765432100",
        "gcs_url": "example-item",
        "gcs_480_30_url": "example-item",
        "gcs_720_30_url": "example-item",
        "gcs_1080_30_url": "example-item",
        "duration": 1,
        "vimeo_uri": "example",
        "vimeo_picture": "example",
        "vimeo_url": "example-item",
        "youtube_url": "example-item",
        "youtube_picture": "example",
        "thumbnail": "example",
        "_id": "6543210fedcba98765432100"
      }
    ],
    "collection_id": "6543210fedcba98765432100",
    "grouping": [
      {
        "collection_id": "6543210fedcba98765432100",
        "_id": "6543210fedcba98765432100"
      }
    ],
    "owner_id": "6543210fedcba98765432100",
    "connected_account_owner_id": "6543210fedcba98765432100",
    "qty": 1,
    "origin_address": "example",
    "selected": false,
    "custom_1": "example",
    "custom_2": "example",
    "custom_3": "example",
    "about_page": "6543210fedcba98765432100",
    "is_digital": false,
    "secondary_cta": {
      "show": false,
      "title": "Example",
      "webUrl": "example",
      "appUrl": "example"
    },
    "attached_priceplans": {
      "name": "Example",
      "priceplans": "example"
    }
  }
]

List all speedy offices

Returns the site's speedy offices, newest first unless a sort is given.

Public

Public - no token needed.

Path parameters
deliverystringRequired

The speedy office's delivery.

countrystringRequired

The speedy office's country.

citystringRequired

The speedy office's city.

Status codes

200 500

GET/speedy-offices/:delivery/:country/:city
curl -X GET 'http://nd.max-media.io/speedy-offices/{delivery}/{country}/{city}?ionic=true'

List all speedy offices

Returns the site's speedy offices, newest first unless a sort is given.

Public

Public - no token needed.

Path parameters
orderstringRequired

The speedy office's order.

Status codes

200 404 500

GET/speedy-offices/:order
curl -X GET 'http://nd.max-media.io/speedy-offices/{order}?ionic=true'
Response
{
  "organization_name": "Example",
  "firstname": "Example",
  "lastname": "Example",
  "email": "jane@example.com",
  "phone_number": "+359 888 123 456",
  "address": "example",
  "city": "example",
  "state": "example",
  "country": "example",
  "zip_code": "example",
  "tax_identification_number": "example",
  "notes": "Text shown on the site.",
  "products": [
    "example"
  ],
  "products_obj": [
    {
      "product_id": "6543210fedcba98765432100",
      "name": "Example",
      "options": "example",
      "price": 49.9,
      "quantity": 1,
      "_id": "6543210fedcba98765432100"
    }
  ],
  "programs": [
    "example"
  ],
  "programs_obj": [
    {
      "program_id": "6543210fedcba98765432100",
      "title": "Example",
      "price": 49.9,
      "_id": "6543210fedcba98765432100"
    }
  ],
  "tickets": [
    "6543210fedcba98765432101"
  ],
  "donations": [
    "6543210fedcba98765432101"
  ],
  "donations_obj": [
    {
      "donation_id": "6543210fedcba98765432100",
      "name": "Example",
      "options": "example",
      "price": 49.9,
      "quantity": 1,
      "_id": "6543210fedcba98765432100"
    }
  ],
  "value": 49.9,
  "finalized": false,
  "fulfilled": false,
  "paid": false,
  "delivery_method": "example"
}

List all speedy services

Returns the site's speedy services, newest first unless a sort is given.

User token

Needs the token of a signed-in user.

Path parameters
deliverystringRequired

The speedy service's delivery.

Status codes

200 401 500

GET/speedy-services/:delivery
curl -X GET 'http://nd.max-media.io/speedy-services/{delivery}?ionic=true' \
  -H 'Authorization: Bearer <TOKEN>'
Response
{
  "shipping": "6543210fedcba98765432100",
  "create_label": false,
  "username": "Example",
  "account_id": "example",
  "owner_id": "6543210fedcba98765432100",
  "connected_account_owner_id": "6543210fedcba98765432100",
  "from_office": false,
  "contactName": "Example",
  "multiple_items": "box",
  "divide_by": 1,
  "box": [
    {
      "height": 1,
      "length": 1,
      "width": 1,
      "_id": "6543210fedcba98765432100"
    }
  ],
  "payAfterAccept": false,
  "returnShipmentServiceId": "example",
  "returnShipmentPayer": "SENDER",
  "bank_transfer_payment": false,
  "cash_receipt": false,
  "cash_vat_group": "example",
  "_id": "6543210fedcba98765432100",
  "address": {
    "countryId": 0,
    "country": "example",
    "stateId": "example",
    "siteId": "example",
    "postCode": "example",
    "streetName": "Example",
    "streetNo": "example",
    "blockNo": "example",
    "entranceNo": "example",
    "floorNo": "example",
    "apartmentNo": "example",
    "complexName": "Example"
  }
}

Create a speedy setting

Creates a speedy setting from the fields sent.

User token

Needs the token of a signed-in user.

Parameters
on_behalf_ofstring

The speedy setting's on behalf of.

Returns

Returns the SpeedySettings object.

Status codes

200 400 401 403 500

POST/speedy-settings
curl -X POST 'http://nd.max-media.io/speedy-settings?ionic=true' \
  -H 'Authorization: Bearer <TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{ "on_behalf_of": "..." }'
Response
{
  "shipping": "6543210fedcba98765432100",
  "create_label": false,
  "username": "Example",
  "account_id": "example",
  "owner_id": "6543210fedcba98765432100",
  "connected_account_owner_id": "6543210fedcba98765432100",
  "from_office": false,
  "contactName": "Example",
  "multiple_items": "box",
  "divide_by": 1,
  "box": [
    {
      "height": 1,
      "length": 1,
      "width": 1,
      "_id": "6543210fedcba98765432100"
    }
  ],
  "payAfterAccept": false,
  "returnShipmentServiceId": "example",
  "returnShipmentPayer": "SENDER",
  "bank_transfer_payment": false,
  "cash_receipt": false,
  "cash_vat_group": "example",
  "_id": "6543210fedcba98765432100",
  "address": {
    "countryId": 0,
    "country": "example",
    "stateId": "example",
    "siteId": "example",
    "postCode": "example",
    "streetName": "Example",
    "streetNo": "example",
    "blockNo": "example",
    "entranceNo": "example",
    "floorNo": "example",
    "apartmentNo": "example",
    "complexName": "Example"
  }
}

List all speedy settings

Returns the site's speedy settings, newest first unless a sort is given.

User token

Needs the token of a signed-in user.

Path parameters
deliverystringRequired

The speedy setting's delivery.

Returns

Returns a list of SpeedySettings objects.

Status codes

200 401 500

GET/speedy-settings/:delivery
curl -X GET 'http://nd.max-media.io/speedy-settings/{delivery}?ionic=true' \
  -H 'Authorization: Bearer <TOKEN>'
Response
[
  {
    "shipping": "6543210fedcba98765432100",
    "create_label": false,
    "username": "Example",
    "account_id": "example",
    "owner_id": "6543210fedcba98765432100",
    "connected_account_owner_id": "6543210fedcba98765432100",
    "from_office": false,
    "contactName": "Example",
    "multiple_items": "box",
    "divide_by": 1,
    "box": [
      {
        "height": 1,
        "length": 1,
        "width": 1,
        "_id": "6543210fedcba98765432100"
      }
    ],
    "payAfterAccept": false,
    "returnShipmentServiceId": "example",
    "returnShipmentPayer": "SENDER",
    "bank_transfer_payment": false,
    "cash_receipt": false,
    "cash_vat_group": "example",
    "_id": "6543210fedcba98765432100",
    "address": {
      "countryId": 0,
      "country": "example",
      "stateId": "example",
      "siteId": "example",
      "postCode": "example",
      "streetName": "Example",
      "streetNo": "example",
      "blockNo": "example",
      "entranceNo": "example",
      "floorNo": "example",
      "apartmentNo": "example",
      "complexName": "Example"
    }
  }
]

Update a speedy setting

Changes the fields sent; the others stay as they are.

User token

Needs the token of a signed-in user.

Path parameters
idstringRequired

The ID of the speedy setting.

Parameters
countryIdstring

The speedy setting's country id.

siteIdstring

The speedy setting's site id.

addressstring

The speedy setting's address.

Returns

Returns the SpeedySettings object.

Status codes

200 400 401 404 500

PATCH/speedy-settings/:id
curl -X PATCH 'http://nd.max-media.io/speedy-settings/{id}?ionic=true' \
  -H 'Authorization: Bearer <TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{ "countryId": "...", "siteId": "...", "address": "..." }'
Response
{
  "shipping": "6543210fedcba98765432100",
  "create_label": false,
  "username": "Example",
  "account_id": "example",
  "owner_id": "6543210fedcba98765432100",
  "connected_account_owner_id": "6543210fedcba98765432100",
  "from_office": false,
  "contactName": "Example",
  "multiple_items": "box",
  "divide_by": 1,
  "box": [
    {
      "height": 1,
      "length": 1,
      "width": 1,
      "_id": "6543210fedcba98765432100"
    }
  ],
  "payAfterAccept": false,
  "returnShipmentServiceId": "example",
  "returnShipmentPayer": "SENDER",
  "bank_transfer_payment": false,
  "cash_receipt": false,
  "cash_vat_group": "example",
  "_id": "6543210fedcba98765432100",
  "address": {
    "countryId": 0,
    "country": "example",
    "stateId": "example",
    "siteId": "example",
    "postCode": "example",
    "streetName": "Example",
    "streetNo": "example",
    "blockNo": "example",
    "entranceNo": "example",
    "floorNo": "example",
    "apartmentNo": "example",
    "complexName": "Example"
  }
}

Delete a speedy setting

Deletes the speedy setting. This cannot be undone.

User token

Needs the token of a signed-in user.

Path parameters
idstringRequired

The ID of the speedy setting.

Returns

Returns an empty answer on success.

Status codes

200 401 403 404 500

DELETE/speedy-settings/:id
curl -X DELETE 'http://nd.max-media.io/speedy-settings/{id}?ionic=true' \
  -H 'Authorization: Bearer <TOKEN>'

Update a speedy shipping

Changes the fields sent; the others stay as they are.

User token

Needs the token of a signed-in user.

Path parameters
idstringRequired

The ID of the speedy shipping.

Parameters
shippingstring

The speedy shipping's shipping.

Status codes

200 401 404 500

PATCH/speedy-shipping-id/:id
curl -X PATCH 'http://nd.max-media.io/speedy-shipping-id/{id}?ionic=true' \
  -H 'Authorization: Bearer <TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{ "shipping": "..." }'
Response
{
  "shipping": "6543210fedcba98765432100",
  "create_label": false,
  "username": "Example",
  "account_id": "example",
  "owner_id": "6543210fedcba98765432100",
  "connected_account_owner_id": "6543210fedcba98765432100",
  "from_office": false,
  "contactName": "Example",
  "multiple_items": "box",
  "divide_by": 1,
  "box": [
    {
      "height": 1,
      "length": 1,
      "width": 1,
      "_id": "6543210fedcba98765432100"
    }
  ],
  "payAfterAccept": false,
  "returnShipmentServiceId": "example",
  "returnShipmentPayer": "SENDER",
  "bank_transfer_payment": false,
  "cash_receipt": false,
  "cash_vat_group": "example",
  "_id": "6543210fedcba98765432100",
  "address": {
    "countryId": 0,
    "country": "example",
    "stateId": "example",
    "siteId": "example",
    "postCode": "example",
    "streetName": "Example",
    "streetNo": "example",
    "blockNo": "example",
    "entranceNo": "example",
    "floorNo": "example",
    "apartmentNo": "example",
    "complexName": "Example"
  }
}

Validate a speedy address

Validate a speedy address.

User token

Needs the token of a signed-in user.

Path parameters
orderstringRequired

The speedy address's order.

Status codes

200 401 500

POST/validate-speedy-address/:order
curl -X POST 'http://nd.max-media.io/validate-speedy-address/{order}?ionic=true' \
  -H 'Authorization: Bearer <TOKEN>'
Response
{
  "organization_name": "Example",
  "firstname": "Example",
  "lastname": "Example",
  "email": "jane@example.com",
  "phone_number": "+359 888 123 456",
  "address": "example",
  "city": "example",
  "state": "example",
  "country": "example",
  "zip_code": "example",
  "tax_identification_number": "example",
  "notes": "Text shown on the site.",
  "products": [
    "example"
  ],
  "products_obj": [
    {
      "product_id": "6543210fedcba98765432100",
      "name": "Example",
      "options": "example",
      "price": 49.9,
      "quantity": 1,
      "_id": "6543210fedcba98765432100"
    }
  ],
  "programs": [
    "example"
  ],
  "programs_obj": [
    {
      "program_id": "6543210fedcba98765432100",
      "title": "Example",
      "price": 49.9,
      "_id": "6543210fedcba98765432100"
    }
  ],
  "tickets": [
    "6543210fedcba98765432101"
  ],
  "donations": [
    "6543210fedcba98765432101"
  ],
  "donations_obj": [
    {
      "donation_id": "6543210fedcba98765432100",
      "name": "Example",
      "options": "example",
      "price": 49.9,
      "quantity": 1,
      "_id": "6543210fedcba98765432100"
    }
  ],
  "value": 49.9,
  "finalized": false,
  "fulfilled": false,
  "paid": false,
  "delivery_method": "example"
}

Retrieve the tax

Returns the tax.

Admin token

Needs a site admin token.

Returns

Returns the Tax object.

Status codes

200 401 500

GET/tax
curl -X GET 'http://nd.max-media.io/tax?ionic=true' \
  -H 'Authorization: Bearer <TOKEN>'
Response
{
  "country": "example",
  "tax_rate": 1,
  "apply_to_shipping": false,
  "_id": "6543210fedcba98765432100",
  "updatedAt": "2026-11-04T12:00:00.000Z",
  "createdAt": "2026-11-04T12:00:00.000Z"
}

Create a tax

Create new tax.

Admin token

Needs a site admin token.

Returns

Returns the Tax object.

Status codes

201 400 401 500

POST/tax
curl -X POST 'http://nd.max-media.io/tax?ionic=true' \
  -H 'Authorization: Bearer <TOKEN>'
Response
{
  "country": "example",
  "tax_rate": 1,
  "apply_to_shipping": false,
  "_id": "6543210fedcba98765432100",
  "updatedAt": "2026-11-04T12:00:00.000Z",
  "createdAt": "2026-11-04T12:00:00.000Z"
}

Retrieve a tax

Returns one tax, found by its ID.

Admin token

Needs a site admin token.

Path parameters
idstringRequired

The ID of the tax.

Returns

Returns the Tax object.

Status codes

200 401 404 500

GET/tax/:id
curl -X GET 'http://nd.max-media.io/tax/{id}?ionic=true' \
  -H 'Authorization: Bearer <TOKEN>'
Response
{
  "country": "example",
  "tax_rate": 1,
  "apply_to_shipping": false,
  "_id": "6543210fedcba98765432100",
  "updatedAt": "2026-11-04T12:00:00.000Z",
  "createdAt": "2026-11-04T12:00:00.000Z"
}

Retrieve the currency

Returns the currency.

Public

Public - no token needed.

Status codes

200 500

GET/currency
curl -X GET 'http://nd.max-media.io/currency?ionic=true'
Response
{
  "has_cash": false,
  "cash_locale": "Pay by cash",
  "cash_instructions": "example",
  "cash_increase": 0,
  "has_card": false,
  "card_locale": "Pay with credit card",
  "email": "jane@example.com",
  "country": "example",
  "has_invoicing": false,
  "invoice_locale": "Pay via invoice",
  "invoicing_instructions": "example",
  "currency": "EUR",
  "agreedToTerms": false,
  "agreedToTermsAt": "example",
  "merchant_id": "example",
  "has_paypal": false,
  "paypal_increase": 0,
  "paypal_id": "example",
  "lock_currency": false,
  "commission_percentage": 4.4,
  "two_currencies": false,
  "second_currency": "EUR",
  "calculate_rate": false,
  "currency_rate": 1
}

Retrieve the currency

Returns the currency.

Public

Public - no token needed.

Status codes

200 500

GET/currency
curl -X GET 'http://nd.max-media.io/currency?ionic=true'
Response
{
  "has_card": false,
  "card_locale": "Pay with credit card",
  "email": "jane@example.com",
  "country": "example",
  "agreedToTerms": false,
  "agreedToTermsAt": "example",
  "merchant_id": "example",
  "has_paypal": false,
  "paypal_increase": 0,
  "paypal_id": "example",
  "owner_id": "6543210fedcba98765432100",
  "number": 1,
  "price_quote_number": "example",
  "bic": "example",
  "swift": "example",
  "tax_id": "example",
  "vat_id": "example",
  "logo": "6543210fedcba98765432100",
  "business_name": "Example",
  "business_name_translated": "Example",
  "responsible_official": "example",
  "responsible_official_translated": "example",
  "business_email": "jane@example.com",
  "company_id": "example"
}

List all user payment settings

Returns the site's user payment settings, newest first unless a sort is given.

User token

Needs the token of a signed-in user.

Returns

Returns a list of UserPaymentSettings objects.

Status codes

200 401 500

GET/user-payment-settings
curl -X GET 'http://nd.max-media.io/user-payment-settings?ionic=true' \
  -H 'Authorization: Bearer <TOKEN>'
Response
[
  {
    "has_card": false,
    "card_locale": "Pay with credit card",
    "email": "jane@example.com",
    "country": "example",
    "agreedToTerms": false,
    "agreedToTermsAt": "example",
    "merchant_id": "example",
    "has_paypal": false,
    "paypal_increase": 0,
    "paypal_id": "example",
    "owner_id": "6543210fedcba98765432100",
    "number": 1,
    "price_quote_number": "example",
    "bic": "example",
    "swift": "example",
    "tax_id": "example",
    "vat_id": "example",
    "logo": "6543210fedcba98765432100",
    "business_name": "Example",
    "business_name_translated": "Example",
    "responsible_official": "example",
    "responsible_official_translated": "example",
    "business_email": "jane@example.com",
    "company_id": "example"
  }
]

Create a user payment setting

Creates a user payment setting from the fields sent.

User token

Needs the token of a signed-in user.

Returns

Returns the UserPaymentSettings object.

Status codes

201 400 401 500

POST/user-payment-settings
curl -X POST 'http://nd.max-media.io/user-payment-settings?ionic=true' \
  -H 'Authorization: Bearer <TOKEN>'
Response
{
  "has_card": false,
  "card_locale": "Pay with credit card",
  "email": "jane@example.com",
  "country": "example",
  "agreedToTerms": false,
  "agreedToTermsAt": "example",
  "merchant_id": "example",
  "has_paypal": false,
  "paypal_increase": 0,
  "paypal_id": "example",
  "owner_id": "6543210fedcba98765432100",
  "number": 1,
  "price_quote_number": "example",
  "bic": "example",
  "swift": "example",
  "tax_id": "example",
  "vat_id": "example",
  "logo": "6543210fedcba98765432100",
  "business_name": "Example",
  "business_name_translated": "Example",
  "responsible_official": "example",
  "responsible_official_translated": "example",
  "business_email": "jane@example.com",
  "company_id": "example"
}

Retrieve a user payment setting

Returns one user payment setting, found by its ID.

User token

Needs the token of a signed-in user.

Path parameters
idstringRequired

The ID of the user payment setting.

Returns

Returns the UserPaymentSettings object.

Status codes

200 401 404 500

GET/user-payment-settings/:id
curl -X GET 'http://nd.max-media.io/user-payment-settings/{id}?ionic=true' \
  -H 'Authorization: Bearer <TOKEN>'
Response
{
  "has_card": false,
  "card_locale": "Pay with credit card",
  "email": "jane@example.com",
  "country": "example",
  "agreedToTerms": false,
  "agreedToTermsAt": "example",
  "merchant_id": "example",
  "has_paypal": false,
  "paypal_increase": 0,
  "paypal_id": "example",
  "owner_id": "6543210fedcba98765432100",
  "number": 1,
  "price_quote_number": "example",
  "bic": "example",
  "swift": "example",
  "tax_id": "example",
  "vat_id": "example",
  "logo": "6543210fedcba98765432100",
  "business_name": "Example",
  "business_name_translated": "Example",
  "responsible_official": "example",
  "responsible_official_translated": "example",
  "business_email": "jane@example.com",
  "company_id": "example"
}

Update a user payment setting

Changes the fields sent; the others stay as they are.

User token

Needs the token of a signed-in user.

Path parameters
idstringRequired

The ID of the user payment setting.

Parameters
has_cardboolean

Whether the user payment setting is has card.

emailstring

An email address.

countrystring

The user payment setting's country.

Returns

Returns the UserPaymentSettings object.

Status codes

200 400 401 404 500

PATCH/user-payment-settings/:id
curl -X PATCH 'http://nd.max-media.io/user-payment-settings/{id}?ionic=true' \
  -H 'Authorization: Bearer <TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{ "has_card": "...", "email": "...", "country": "..." }'
Response
{
  "has_card": false,
  "card_locale": "Pay with credit card",
  "email": "jane@example.com",
  "country": "example",
  "agreedToTerms": false,
  "agreedToTermsAt": "example",
  "merchant_id": "example",
  "has_paypal": false,
  "paypal_increase": 0,
  "paypal_id": "example",
  "owner_id": "6543210fedcba98765432100",
  "number": 1,
  "price_quote_number": "example",
  "bic": "example",
  "swift": "example",
  "tax_id": "example",
  "vat_id": "example",
  "logo": "6543210fedcba98765432100",
  "business_name": "Example",
  "business_name_translated": "Example",
  "responsible_official": "example",
  "responsible_official_translated": "example",
  "business_email": "jane@example.com",
  "company_id": "example"
}

Delete a user payment setting

Deletes the user payment setting. This cannot be undone.

User token

Needs the token of a signed-in user.

Path parameters
idstringRequired

The ID of the user payment setting.

Returns

Returns an empty answer on success.

Status codes

200 401 404 500

DELETE/user-payment-settings/:id
curl -X DELETE 'http://nd.max-media.io/user-payment-settings/{id}?ionic=true' \
  -H 'Authorization: Bearer <TOKEN>'

Generate an origin address with AI

Use it to add, modify, remove, translate, or manage origin addresses.

User token

Needs the token of a signed-in user.

Parameters
promptstring

What the AI should do with the origin address, in plain words - any language.

chatIdstring

The AI chat this request belongs to; its history and language carry over. Leave it out to start a new chat.

aiVersionstring

Which version of the AI builder to use; leave it out for the current one.

Status codes

200 401 500

POST/generate-origin-addresses
curl -X POST 'http://nd.max-media.io/generate-origin-addresses?ionic=true' \
  -H 'Authorization: Bearer <TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{ "prompt": "...", "chatId": "...", "aiVersion": "..." }'
↑↓ Navigate↵ GoEsc Close