Download OpenAPI specification:
Version: 1.0
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.
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.
Generates an access token for OAuth2.0 authentication. You can authenticate by sending ClientId and clientSecret in the request body.
| grant_type required | string |
| client_id | string |
| client_secret | string |
{- "access_token": "string",
- "token_type": "string",
- "expires_in": 0
}List of all orders for a partner
| page | integer <int32> Default: 1 Current page |
| pagesize | integer <int32> Default: 100 Amount of orders per page, max 100 |
{- "statusCode": "string",
- "totalCount": 0,
- "data": {
- "orderId": "b3e1eced-f2bd-4d8c-9765-fbc9d1d222d5",
- "reference": "string",
- "orderStatus": "string",
- "shippingMethodId": "ea3a5f49-4f0a-4467-bd32-114aa00d0649",
- "storeFrontId": "32afc0d8-86d4-4c8e-8a5e-4d885a3811bd",
- "shippingAddress": {
- "companyName": "string",
- "firstName": "string",
- "lastName": "string",
- "street": "string",
- "houseNumber": "string",
- "houseNumberExtension": "string",
- "extraAddressInformation": "string",
- "zipCode": "string",
- "city": "string",
- "countryCode": "string"
}, - "orderItems": [
- {
- "orderItemId": "33207bce-c741-4896-a76b-8afcf6e4179a",
- "unitPrice": 0.1,
- "tax": 0.1,
- "totalUnitPrice": 0.1,
- "quantity": 0,
- "quantityShipped": 0,
- "total": 0.1,
- "sku": "string",
- "reference": "string"
}
], - "shipments": [
- {
- "orderShipmentId": "ad4320c2-d37e-4ee4-a067-01771c3dee63",
- "shipmentDate": "2019-08-24T14:15:22Z",
- "trackingNumber": "string",
- "shipmentProvider": "string",
- "orderItems": {
- "property1": 0,
- "property2": 0
}
}
], - "requestedDeliveryDate": "2019-08-24",
- "createdAt": "2019-08-24T14:15:22Z"
}
}Creates an order in the store
| 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) |
{- "reference": "string",
- "customerDeliveryNote": "string",
- "shippingMethodId": "ea3a5f49-4f0a-4467-bd32-114aa00d0649",
- "storeFrontId": "32afc0d8-86d4-4c8e-8a5e-4d885a3811bd",
- "requestedDeliveryDate": "2019-08-24",
- "shippingAddress": {
- "companyName": "string",
- "firstName": "string",
- "lastName": "string",
- "street": "string",
- "houseNumber": "string",
- "houseNumberExtension": "string",
- "extraAddressInformation": "string",
- "zipCode": "string",
- "city": "string",
- "countryCode": "string",
- "shipmentEmailAddress": "user@example.com"
}, - "billingAddress": {
- "companyName": "string",
- "firstName": "string",
- "lastName": "string",
- "street": "string",
- "houseNumber": "string",
- "houseNumberExtension": "string",
- "extraAddressInformation": "string",
- "zipCode": "string",
- "city": "string",
- "countryCode": "string",
- "vatNumber": "string",
- "camberOfCommerce": "string",
- "billingEmailAddress": "string",
- "billingPhoneNumber": "string"
}, - "orderItems": [
- {
- "sku": "string",
- "quantity": 0,
- "price": 0.1,
- "partnerReference": "string",
- "stockId": "a43dc3b0-820c-4762-b37b-45e91f17720c"
}
]
}{- "orderId": "b3e1eced-f2bd-4d8c-9765-fbc9d1d222d5",
- "reference": "string",
- "creationWarnings": [
- "string"
]
}| orderId required | string <uuid> The ID of the order to retrieve |
{- "orderId": "b3e1eced-f2bd-4d8c-9765-fbc9d1d222d5",
- "reference": "string",
- "orderStatus": "string",
- "shippingMethodId": "ea3a5f49-4f0a-4467-bd32-114aa00d0649",
- "storeFrontId": "32afc0d8-86d4-4c8e-8a5e-4d885a3811bd",
- "shippingAddress": {
- "companyName": "string",
- "firstName": "string",
- "lastName": "string",
- "street": "string",
- "houseNumber": "string",
- "houseNumberExtension": "string",
- "extraAddressInformation": "string",
- "zipCode": "string",
- "city": "string",
- "countryCode": "string"
}, - "orderItems": [
- {
- "orderItemId": "33207bce-c741-4896-a76b-8afcf6e4179a",
- "unitPrice": 0.1,
- "tax": 0.1,
- "totalUnitPrice": 0.1,
- "quantity": 0,
- "quantityShipped": 0,
- "total": 0.1,
- "sku": "string",
- "reference": "string"
}
], - "shipments": [
- {
- "orderShipmentId": "ad4320c2-d37e-4ee4-a067-01771c3dee63",
- "shipmentDate": "2019-08-24T14:15:22Z",
- "trackingNumber": "string",
- "shipmentProvider": "string",
- "orderItems": {
- "property1": 0,
- "property2": 0
}
}
], - "requestedDeliveryDate": "2019-08-24",
- "createdAt": "2019-08-24T14:15:22Z"
}| page | integer <int32> Default: 1 The current page |
| pageSize | integer <int32> Default: 100 The amount of items per page |
{- "sku": "string",
- "name": "string",
- "ean": "string",
- "mpn": "string",
- "taxClass": "string",
- "productPrice": {
- "price": 0.1,
- "suggestedRetailPrice": 0.1,
- "oemPrice": 0.1,
- "defaultRetailPrice": 0.1
}, - "image": "string",
- "stocks": [
- {
- "stockId": "a43dc3b0-820c-4762-b37b-45e91f17720c",
- "name": "string",
- "quantity": 0,
- "additionalCost": 0.1
}
]
}