API docs by Redocly

Integration docs (1.0.0)

Download OpenAPI specification:Download

Integration docs

Inventory

Inventory List

Authorizations:
extApiKeyAuthorization
query Parameters
phrase
required
string <= 64 characters

Responses

Response samples

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

RFQ

Place Single Request for Quotation

Authorizations:
extApiKeyAuthorization
Request Body schema: application/json
required
ids
required
Array of numbers non-empty

Inventory item id

quantity
required
number >= 1
deliveryTime
string
Default: "Any"
Enum: "Emergency" "Next Day" "2-3 Days" "4-6 Days" "7-10 Days" "10+ Days" "Any"
note
string <= 1024 characters

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ],
  • "quantity": 1,
  • "deliveryTime": "Emergency",
  • "note": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "error": "Bad Request",
  • "statusCode": 400
}

List sent request for quotations

Authorizations:
extApiKeyAuthorization
query Parameters
uuids
Array of strings <uuid> [ items <uuid > ]
page
number
perPage
number

Responses

Response samples

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

List received request for quotations

Authorizations:
extApiKeyAuthorization
query Parameters
uuids
Array of strings <uuid> [ items <uuid > ]
page
number
perPage
number

Responses

Response samples

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

Create quote using rfq

Authorizations:
extApiKeyAuthorization
path Parameters
uuid
required
string

Responses

Response samples

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

Get quote using rfq

Authorizations:
extApiKeyAuthorization
path Parameters
uuid
required
string

Responses

Response samples

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

Decline rfq. Use it if you do not want to create quote for this rfq

Authorizations:
extApiKeyAuthorization
path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "error": "Bad Request",
  • "statusCode": 400
}

Manual Request for Quotation

Authorizations:
extApiKeyAuthorization
Request Body schema: application/json
referenceNumber
string or null <= 1024 characters
required
object
required
Array of objects
note
string or null <= 1024 characters

Responses

Request samples

Content type
application/json
{
  • "referenceNumber": "string",
  • "buyer": {
    },
  • "items": [
    ],
  • "note": "string"
}

Response samples

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

Payments

Get payment terms

Authorizations:
extApiKeyAuthorization
Request Body schema: application/json
order
string or null
Enum: "desc" "asc"
orderBy
string or null
Enum: "created_at" "updated_at"
uuids
Array of strings or null
page
integer or null
perPage
integer or null

Responses

Request samples

Content type
application/json
{
  • "order": "desc",
  • "orderBy": "created_at",
  • "uuids": [
    ],
  • "page": 0,
  • "perPage": 0
}

Response samples

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

Get payment methods.

Authorizations:
extApiKeyAuthorization
Request Body schema: application/json
order
string or null
Enum: "desc" "asc"
orderBy
string or null
Enum: "created_at" "updated_at"
uuids
Array of strings or null
enabled
boolean or null
methods
Array of strings or null
Enum: "bank_transfer" "stripe"
page
integer or null
perPage
integer or null

Responses

Request samples

Content type
application/json
{
  • "order": "desc",
  • "orderBy": "created_at",
  • "uuids": [
    ],
  • "enabled": true,
  • "methods": [
    ],
  • "page": 0,
  • "perPage": 0
}

Response samples

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

Change Payment Status. Works only if payment method is bank transfer!

Authorizations:
extApiKeyAuthorization
path Parameters
uuid
required
string
Request Body schema: application/json
status
required
string
Enum: "pending" "paid"

Responses

Request samples

Content type
application/json
{
  • "status": "pending"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "error": "Bad Request",
  • "statusCode": 400
}

Get payment

Authorizations:
extApiKeyAuthorization
path Parameters
uuid
required
string

Responses

Response samples

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

Quotes

Get quote

Authorizations:
extApiKeyAuthorization
path Parameters
uuid
required
string

Responses

Response samples

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

Put quote

