CalcOrders

Order system order management

Get all order IDs (and meta data) from your cart

get

Authorizations

PRIVATE-TOKENstringRequired

Responses

200

application/json

idinteger · integerRequired

Order ID

finalizedbooleanRequired

True if an order has been added to the cart.

instantDeliverablebooleanRequired

Whether this order is instantly deliverable (normally speaking)

403

Invalid credentials

500

Internal Server Error

application/json

get

/v3/calc/orders

GET /v3/calc/orders HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "id": 1,
    "finalized": true,
    "instantDeliverable": true
  }
]

Create an order from a config (tag)

post

Authorizations

PRIVATE-TOKENstringRequired

Body

configTagstringRequired

Configuration tag to create an order from.

couponTagstringRequired

Coupon tag to apply to the order.

instantFinalizebooleanRequired

Whether you want to immediately make the order available for checkout.

Responses

200

application/json

idinteger · integerRequired

Order ID

finalizedbooleanRequired

Whether the order has been added to your cart.

createdAtinteger · integerRequired

Order creation unix timestamp

modifiedAtinteger · integerRequired

Order last modification unix timestamp

quantityinteger · integerRequired

Order quantity multiplier

titlestringRequired

Order title

categoryIdinteger · integerRequired

Order shop category ID

categoryNamestringRequired

Order shop category name

configTagstringRequired

The tag of the configuration this order is based upon.

configNamestringRequired

The name of the configuration this order is based upon.

configFlagsinteger · integerRequired

ApplicationInstanceConfiguration flags IMMUTABLE 1; INSTANT_CONFIG 2; ALLOW_DOWNGRADE 4; IS_DEAL 8; ON_DEAL_PAGE 16; COLO_NO_CONN 32; PRIVATE_CONFIG 64;

instantDeliverablebooleanRequired

Whether this configuration can be setup instantly and automatically (low wait time)

priceinteger · integerRequired

Order price in cents

setupinteger · integerRequired

Order setup price in cents

vatinteger · integerRequired

Order VAT in cents

vatPercentagenumber · floatRequired

Order VAT percentage

403

Invalid credentials

422

Unprocessable Entity

500

Internal Server Error

application/json

post

/v3/calc/orders

POST /v3/calc/orders HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 62

{
  "configTag": "text",
  "couponTag": "text",
  "instantFinalize": true
}

{
  "id": 1,
  "finalized": true,
  "createdAt": 1,
  "modifiedAt": 1,
  "quantity": 1,
  "title": "text",
  "categoryId": 1,
  "categoryName": "text",
  "configTag": "text",
  "configName": "text",
  "configFlags": 1,
  "instantDeliverable": true,
  "price": 1,
  "setup": 1,
  "vat": 1,
  "vatPercentage": 1,
  "items": [
    {
      "itemId": 1,
      "groupId": 1,
      "quantity": 1
    }
  ]
}

Submit a quote request for your current cart

post

Authorizations

PRIVATE-TOKENstringRequired

Body

userIdinteger · integerOptional

Customer's user ID

firstNamestring · min: 2 · max: 64Required

Customer's first name

lastNamestring · min: 2 · max: 128Required

Customer's last name

companyNamestring · max: 120Optional

Customer's company name (optional)

emailstring · max: 128Required

Customer's email address

phonestring · min: 5 · max: 15Required

Customer's phone number

remarksstring · max: 4000Optional

Remarks contain specific question(s) regarding the quote

Responses

200

No content

403

Invalid credentials

404

If your cart is completely empty

422

If you have an error in the submitted values

500

Internal Server Error

application/json

post

/v3/calc/orders/quote

POST /v3/calc/orders/quote HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 117

{
  "userId": 1,
  "firstName": "text",
  "lastName": "text",
  "companyName": "text",
  "email": "text",
  "phone": "text",
  "remarks": "text"
}

No content

Get an order from the cart

get

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

orderIdintegerRequired

Order ID

Responses

200

application/json

idinteger · integerRequired

Order ID

finalizedbooleanRequired

Whether the order has been added to your cart.

createdAtinteger · integerRequired

Order creation unix timestamp

modifiedAtinteger · integerRequired

Order last modification unix timestamp

quantityinteger · integerRequired

Order quantity multiplier

titlestringRequired

Order title

categoryIdinteger · integerRequired

Order shop category ID

categoryNamestringRequired

Order shop category name

configTagstringRequired

The tag of the configuration this order is based upon.

configNamestringRequired

The name of the configuration this order is based upon.

configFlagsinteger · integerRequired

ApplicationInstanceConfiguration flags IMMUTABLE 1; INSTANT_CONFIG 2; ALLOW_DOWNGRADE 4; IS_DEAL 8; ON_DEAL_PAGE 16; COLO_NO_CONN 32; PRIVATE_CONFIG 64;

