API docs by Redocly

pAPI (1.0.0)

Download OpenAPI specification:

Health Check

Health Check

A simple GET request that returns the health status of the API.

header Parameters
api-key
required
string

API key

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "version": "string"
}

Orders

Creates an order

A POST request that creates an order.

header Parameters
api-key
required
string

API key

Request Body schema: application/json
required

Order object that needs to be created

customer_id
required
number
external_reference_nr
required
string
order_label
required
string
order_notification_emails
Array of strings
product_id
required
string
quantity
required
number
special_instructions
string
required
Array of objects
required
Array of objects
Array of objects

Responses

Request samples

Content type
application/json
{
  • "customer_id": 0,
  • "external_reference_nr": "string",
  • "order_label": "string",
  • "order_notification_emails": [
    ],
  • "product_id": "string",
  • "quantity": 0,
  • "special_instructions": "string",
  • "shipping": [
    ],
  • "services": [
    ],
  • "files": [
    ]
}

Response samples

Content type
application/json
{
  • "order_id": 0,
  • "external_reference_nr": "string",
  • "order_name": "string",
  • "order_email": "string",
  • "special_instructions": "string",
  • "status_id": 0,
  • "status_name": "string",
  • "customer_id": 0,
  • "web_id": 0,
  • "product_id": "string",
  • "quantity": 0,
  • "estimated_date": "string",
  • "created_at": "string",
  • "mail_orders": [
    ],
  • "order_lines": [
    ],
  • "total_price": 0
}

Returns an order

A simple GET request that returns an order.

path Parameters
id
required
number

The resource ID to retrieve

header Parameters
api-key
required
string

API key

Responses

Response samples

Content type
application/json
{
  • "order_id": 0,
  • "external_reference_nr": "string",
  • "order_label": "string",
  • "order_notification_emails": "string",
  • "special_instructions": "string",
  • "status_id": 0,
  • "status_label": "string",
  • "customer_id": 0,
  • "web_id": 0,
  • "product_id": "string",
  • "quantity": 0,
  • "estimated_date": "string",
  • "created_at": "string",
  • "shipping": [
    ],
  • "services": [
    ],
  • "total_price": 0
}

Returns an order by external ref

A simple GET request that returns an order.

path Parameters
id
required
number

The resource ID to retrieve

header Parameters
api-key
required
string

API key

Responses

Response samples

Content type
application/json
{
  • "order_id": 0,
  • "external_reference_nr": "string",
  • "order_label": "string",
  • "order_notification_emails": "string",
  • "special_instructions": "string",
  • "status_id": 0,
  • "status_label": "string",
  • "customer_id": 0,
  • "web_id": 0,
  • "product_id": "string",
  • "quantity": 0,
  • "estimated_date": "string",
  • "created_at": "string",
  • "shipping": [
    ],
  • "services": [
    ],
  • "total_price": 0
}

Customers

Returns all customers

A simple GET request that returns all customers.

query Parameters
page
number

The page number

limit
number

The number of items per page

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pages": {
    }
}

Creates a customer

A simple POST request that creates a customer.

header Parameters
api-key
required
string

API key

Request Body schema: application/json
required

Customer object that needs to be created

first_name
required
string
last_name
required
string
company_name
string
email
required
string
phone
required
string
required
object
object

Responses

Request samples

Content type
application/json
{
  • "first_name": "string",
  • "last_name": "string",
  • "company_name": "string",
  • "email": "string",
  • "phone": "string",
  • "billing_address": {
    },
  • "shipping_address": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "first_name": "string",
  • "last_name": "string",
  • "company_name": "string",
  • "email": "string",
  • "billing_address": {
    },
  • "shipping_address": {
    }
}

Returns a customer

A simple GET request that returns a customer.

path Parameters
id
required
number

The resource ID to retrieve

header Parameters
api-key
required
string

API key

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "first_name": "string",
  • "last_name": "string",
  • "company_name": "string",
  • "email": "string",
  • "phone": "string",
  • "billing_address": {
    },
  • "shipping_address": {
    },
  • "addresses": [
    ]
}

Addresses

Returns all addresses

A simple GET request that returns all addresses.

query Parameters
page
number

The page number

limit
number

The number of items per page

header Parameters
api-key
required
string

API key

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pages": {
    }
}

Creates an address

A simple POST request that creates an address.

header Parameters
api-key
required
string

API key

Request Body schema: application/json
required

Address object that needs to be created

address_line_1
required
string
address_line_2
string
city
required
string
state
required
string
zip_code
required
string
country
required
string
customer_id
required
number

Responses

Request samples

Content type
application/json
{
  • "address_line_1": "string",
  • "address_line_2": "string",
  • "city": "string",
  • "state": "string",
  • "zip_code": "string",
  • "country": "string",
  • "customer_id": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "address_line_1": "string",
  • "address_line_2": "string",
  • "city": "string",
  • "state": "string",
  • "zip_code": "string",
  • "country": "string",
  • "customer_id": 0
}

Returns an address

A simple GET request that returns an address.

path Parameters
id
required
number

The resource ID to retrieve

header Parameters
api-key
required
string

API key

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "address_line_1": "string",
  • "address_line_2": "string",
  • "city": "string",
  • "state": "string",
  • "zipCode": "string",
  • "country": "string",
  • "customer_id": 0
}

Products

Returns all products

A simple GET request that returns all products.

query Parameters
external_sku
string

External stock keeping unit

header Parameters
api-key
required
string

API key

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Returns a product

A simple GET request that returns a product.

path Parameters
id
required
string

The resource ID to retrieve

header Parameters
api-key
required
string

API key

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "product_type": "string",
  • "product_category": {
    },
  • "name": "string",
  • "tax_code": "string",
  • "size_x": 0,
  • "size_y": 0,
  • "material_weight": 0,
  • "meta": { },
  • "pricing_object": { }
}

Statuses

Returns all order statuses

A simple GET request that returns all order statuses.

header Parameters
api-key
required
string

API key

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Returns all shipping statuses

A simple GET request that returns all shipping statuses.

header Parameters
api-key
required
string

API key

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Returns an order status

A simple GET request that returns an order status.

path Parameters
id
required
number

The resource ID to retrieve

header Parameters
api-key
required
string

API key

Responses

Response samples

Content type
application/json
{
  • "status_id": 0,
  • "status_name": "string"
}

Returns a shipping status

A simple GET request that returns a shipping status.

path Parameters
id
required
number

The resource ID to retrieve

header Parameters
api-key
required
string

API key

Responses

Response samples

Content type
application/json
{
  • "status_id": 0,
  • "status_name": "string"
}

Shipping

Get a shipping quote

Calculate shipping costs for a product to a specified address.

Authorizations:
None
header Parameters
api-key
required
string

API key

Request Body schema: application/json
required

Shipping quote request

product_id
required
string

ID of the product to ship

quantity
required
integer >= 1

Number of items to ship

required
integer or object

Responses

Request samples

Content type
application/json
{
  • "product_id": "string",
  • "quantity": 1,
  • "shipping_address": 1
}

Response samples

Content type
application/json
[
  • {
    }
]