Authorizations:
extApiKeyAuthorization
path Parameters
uuid
required
string
Request Body schema: application/json
number
required
string <= 32 characters
note
string or null <= 1024 characters
currency
required
string <= 3 characters
Enum: "PLN" "EUR" "USD" "GBP"
required
object
required
object
required
Array of objects <= 100 items
required
Array of objects non-empty
required
object
expires_at
required
string <date>

Responses

Request samples

Content type
application/json
{
  • "number": "string",
  • "note": "string",
  • "currency": "PLN",
  • "buyer": {
    },
  • "seller": {
    },
  • "additional_costs": [
    ],
  • "items": [
    ],
  • "payment_term": {
    },
  • "expires_at": "2019-08-24"
}

Response samples

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

Send quote

Authorizations:
extApiKeyAuthorization
path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "error": "Bad Request",
  • "statusCode": 400
}

Cancel quote

Authorizations:
extApiKeyAuthorization
path Parameters
uuid
required
string
Request Body schema: application/json
reason
string or null <= 1024 characters

Responses

Request samples

Content type
application/json
{
  • "reason": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "error": "Bad Request",
  • "statusCode": 400
}

Quote place order

Authorizations:
extApiKeyAuthorization
path Parameters
uuid
required
string
Request Body schema: application/json
purchaseOrderNumber
string or null <= 32 characters
paymentMethodType
string or null
Enum: "bank_transfer" "stripe"

required if paymentMethodUuid is null and seller has payment method types defined

paymentMethodUuid
string or null

required if paymentMethodType is null and seller has payment methods defined

object or null
object or null

Responses

Request samples

Content type
application/json
{
  • "purchaseOrderNumber": "string",
  • "paymentMethodType": "bank_transfer",
  • "paymentMethodUuid": "string",
  • "shippingRate": {
    },
  • "buyer": {
    }
}

Response samples

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

Orders

Get order

Authorizations:
extApiKeyAuthorization
path Parameters
uuid
required
string

Responses

Response samples

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

Get order payment

Authorizations:
extApiKeyAuthorization
path Parameters
uuid
required
string

Responses

Response samples

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

Accept order

Authorizations:
extApiKeyAuthorization
path Parameters
uuid
required
string
Request Body schema: application/json
paymentMethodUuid
string or null

Property required only if it was not assigned to the order when it was placed.

Responses

Request samples

Content type
application/json
{
  • "paymentMethodUuid": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "error": "Bad Request",
  • "statusCode": 400
}

Decline order

Authorizations:
extApiKeyAuthorization
path Parameters
uuid
required
string
Request Body schema: application/json
reason
string or null <= 1024 characters

Responses

Request samples

Content type
application/json
{
  • "reason": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "error": "Bad Request",
  • "statusCode": 400
}

Put order shipping details

Authorizations:
extApiKeyAuthorization
path Parameters
uuid
required
string
Request Body schema: application/json
trackingNumberUrl
required
string <= 1024 characters

Responses

Request samples

Content type
application/json
{
  • "trackingNumberUrl": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "error": "Bad Request",
  • "statusCode": 400
}

Webhooks

List registered webhooks

Authorizations:
extApiKeyAuthorization
query Parameters
uuids
Array of strings
eventTypes
Array of strings
Items Enum: "RFQ_RECEIVED" "RFQ_SENT" "QUOTE_ACCEPTED" "QUOTE_RECEIVED" "QUOTE_DECLINED" "QUOTE_EXPIRED" "QUOTE_OPENING_TRACKED" "ORDER_RECEIVED" "ORDER_PAYMENT_ASSIGNED" "PAYMENT_CREATED" "PAYMENT_STATUS_UPDATED"
page
number >= 0
Default: 1
perPage
number >= 0
Default: 20
order
string
Default: "asc"
Enum: "asc" "desc"
orderBy
string
Default: "createdAt"
Enum: "createdAt" "updatedAt"

Responses

Response samples

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

Register webhook