instantDeliverablebooleanRequired

Whether this configuration can be setup instantly and automatically (low wait time)

priceinteger · integerRequired

Order price in cents

setupinteger · integerRequired

Order setup price in cents

vatinteger · integerRequired

Order VAT in cents

vatPercentagenumber · floatRequired

Order VAT percentage

403

Invalid credentials

404

If the order was not found

500

Internal Server Error

application/json

get

/v3/calc/orders/{orderId}

GET /v3/calc/orders/{orderId} HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

{
  "id": 1,
  "finalized": true,
  "createdAt": 1,
  "modifiedAt": 1,
  "quantity": 1,
  "title": "text",
  "categoryId": 1,
  "categoryName": "text",
  "configTag": "text",
  "configName": "text",
  "configFlags": 1,
  "instantDeliverable": true,
  "price": 1,
  "setup": 1,
  "vat": 1,
  "vatPercentage": 1,
  "items": [
    {
      "itemId": 1,
      "groupId": 1,
      "quantity": 1
    }
  ]
}

Update an order

put

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

orderIdintegerRequired

Order ID

Body

quantityinteger · integerRequired

Order quantity

Responses

200

application/json

idinteger · integerRequired

Order ID

finalizedbooleanRequired

Whether the order has been added to your cart.

createdAtinteger · integerRequired

Order creation unix timestamp

modifiedAtinteger · integerRequired

Order last modification unix timestamp

quantityinteger · integerRequired

Order quantity multiplier

titlestringRequired

Order title

categoryIdinteger · integerRequired

Order shop category ID

categoryNamestringRequired

Order shop category name

configTagstringRequired

The tag of the configuration this order is based upon.

configNamestringRequired

The name of the configuration this order is based upon.

configFlagsinteger · integerRequired

ApplicationInstanceConfiguration flags IMMUTABLE 1; INSTANT_CONFIG 2; ALLOW_DOWNGRADE 4; IS_DEAL 8; ON_DEAL_PAGE 16; COLO_NO_CONN 32; PRIVATE_CONFIG 64;

instantDeliverablebooleanRequired

Whether this configuration can be setup instantly and automatically (low wait time)

priceinteger · integerRequired

Order price in cents

setupinteger · integerRequired

Order setup price in cents

vatinteger · integerRequired

Order VAT in cents

vatPercentagenumber · floatRequired

Order VAT percentage

403

Invalid credentials

404

If the order was not found

422

If you have an error in the submitted order values

500

Internal Server Error

application/json

put

/v3/calc/orders/{orderId}

PUT /v3/calc/orders/{orderId} HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 62

{
  "quantity": 1,
  "items": [
    {
      "itemId": 1,
      "groupId": 1,
      "quantity": 1
    }
  ]
}

{
  "id": 1,
  "finalized": true,
  "createdAt": 1,
  "modifiedAt": 1,
  "quantity": 1,
  "title": "text",
  "categoryId": 1,
  "categoryName": "text",
  "configTag": "text",
  "configName": "text",
  "configFlags": 1,
  "instantDeliverable": true,
  "price": 1,
  "setup": 1,
  "vat": 1,
  "vatPercentage": 1,
  "items": [
    {
      "itemId": 1,
      "groupId": 1,
      "quantity": 1
    }
  ]
}

Delete an order from the cart

delete

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

orderIdintegerRequired

Order ID

Responses

204

No Content

403

Invalid credentials

404

If the order was not found

500

Internal Server Error

application/json

delete

/v3/calc/orders/{orderId}

DELETE /v3/calc/orders/{orderId} HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

No content

Set an order in the cart to "checkout" (which means it will show up on the checkout page). Updating the order is still allowed after finalization

put

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

orderIdintegerRequired

Order ID

Responses

204

No Content

403

Invalid credentials

404

If the order was not found

500

Internal Server Error

application/json

put

/v3/calc/orders/finalize/{orderId}

PUT /v3/calc/orders/finalize/{orderId} HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

No content

Last updated 2 months ago

Was this helpful?

hashtagGet all order IDs (and meta data) from your cart

hashtagCreate an order from a config (tag)

hashtagSubmit a quote request for your current cart

hashtagGet an order from the cart

hashtagUpdate an order

hashtagDelete an order from the cart

hashtagSet an order in the cart to "checkout" (which means it will show up on the checkout page). Updating the order is still allowed after finalization

Get all order IDs (and meta data) from your cart

Create an order from a config (tag)

Submit a quote request for your current cart

Get an order from the cart

Update an order

Delete an order from the cart

Set an order in the cart to "checkout" (which means it will show up on the checkout page). Updating the order is still allowed after finalization