Fixje Partner Web API (2.0)

Download OpenAPI specification:

Fixje technical support: development@fixje.nl

Fixje Partner Web API - OpenAPI Specification

Version: 1.0

Introduction

The Fixje Partner Web API provides seamless integration for partners to interact with the Fixje platform. This API allows partners to manage orders, retrieve product details, access available shipping methods, and interact with their storefronts efficiently. It is designed for B2B integrations, enabling automated order processing and inventory management.

Authentication

The API uses OAuth 2.0 Client Credentials Flow for authentication. Partners must obtain an access token by providing their clientId and clientSecret to the /api/v1/login endpoint. This token must be included in all subsequent API requests for authorization.

Key Features

  • Order Management: Retrieve, create, and manage orders through /api/v1/orders.
  • Product Listings: Fetch available products with pagination support via /api/v1/products.
  • Shipping Methods: Retrieve the list of available shipping methods for a partner.
  • Storefront Management: Access storefront configurations and categories.

Response Format

  • All responses are available in JSON and XML formats.
  • Standard HTTP status codes are used for error handling (400, 401, 404, 500).

Best Practices

  • Always use HTTPS to ensure secure communication.
  • Implement token expiration handling to refresh authentication as needed.
  • Use pagination parameters (page, pageSize) for large data requests.
  • Handle API errors by checking response codes and ProblemDetails objects.

Login

Generates an access token.

Generates an access token for OAuth2.0 authentication. You can authenticate by sending ClientId and clientSecret in the request body.

Authorizations:
Bearer
Request Body schema: multipart/form-data
grant_type
required
string
client_id
string
client_secret
string

Responses

Response samples

Content type
{
  • "access_token": "string",
  • "token_type": "string",
  • "expires_in": 0
}

Orders

Get all orders for a partner.

List of all orders for a partner

Authorizations:
Bearer
query Parameters
page
integer <int32>
Default: 1

Current page

pagesize
integer <int32>
Default: 100

Amount of orders per page, max 100

Responses

Response samples

Content type
{
  • "statusCode": "string",
  • "totalCount": 0,
  • "data": {
    }
}

Create a new order at a store

Creates an order in the store

Authorizations:
Bearer
Request Body schema:
reference
string or null
customerDeliveryNote
string or null
shippingMethodId
required
string <uuid>
storeFrontId
required
string <uuid>
requestedDeliveryDate
string or null <date>
required
object (OrderCreationShippingAddressRequest)
object (OrderCreationBillingAddressRequest)
required
Array of objects (OrderCreationRequestItem)

Responses

Request samples

Content type
{
  • "reference": "string",
  • "customerDeliveryNote": "string",
  • "shippingMethodId": "ea3a5f49-4f0a-4467-bd32-114aa00d0649",
  • "storeFrontId": "32afc0d8-86d4-4c8e-8a5e-4d885a3811bd",
  • "requestedDeliveryDate": "2019-08-24",
  • "shippingAddress": {
    },
  • "billingAddress": {
    },
  • "orderItems": [
    ]
}

Response samples

Content type
{
  • "orderId": "b3e1eced-f2bd-4d8c-9765-fbc9d1d222d5",
  • "reference": "string",
  • "creationWarnings": [
    ]
}

Get order by id

Authorizations:
Bearer
path Parameters
orderId
required
string <uuid>

The ID of the order to retrieve

Responses

Response samples

Content type
{
  • "orderId": "b3e1eced-f2bd-4d8c-9765-fbc9d1d222d5",
  • "reference": "string",
  • "orderStatus": "string",
  • "shippingMethodId": "ea3a5f49-4f0a-4467-bd32-114aa00d0649",
  • "storeFrontId": "32afc0d8-86d4-4c8e-8a5e-4d885a3811bd",
  • "shippingAddress": {
    },
  • "orderItems": [
    ],
  • "shipments": [
    ],
  • "requestedDeliveryDate": "2019-08-24",
  • "createdAt": "2019-08-24T14:15:22Z"
}

Partners

Get all shipping methods that are available for the partner

Authorizations:
Bearer

Responses

Response samples

Content type
{
  • "statusCode": "string",
  • "totalCount": 0,
  • "data": [
    ]
}

Get all available store fronts that are available for the partner

Authorizations:
Bearer

Responses

Response samples

Content type
{
  • "statusCode": "string",
  • "totalCount": 0,
  • "data": [
    ]
}

Get all categories that are available for the partner

Authorizations:
Bearer

Responses

Response samples

Content type
{
  • "statusCode": "string",
  • "totalCount": 0,
  • "data": [
    ]
}

Products

Get the available products for the partner

Authorizations:
Bearer
query Parameters
page
integer <int32>
Default: 1

The current page

pageSize
integer <int32>
Default: 100

The amount of items per page

Responses

Response samples

Content type
{
  • "sku": "string",
  • "name": "string",
  • "ean": "string",
  • "mpn": "string",
  • "taxClass": "string",
  • "productPrice": {
    },
  • "image": "string",
  • "stocks": [
    ]
}