Authorizations:
extApiKeyAuthorization
Request Body schema: application/json
required
eventType
required
string
Enum: "RFQ_RECEIVED" "RFQ_SENT" "QUOTE_ACCEPTED" "QUOTE_RECEIVED" "QUOTE_DECLINED" "QUOTE_EXPIRED" "QUOTE_OPENING_TRACKED" "ORDER_RECEIVED" "ORDER_PAYMENT_ASSIGNED" "PAYMENT_CREATED" "PAYMENT_STATUS_UPDATED"
url
required
string <uri> <= 1024 characters
authorization
required
string <= 128 characters

Your authorization token which will be send as authorization header in webhook call

Responses

Request samples

Content type
application/json
{}

Response samples

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

Delete webhook

Authorizations:
extApiKeyAuthorization
path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "error": "Bad Request",
  • "statusCode": 400
}

Enable webhook

Authorizations:
extApiKeyAuthorization
path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "error": "Bad Request",
  • "statusCode": 400
}

Disable webhook

Authorizations:
extApiKeyAuthorization
path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "error": "Bad Request",
  • "statusCode": 400
}

List webhook executions

Authorizations:
extApiKeyAuthorization
query Parameters
uuids
Array of strings
page
number >= 0
Default: 1
perPage
number >= 0
Default: 20
order
string
Default: "asc"
Enum: "asc" "desc"
orderBy
string
Default: "createdAt"
Enum: "createdAt" "updatedAt"

Responses

Response samples

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

Products

List products availabilities.

Authorizations:
extApiKeyAuthorization
Request Body schema: application/json
required
productIds
required
Array of strings [ 1 .. 100 ] items

product item id

excludeMyStock
boolean
Default: false

exclude my stock offers

Responses

Request samples

Content type
application/json
{
  • "productIds": [
    ],
  • "excludeMyStock": false
}

Response samples

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

RFQ Webhook Events

RFQ Received Webhook

Authorizations:
webhookEventAuthorization
Request Body schema: application/json
timestamp
required
number
webhookUuid
required
string <uuid>
objectUuid
required
string
eventType
required
string
Value: "RFQ_RECEIVED"
required
any

Responses

Request samples

Content type
application/json
{
  • "timestamp": 0,
  • "webhookUuid": "8695c3d8-7b60-49f5-aa5e-6adbdeaf46c8",
  • "objectUuid": "string",
  • "eventType": "RFQ_RECEIVED",
  • "object": {
    }
}

RFQ Sent Webhook

Authorizations:
webhookEventAuthorization
Request Body schema: application/json
timestamp
required
number
webhookUuid
required
string <uuid>
objectUuid
required
string
eventType
required
string
Value: "RFQ_SENT"
required
any

Responses

Request samples

Content type
application/json
{
  • "timestamp": 0,
  • "webhookUuid": "8695c3d8-7b60-49f5-aa5e-6adbdeaf46c8",
  • "objectUuid": "string",
  • "eventType": "RFQ_SENT",
  • "object": {
    }
}

Quote Webhook Events

Quote Accepted Webhook

Authorizations:
webhookEventAuthorization
Request Body schema: application/json
timestamp
required
number
webhookUuid
required
string <uuid>
objectUuid
required
string
eventType
required
string
Value: "QUOTE_ACCEPTED"
required
object

Responses

Request samples

Content type
application/json
{
  • "timestamp": 0,
  • "webhookUuid": "8695c3d8-7b60-49f5-aa5e-6adbdeaf46c8",
  • "objectUuid": "string",
  • "eventType": "QUOTE_ACCEPTED",
  • "object": {
    }
}

Quote Received Webhook

Authorizations:
webhookEventAuthorization
Request Body schema: application/json
timestamp
required
number
webhookUuid
required
string <uuid>
objectUuid
required
string
eventType
required
string
Value: "QUOTE_RECEIVED"
required
object

Responses

Request samples

Content type
application/json
{
  • "timestamp": 0,
  • "webhookUuid": "8695c3d8-7b60-49f5-aa5e-6adbdeaf46c8",
  • "objectUuid": "string",
  • "eventType": "QUOTE_RECEIVED",
  • "object": {
    }
}

Quote Declined Webhook

Authorizations:
webhookEventAuthorization
Request Body schema: application/json
timestamp
required
number
webhookUuid
required
string <uuid>
objectUuid
required
string
eventType
required
string
Value: "QUOTE_DECLINED"
required
object

Responses

Request samples

Content type
application/json
{
  • "timestamp": 0,
  • "webhookUuid": "8695c3d8-7b60-49f5-aa5e-6adbdeaf46c8",
  • "objectUuid": "string",
  • "eventType": "QUOTE_DECLINED",
  • "object": {
    }
}

Quote Expired Webhook

Authorizations:
webhookEventAuthorization
Request Body schema: application/json
timestamp
required
number
webhookUuid
required
string <uuid>
objectUuid
required
string
eventType
required
string
Value: "QUOTE_EXPIRED"
required
object

Responses

Request samples

Content type
application/json
{
  • "timestamp": 0,
  • "webhookUuid": "8695c3d8-7b60-49f5-aa5e-6adbdeaf46c8",
  • "objectUuid": "string",
  • "eventType": "QUOTE_EXPIRED",
  • "object": {
    }
}

Quote Opening Tracked Webhook

Authorizations:
webhookEventAuthorization
Request Body schema: application/json
timestamp
required
number
webhookUuid
required
string <uuid>
objectUuid
required
string
eventType
required
string
Value: "QUOTE_OPENING_TRACKED"
required
object

Responses

Request samples

Content type
application/json
{
  • "timestamp": 0,
  • "webhookUuid": "8695c3d8-7b60-49f5-aa5e-6adbdeaf46c8",
  • "objectUuid": "string",
  • "eventType": "QUOTE_OPENING_TRACKED",
  • "object": {
    }
}

Order Webhook Events

Order Received Webhook

Authorizations:
webhookEventAuthorization
Request Body schema: application/json
timestamp
required
number
webhookUuid
required
string <uuid>
objectUuid
required
string
eventType
required
string
Value: "ORDER_RECEIVED"
required
object

Responses

Request samples

Content type
application/json
{
  • "timestamp": 0,
  • "webhookUuid": "8695c3d8-7b60-49f5-aa5e-6adbdeaf46c8",
  • "objectUuid": "string",
  • "eventType": "ORDER_RECEIVED",
  • "object": {
    }
}

Order Payment Assigned Webhook

Authorizations:
webhookEventAuthorization
Request Body schema: application/json
timestamp
required
number
webhookUuid
required
string <uuid>
objectUuid
required
string
eventType
required
string
Value: "ORDER_PAYMENT_ASSIGNED"
required
object

Responses

Request samples

Content type
application/json
{
  • "timestamp": 0,
  • "webhookUuid": "8695c3d8-7b60-49f5-aa5e-6adbdeaf46c8",
  • "objectUuid": "string",
  • "eventType": "ORDER_PAYMENT_ASSIGNED",
  • "object": {
    }
}

Payment Webhook Events

Payment Created Webhook

Authorizations:
webhookEventAuthorization
Request Body schema: application/json
timestamp
required
number
webhookUuid
required
string <uuid>
objectUuid
required
string
eventType
required
string
Value: "PAYMENT_CREATED"
required
object

Responses

Request samples

Content type
application/json
{
  • "timestamp": 0,
  • "webhookUuid": "8695c3d8-7b60-49f5-aa5e-6adbdeaf46c8",
  • "objectUuid": "string",
  • "eventType": "PAYMENT_CREATED",
  • "object": {
    }
}

Payment Status Updated Webhook

Authorizations:
webhookEventAuthorization
Request Body schema: application/json
timestamp
required
number
webhookUuid
required
string <uuid>
objectUuid
required
string
eventType
required
string
Value: "PAYMENT_STATUS_UPDATED"
required
object

Responses

Request samples

Content type
application/json
{
  • "timestamp": 0,
  • "webhookUuid": "8695c3d8-7b60-49f5-aa5e-6adbdeaf46c8",
  • "objectUuid": "string",
  • "eventType": "PAYMENT_STATUS_UPDATED",
  • "object": {
    }
}