NuboWMS API (v1)

Download OpenAPI specification:Download

Introduction

NuboWMS API enables you to create and manage:

For products, contractors, external releases and delivery notes there is also a possibility of batch import (multiple objects at once).

Authentication

NuboWMS API uses OAuth2 protocol for securing resources. To use the API you have obtain JWT access token. For more information please refer to the guide How to obtain NuboWMS API access token.

Obtained access token can be used in Authorization header using the Bearer scheme. Example value of Authorization header: Bearer COPY_ACCESS_TOKEN_HERE

Rate limitting

NuboWMS API is rate limited. Standard limit is 100 req/min but limit may vary. After exceeding the limit, the response status is 429.

For more information please contact our support team.

Additional remarks

  • Codes that indetify delivery notes and external releases (but also possibly products and contractors) often contains / char. For endpoints that accepts such codes as a route parameter you have to URI escape the code.
  • For GET endpoints (returnig multiple objects) please note that the result is paginated.

AdHocDeliveryNotes

Get ad hoc delivery notes

Returns ad hoc delivery notes (created without external system notice; by warehouse workers). Result is paginated.

Authorizations:
bearer
query Parameters
acceptedDateFrom
string <date-time>
Example: acceptedDateFrom=2025-01-01T00:00:00Z

Filters delivery notes accepted after the specified date. If null, the filter is ignored.

acceptedDateTo
string <date-time>
Example: acceptedDateTo=2025-01-01T00:00:00Z

Filters delivery notes accepted before the specified date. If null, the filter is ignored.

createdDateFrom
string <date-time>
Example: createdDateFrom=2025-01-01T00:00:00Z

Filters delivery notes created after the specified date. If null, the filter is ignored.

createdDateTo
string <date-time>
Example: createdDateTo=2025-01-01T00:00:00Z

Filters delivery notes created before the specified date. If null, the filter is ignored.

lastModifiedDateFrom
string <date-time>
Example: lastModifiedDateFrom=2025-01-01T00:00:00Z

Filters delivery notes modified after the specified date. If null, the filter is ignored.

lastModifiedDateTo
string <date-time>
Example: lastModifiedDateTo=2025-01-01T00:00:00Z

Filters delivery notes modified before the specified date. If null, the filter is ignored.

limit
integer <int32>
Example: limit=10

Limits number of results returned in a repsponse. Example: there are 250 products and you want to fetch first 15 of them, then you should pass limit=15.

Max. value is 1000.

Default value is 10.

offset
integer <int32>
Example: offset=0

Offsets results by specified number. Example: there are 250 products and you want to fetch last 50 of them, then you should pass offset=200.

Default value is 0.

showOnlyWithoutExternalCode
boolean
Example: showOnlyWithoutExternalCode=false

When set to true, returns only delivery notes that don't have an external code assigned. These are typically delivery notes created through NuboWMS Panel app. If null, the filter is ignored.

statuses
Array of strings
Items Enum: "NEW" "TO_ACCEPT" "IN_ACCEPTANCE" "ACCEPTED" "CANCELED" "ACCEPT_OPERATION_IN_PROGRESS" "ACCEPTED_WITH_SHORTAGES"

Filters delivery notes with specified statuses. Comma separated string. If null, the filter is ignored.

warehouseCode
string
Example: warehouseCode=MAG_KRAKOW

Warehouse code. If null, the default warehouse will be used.

Responses

Request samples

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://api-test.nubowms.pl/api/v1/ad-hoc-delivery-notes?acceptedDateFrom=2025-01-01T00%3A00%3A00Z&acceptedDateTo=2025-01-01T00%3A00%3A00Z&createdDateFrom=2025-01-01T00%3A00%3A00Z&createdDateTo=2025-01-01T00%3A00%3A00Z&lastModifiedDateFrom=2025-01-01T00%3A00%3A00Z&lastModifiedDateTo=2025-01-01T00%3A00%3A00Z&limit=10&offset=0&showOnlyWithoutExternalCode=false&statuses=SOME_ARRAY_VALUE&warehouseCode=SOME_STRING_VALUE"),
    Headers =
    {
        { "Authorization", "Bearer REPLACE_BEARER_TOKEN" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

Response samples

Content type
application/json
{
  • "count": 0,
  • "items": [
    ],
  • "totalCount": 0
}

Get ad hoc delivery note by id

Returns ad hoc delivery note or 404 Not Found when delivery note with given id does not exist.

Authorizations:
bearer
path Parameters
deliveryNoteId
required
string <uuid>
Example: d8f1fbde-bfae-4db7-9fd4-a9c49ae5a685

Id that identifies delivery note in NuboWMS

Responses

Request samples

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://api-test.nubowms.pl/api/v1/ad-hoc-delivery-notes/d8f1fbde-bfae-4db7-9fd4-a9c49ae5a685"),
    Headers =
    {
        { "Authorization", "Bearer REPLACE_BEARER_TOKEN" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

Response samples

Content type
application/json
{
  • "acceptedAt": "2023-08-26",
  • "contractor": {
    },
  • "createdAt": "2023-08-25",
  • "deliveryMethod": "DHL",
  • "deliveryNoteId": "8dd34746-617a-41a7-9a47-965045d3a392",
  • "externalCode": "PZ/2023/01/00003",
  • "id": "38dd7a78-3af7-41fc-9477-b019bf84936d",
  • "lastModifiedAt": "2019-08-24",
  • "numberDisplay": "PZ/2023/06/000062",
  • "plannedDeliveryDate": "2023-08-24",
  • "priority": "Normal",
  • "remarks": "Ostro+-nie z palet�� z czarnym stretchem",
  • "status": "IN_ACCEPTANCE",
  • "totalAcceptedQuantity": 9.5,
  • "totalQuantityToAccept": 20,
  • "type": "EXTERNAL",
  • "waybill": "523000013764117057518412"
}

Get ad hoc delivery note's items

Return a complete list of items of the delivery note.

Authorizations:
bearer
path Parameters
deliveryNoteId
required
string <uuid>
Example: d8f1fbde-bfae-4db7-9fd4-a9c49ae5a685

Id that identifies delivery note in NuboWMS

Responses

Request samples

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://api-test.nubowms.pl/api/v1/ad-hoc-delivery-notes/d8f1fbde-bfae-4db7-9fd4-a9c49ae5a685/items"),
    Headers =
    {
        { "Authorization", "Bearer REPLACE_BEARER_TOKEN" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

Response samples

Content type
application/json
[
  • {
    }
]

Get accepted resources for specific delivery note

Return a list resources (product, traits, quantity) accepted as a result of completing ad hoc delivery note.

Authorizations:
bearer
path Parameters
deliveryNoteId
required
string <uuid>
Example: d8f1fbde-bfae-4db7-9fd4-a9c49ae5a685

Id that identifies delivery note in NuboWMS

Responses

Request samples

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://api-test.nubowms.pl/api/v1/ad-hoc-delivery-notes/d8f1fbde-bfae-4db7-9fd4-a9c49ae5a685/accepted-resources"),
    Headers =
    {
        { "Authorization", "Bearer REPLACE_BEARER_TOKEN" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

Response samples

Content type
application/json
[
  • {
    }
]

Get ad hoc delivery note's status

Authorizations:
bearer
path Parameters
deliveryNoteId
required
string <uuid>
Example: d8f1fbde-bfae-4db7-9fd4-a9c49ae5a685

Id that identifies delivery note in NuboWMS

Responses

Request samples

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://api-test.nubowms.pl/api/v1/ad-hoc-delivery-notes/d8f1fbde-bfae-4db7-9fd4-a9c49ae5a685/status"),
    Headers =
    {
        { "Authorization", "Bearer REPLACE_BEARER_TOKEN" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

Response samples

Content type
application/json
{
  • "deliveryNoteStatus": "NEW"
}

Change delivery note's external code

Please note that once external code is assigned to a delivery note, it will no longer appear in the list of ad hoc delivery notes (GET all endpoint).

Authorizations:
bearer
path Parameters
deliveryNoteId
required
string <uuid>
Example: d8f1fbde-bfae-4db7-9fd4-a9c49ae5a685

Id that identifies delivery note in NuboWMS

Request Body schema:

New external code.

newExternalCode
required
string

Responses

Request samples

Content type
{
  • "newExternalCode": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "errors": [
    ],
  • "relatedData": [
    ]
}

AdHocExternalReleases

Get ad hoc external releases

Returns ad hoc external releases (created without external system notice; by warehouse workers). Result is paginated.

Authorizations:
bearer
query Parameters
createdDateFrom
string <date-time>
Example: createdDateFrom=2025-01-01T00:00:00Z

Filters external releases created after the specified date. If null, the filter is ignored.

createdDateTo
string <date-time>
Example: createdDateTo=2025-01-01T00:00:00Z

Filters external releases created before the specified date. If null, the filter is ignored.

issueDateFrom
string <date-time>
Example: issueDateFrom=2025-01-01T00:00:00Z

Filters external releases accepted after the specified date. If null, the filter is ignored.

issueDateTo
string <date-time>
Example: issueDateTo=2025-01-01T00:00:00Z

Filters external releases accepted before the specified date. If null, the filter is ignored.

lastModifiedDateFrom
string <date-time>
Example: lastModifiedDateFrom=2025-01-01T00:00:00Z

Filters external releases modified after the specified date. If null, the filter is ignored.

lastModifiedDateTo
string <date-time>
Example: lastModifiedDateTo=2025-01-01T00:00:00Z

Filters external releases modified before the specified date. If null, the filter is ignored.

limit
integer <int32>
Example: limit=10

Limits number of results returned in a repsponse. Example: there are 250 products and you want to fetch first 15 of them, then you should pass limit=15.

Max. value is 1000.

Default value is 10.

offset
integer <int32>
Example: offset=0

Offsets results by specified number. Example: there are 250 products and you want to fetch last 50 of them, then you should pass offset=200.

Default value is 0.

showOnlyWithoutExternalCode
boolean
Example: showOnlyWithoutExternalCode=false

When set to true, returns only external releases that don't have an external code assigned. These are typically releases created through NuboWMS Panel app. If null, the filter is ignored.

statuses
Array of strings
Items Enum: "Created" "PickedToRealization" "PickingInProgress" "ReadyForReplenishment" "ReplenishmentInProgress" "ReadyForPacking" "PackingInProgress" "ReadyForLoading" "LoadingInProgress" "Completed" "CompletedWithShortages" "Cancelled" "PassingToPicking" "PickedWithShortages" "WaitingForPackingWithShortages"

Filters external releases with specified statuses. Comma separated string. If null, the filter is ignored.

warehouseCode
string
Example: warehouseCode=MAG_KRAKOW

Warehouse code. If null, the default warehouse will be used.

Responses

Request samples

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://api-test.nubowms.pl/api/v1/ad-hoc-external-releases?createdDateFrom=2025-01-01T00%3A00%3A00Z&createdDateTo=2025-01-01T00%3A00%3A00Z&issueDateFrom=2025-01-01T00%3A00%3A00Z&issueDateTo=2025-01-01T00%3A00%3A00Z&lastModifiedDateFrom=2025-01-01T00%3A00%3A00Z&lastModifiedDateTo=2025-01-01T00%3A00%3A00Z&limit=10&offset=0&showOnlyWithoutExternalCode=false&statuses=SOME_ARRAY_VALUE&warehouseCode=SOME_STRING_VALUE"),
    Headers =
    {
        { "Authorization", "Bearer REPLACE_BEARER_TOKEN" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

Response samples

Content type
application/json
{
  • "count": 0,
  • "items": [
    ],
  • "totalCount": 0
}

Get ad hoc external release by id

Return ad hoc external release or 404 Not Found when external release with given id does not exist.

Authorizations:
bearer
path Parameters
externalReleaseId
required
string <uuid>
Example: 9339cd2a-5458-4d7f-a193-c6ba2f055424

Id that identifies an ad hoc external release in NuboWMS

Responses

Request samples

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://api-test.nubowms.pl/api/v1/ad-hoc-external-releases/9339cd2a-5458-4d7f-a193-c6ba2f055424"),
    Headers =
    {
        { "Authorization", "Bearer REPLACE_BEARER_TOKEN" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

Response samples

Content type
application/json
{
  • "contractorCode": "KNT_CODE",
  • "contractorName": "Example contractor name",
  • "contractorTin": "7620850038",
  • "createdAt": "2019-08-24",
  • "deliveryAddressApartmentNumber": "7",
  • "deliveryAddressCity": "Warszawa",
  • "deliveryAddressCountryCode": "PL",
  • "deliveryAddressHouseNumber": "17C",
  • "deliveryAddressStreet": "Wrzosowa",
  • "deliveryAddressZipCode": "33-333",
  • "externalCode": "RO/124/2023",
  • "externalReleaseId": "08efa844-4e81-41a2-b9d1-f80fc664f9c9",
  • "id": "17ab60b6-d9af-4c0b-b109-8881e2357306",
  • "issueDate": "2019-08-24",
  • "lastModifiedAt": "2019-08-24",
  • "numberDisplay": "RO/124/2023",
  • "priority": "Normal",
  • "remarks": "Dodajcie gratis",
  • "shipmentDate": "2023-08-24",
  • "shipmentMethodCode": "Inpost",
  • "status": "PickingInProgress",
  • "type": "EXTERNAL_RELEASE",
  • "waybills": [
    ]
}

Get ad hoc external release's items

Return a complete list of items from the external release.

Authorizations:
bearer
path Parameters
externalReleaseId
required
string <uuid>
Example: 9339cd2a-5458-4d7f-a193-c6ba2f055424

Id that identifies an ad hoc external release in NuboWMS

Responses

Request samples

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://api-test.nubowms.pl/api/v1/ad-hoc-external-releases/9339cd2a-5458-4d7f-a193-c6ba2f055424/items"),
    Headers =
    {
        { "Authorization", "Bearer REPLACE_BEARER_TOKEN" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

Response samples

Content type
application/json
[
  • {
    }
]

Get released resources for specific external release

Return a list resources (product, traits, quantity) released as a result of completing ad hoc external release.

Authorizations:
bearer
path Parameters
externalReleaseId
required
string <uuid>
Example: 9339cd2a-5458-4d7f-a193-c6ba2f055424

Id that identifies an ad hoc external release in NuboWMS

Responses

Request samples

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://api-test.nubowms.pl/api/v1/ad-hoc-external-releases/9339cd2a-5458-4d7f-a193-c6ba2f055424/released-resources"),
    Headers =
    {
        { "Authorization", "Bearer REPLACE_BEARER_TOKEN" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

Response samples

Content type
application/json
[
  • {
    }
]

Get ad hoc external release's status

Authorizations:
bearer
path Parameters
externalReleaseId
required
string <uuid>
Example: 9339cd2a-5458-4d7f-a193-c6ba2f055424

Id that identifies an ad hoc external release in NuboWMS

Responses

Request samples

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://api-test.nubowms.pl/api/v1/ad-hoc-external-releases/9339cd2a-5458-4d7f-a193-c6ba2f055424/status"),
    Headers =
    {
        { "Authorization", "Bearer REPLACE_BEARER_TOKEN" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

Response samples

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

Change external release's external code

Please note that once external code is assigned to an external release, it will no longer appear in the list of ad hoc releases (GET all endpoint).

Authorizations:
bearer
path Parameters
externalReleaseId
required
string <uuid>
Example: 9339cd2a-5458-4d7f-a193-c6ba2f055424

Id that identifies an ad hoc external release in NuboWMS

Request Body schema:

New external code.

newExternalCode
required
string

Responses

Request samples

Content type
{
  • "newExternalCode": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "errors": [
    ],
  • "relatedData": [
    ]
}

Auth

Refresh token

Refresh tokens are valid for 2 months.
To obtain first refresh token please refer to auth section of user's guide.
Endpoint returns accessToken (valid for 12 hours) and new refresh token that is valid for another 2 months.
Refresh token can be used only to issue new pairs of tokens (access + refresh). For all other 'standard' request use accessToken.

Please note that this endpoint is rate limited. Each remote ip address is allowed for maximum of 30 requests per minute.

Request Body schema:
refreshToken
required
string

Refresh token (valid for 2 months).

Responses

Request samples

Content type
{
  • "refreshToken": "string"
}

Response samples

Content type
No sample

ContractorImports

Creates contractors import

Creates batch job that import multiple contractors at once.

Note that execution of imports is asynchronous. After receiving response with 202 Accepted HTTP status code contractors may not be yet present in the system. You have to poll report endpoint by using response Location header value and check import status. When it is DONE_OK contractor was successfuly imported.

Import ignores all errors. For example when importing 5 contractors (and 2 of them already exists in NuboWMS) only 3 contractors will be imported.

Authorizations:
bearer
Request Body schema:

Contractors to import

required
Array of objects

Responses

Request samples

Content type
{
  • "contractorsImports": [
    ]
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "errors": [
    ],
  • "relatedData": [
    ]
}

Gets contractors import report

Returns information about import progress. Each imported contractor will be represented as separate object in the returned array.

Authorizations:
bearer
path Parameters
importId
required
string <uuid>

Import id - can be available from value of Location header in Creates contractors import response.

Responses

Request samples

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://api-test.nubowms.pl/api/v1/contractor-imports/%7BimportId%7D/report"),
    Headers =
    {
        { "Authorization", "Bearer REPLACE_BEARER_TOKEN" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

Response samples

Content type
application/json
[
  • {
    }
]

Contractors

Get contractors

Returns contractors. Result is paginated.

Authorizations:
bearer
query Parameters
lastModifiedDateFrom
string <date-time>
Example: lastModifiedDateFrom=2025-01-01T00:00:00Z

Filters contractors modified after the specified date. If null, the filter is ignored.

limit
integer <int32>
Example: limit=10

Limits number of results returned in a repsponse. Example: there are 250 products and you want to fetch first 15 of them, then you should pass limit=15.

Max. value is 1000.

Default value is 10.

offset
integer <int32>
Example: offset=0

Offsets results by specified number. Example: there are 250 products and you want to fetch last 50 of them, then you should pass offset=200.

Default value is 0.

searchText
string
Example: searchText=knt

Shows only contractors that includes search text phrase in code or name or tin.

statuses
Array of strings
Items Enum: "InActive" "Active" "Archived"

Show contractors with specified statuses. If null or empty then the filter is ignored. Comma separated string. Example query ?statuses=Active,Archived

types
Array of strings
Items Enum: "PERSON" "COMPANY"

Show contractors with specified types. If null or empty then the filter is ignored. Comma separated string. Example query ?statuses=PERSON,COMPANY

Responses

Request samples

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://api-test.nubowms.pl/api/v1/contractors?lastModifiedDateFrom=2025-01-01T00%3A00%3A00Z&limit=10&offset=0&searchText=knt&statuses=SOME_ARRAY_VALUE&types=SOME_ARRAY_VALUE"),
    Headers =
    {
        { "Authorization", "Bearer REPLACE_BEARER_TOKEN" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

Response samples

Content type
application/json
{
  • "count": 0,
  • "items": [
    ],
  • "totalCount": 0
}

Create contractor

Authorizations:
bearer
Request Body schema:
active
required
boolean

Flag indicating if contractor is active

Array of objects or null

Additional addresses

code
required
string

Contractor code

required
object

Headquarter address

name
required
string

Contractor name

priority
required
string
Enum: "Normal" "AboveNormal" "High" "Low" "BelowNormal"

Contractor priority. Priority can affect order of external releases fulfillment

regon
string or null

Contractor regon

remarks
string or null

Remarks about contractor

tin
string or null

Contractor TIN (Taxpayer Identification Number)

type
required
string
Enum: "PERSON" "COMPANY"

Contractor name

Responses

Request samples

Content type
{
  • "active": true,
  • "addresses": [
    ],
  • "code": "KNT_CODE",
  • "headquarterAddress": {
    },
  • "name": "Example contractor name",
  • "priority": "Normal",
  • "regon": "570984220",
  • "remarks": "rabat 5% na wszystko",
  • "tin": "7620850038",
  • "type": "COMPANY"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "errors": [
    ],
  • "relatedData": [
    ]
}

Get contractor by code

Returns contractor by code or 404 Not Found when contractor with given code does not exist.

Authorizations:
bearer
path Parameters
contractorCode
required
string
Example: knt_code

Contractor code. (ensure code is URI escaped)

Responses

Request samples

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://api-test.nubowms.pl/api/v1/contractors/knt_code"),
    Headers =
    {
        { "Authorization", "Bearer REPLACE_BEARER_TOKEN" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

Response samples

Content type
application/json
{
  • "active": true,
  • "addresses": [
    ],
  • "code": "KNT_CODE",
  • "headquarterAddress": {
    },
  • "name": "Example contractor name",
  • "priority": "Normal",
  • "regon": "570984220",
  • "remarks": "rabat 5% na wszystko",
  • "status": "ACTIVE",
  • "tin": "7620850038",
  • "type": "COMPANY"
}

Delete contractor

Authorizations:
bearer
path Parameters
contractorCode
required
string
Example: knt_code

Contractor code. (ensure code is URI escaped)

Responses

Request samples

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Delete,
    RequestUri = new Uri("https://api-test.nubowms.pl/api/v1/contractors/knt_code"),
    Headers =
    {
        { "Authorization", "Bearer REPLACE_BEARER_TOKEN" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "errors": [
    ],
  • "relatedData": [
    ]
}

Edit contractor

Authorizations:
bearer
path Parameters
contractorCode
required
string
Example: knt_code

Contractor code. (ensure code is URI escaped)

Request Body schema:

Contractor data (existing state will be overwritten)

active
required
boolean

Flag indicating if contractor is active

Array of objects or null

Additional addresses

required
object

Headquarter address

name
required
string

Contractor name

priority
required
string
Enum: "Normal" "AboveNormal" "High" "Low" "BelowNormal"

Contractor priority. Priority can affect order of external releases fulfillment

regon
required
string

Contractor regon

remarks
string or null

Remarks about contractor

tin
string or null

Contractor TIN (Taxpayer Identification Number)

type
required
string
Enum: "PERSON" "COMPANY"

Contractor name

Responses

Request samples

Content type
{
  • "active": true,
  • "addresses": [
    ],
  • "headquarterAddress": {
    },
  • "name": "Example contractor name",
  • "priority": "Normal",
  • "regon": "570984220",
  • "remarks": "rabat 5% na wszystko",
  • "tin": "7620850038",
  • "type": "COMPANY"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "errors": [
    ],
  • "relatedData": [
    ]
}

Get contractor's addresses

Returns contractor's addresses. Result is paginated.

Authorizations:
bearer
path Parameters
contractorCode
required
string
Example: knt_code

Contractor code (ensure code is URI escaped)

query Parameters
limit
integer <int32>
Example: limit=10

Limits number of results returned in a repsponse. Example: there are 250 products and you want to fetch first 15 of them, then you should pass limit=15.

Max. value is 1000.

Default value is 10.

offset
integer <int32>
Example: offset=0

Offsets results by specified number. Example: there are 250 products and you want to fetch last 50 of them, then you should pass offset=200.

Default value is 0.

Responses

Request samples

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://api-test.nubowms.pl/api/v1/contractors/knt_code/addresses?limit=10&offset=0"),
    Headers =
    {
        { "Authorization", "Bearer REPLACE_BEARER_TOKEN" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

Response samples

Content type
application/json
{
  • "count": 0,
  • "items": [
    ],
  • "totalCount": 0
}

Create contractor address

Authorizations:
bearer
path Parameters
contractorCode
required
string
Example: knt_code

Contractor code (ensure code is URI escaped)

Request Body schema:

Address data (existsing address state will be overwritten)

addressCode
required
string <= 150 characters

Address code

addressName
required
string <= 150 characters

Address name

apartmentNumber
string or null <= 25 characters

Apartment number

city
required
string <= 150 characters

City

contactPerson
string or null <= 150 characters

Contact person

countryCode
required
string <= 2 characters

Country code (ISO 3166 alpha-2)

See Wikipedia ISO 3166 alpha-2

countryName
string or null

Country name

emailAddress
string or null <= 150 characters

Email address

houseNumber
required
string <= 25 characters

House number (or building number)

isDefaultShippingAddress
required
boolean

Is default shipping address

mainPhoneNumber
string or null <= 25 characters

Main phone number

secondaryPhoneNumber
string or null <= 25 characters

Secondary phone number

street
required
string <= 150 characters

Street

zipCode
required
string <= 25 characters

Zip code

Responses

Request samples

Content type
{
  • "addressCode": "KNT_ADDR_CODE",
  • "addressName": "KNT address descriptive name",
  • "apartmentNumber": "7",
  • "city": "Warszawa",
  • "contactPerson": "Pan Janek tel. 333 999 999",
  • "countryCode": "PL",
  • "countryName": "Poland",
  • "emailAddress": "example@example.com",
  • "houseNumber": "17C",
  • "isDefaultShippingAddress": true,
  • "mainPhoneNumber": "222555666",
  • "secondaryPhoneNumber": "333444777",
  • "street": "Wrzosowa",
  • "zipCode": "33-333"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "errors": [
    ],
  • "relatedData": [
    ]
}

Delete contractor's address

Authorizations:
bearer
path Parameters
addressCode
required
string
Example: knt_addr_code

Code of address to delete (ensure code is URI escaped)

contractorCode
required
string
Example: knt_code

Contractor code (ensure code is URI escaped)

Responses

Request samples

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Delete,
    RequestUri = new Uri("https://api-test.nubowms.pl/api/v1/contractors/knt_code/addresses/knt_addr_code"),
    Headers =
    {
        { "Authorization", "Bearer REPLACE_BEARER_TOKEN" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "errors": [
    ],
  • "relatedData": [
    ]
}

Edit contractor's address

Authorizations:
bearer
path Parameters
addressCode
required
string
Example: knt_addr_code

Code of address to delete (ensure code is URI escaped)

contractorCode
required
string
Example: knt_code

Contractor code (ensure code is URI escaped)

Request Body schema:

Address new values

addressCode
required
string <= 150 characters

Address code

addressName
required
string <= 150 characters

Address name

apartmentNumber
required
string <= 25 characters

Apartment number

city
required
string <= 150 characters

City

contactPerson
string or null <= 150 characters

Contact person

countryCode
required
string <= 2 characters

Country code (ISO 3166 alpha-2)

See Wikipedia ISO 3166 alpha-2

emailAddress
string or null <= 150 characters

Email address

houseNumber
required
string <= 25 characters

House number (or building number)

isDefaultShippingAddress
required
boolean

Is default shipping address

mainPhoneNumber
string or null <= 25 characters

Main phone number

secondaryPhoneNumber
string or null <= 25 characters

Secondary phone number

street
required
string <= 150 characters

Street

zipCode
required
string <= 25 characters

Zip code

Responses

Request samples

Content type
{
  • "addressCode": "KNT_ADDR_CODE",
  • "addressName": "KNT address descriptive name",
  • "apartmentNumber": "7",
  • "city": "Warszawa",
  • "contactPerson": "Pan Janek tel. 333 999 999",
  • "countryCode": "PL",
  • "emailAddress": "example@example.com",
  • "houseNumber": "17C",
  • "isDefaultShippingAddress": true,
  • "mainPhoneNumber": "222555666",
  • "secondaryPhoneNumber": "333444777",
  • "street": "Wrzosowa",
  • "zipCode": "33-333"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "errors": [
    ],
  • "relatedData": [
    ]
}

DeliveryNoteImports

Creates delivery notes import

Creates batch job that import multiple delivery notes at once.

Note that execution of imports is asynchronous. After receiving response with 202 Accepted HTTP status code delivery notes may not be yet present in the system. You have to poll report endpoint by using response Location header value and check import status. When it is DONE_OK delivery note was successfuly imported.

Import ignores all errors. For example when importing 5 delivery notes (and 2 of them have import errors) only 3 delivery notes will be imported.

Authorizations:
bearer
Request Body schema:

Delivery notes to import

required
Array of objects

Responses

Request samples

Content type
{
  • "deliveryNotes": [
    ]
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "errors": [
    ],
  • "relatedData": [
    ]
}

Gets delivery notes import report

Returns information about import progress. Each imported delivery note will be represented as separate object in the returned array.

Authorizations:
bearer
path Parameters
importId
required
string <uuid>

Import id - can be available from value of Location header in Creates delivery notes import response.

Responses

Request samples

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://api-test.nubowms.pl/api/v1/delivery-note-imports/%7BimportId%7D/report"),
    Headers =
    {
        { "Authorization", "Bearer REPLACE_BEARER_TOKEN" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

Response samples

Content type
application/json
[
  • {
    }
]

DeliveryNotes

Get delivery notes

Returns delivery notes. Result is paginated.

Authorizations:
bearer
query Parameters
acceptedDateFrom
string <date-time>
Example: acceptedDateFrom=2025-01-01T00:00:00Z

Filters delivery notes accepted after the specified date. If null, the filter is ignored.

acceptedDateTo
string <date-time>
Example: acceptedDateTo=2025-01-01T00:00:00Z

Filters delivery notes accepted before the specified date. If null, the filter is ignored.

createdDateFrom
string <date-time>
Example: createdDateFrom=2025-01-01T00:00:00Z

Filters delivery notes created after the specified date. If null, the filter is ignored.

createdDateTo
string <date-time>
Example: createdDateTo=2025-01-01T00:00:00Z

Filters delivery notes created before the specified date. If null, the filter is ignored.

lastModifiedDateFrom
string <date-time>
Example: lastModifiedDateFrom=2025-01-01T00:00:00Z

Filters delivery notes modified after the specified date. If null, the filter is ignored.

lastModifiedDateTo
string <date-time>
Example: lastModifiedDateTo=2025-01-01T00:00:00Z

Filters delivery notes modified before the specified date. If null, the filter is ignored.

limit
integer <int32>
Example: limit=10

Limits number of results returned in a repsponse. Example: there are 250 products and you want to fetch first 15 of them, then you should pass limit=15.

Max. value is 1000.

Default value is 10.

offset
integer <int32>
Example: offset=0

Offsets results by specified number. Example: there are 250 products and you want to fetch last 50 of them, then you should pass offset=200.

Default value is 0.

showOnlyWithoutExternalCode
boolean
Example: showOnlyWithoutExternalCode=false

When set to true, returns only delivery notes that don't have an external code assigned. These are typically delivery notes created through NuboWMS Panel app. If null, the filter is ignored.

statuses
Array of strings
Items Enum: "NEW" "TO_ACCEPT" "IN_ACCEPTANCE" "ACCEPTED" "CANCELED" "ACCEPT_OPERATION_IN_PROGRESS" "ACCEPTED_WITH_SHORTAGES"

Filters delivery notes with specified statuses. Comma separated string. If null, the filter is ignored.

warehouseCode
string
Example: warehouseCode=MAG_KRAKOW

Warehouse code. If null, the default warehouse will be used.

Responses

Request samples

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://api-test.nubowms.pl/api/v1/delivery-notes?acceptedDateFrom=2025-01-01T00%3A00%3A00Z&acceptedDateTo=2025-01-01T00%3A00%3A00Z&createdDateFrom=2025-01-01T00%3A00%3A00Z&createdDateTo=2025-01-01T00%3A00%3A00Z&lastModifiedDateFrom=2025-01-01T00%3A00%3A00Z&lastModifiedDateTo=2025-01-01T00%3A00%3A00Z&limit=10&offset=0&showOnlyWithoutExternalCode=false&statuses=SOME_ARRAY_VALUE&warehouseCode=SOME_STRING_VALUE"),
    Headers =
    {
        { "Authorization", "Bearer REPLACE_BEARER_TOKEN" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

Response samples

Content type
application/json
{
  • "count": 0,
  • "items": [
    ],
  • "totalCount": 0
}

Create delivery note

Authorizations:
bearer
query Parameters
warehouseCode
string
Example: warehouseCode=MAG_KRAKOW

Warehouse code. If null, the default warehouse will be used.

Request Body schema:
contractorCode
required
string

Contractor code

deliveryMethod
required
string

Delivery method, ex. name of spedition company / logistic operator

externalCode
required
string

Delivery note's external code (document code from your system)

required
Array of objects
plannedDeliveryDate
required
string <date>

Planned delivery date

priority
required
string
Enum: "Normal" "AboveNormal" "High" "Low" "BelowNormal"

Delivery note priority

remarks
string or null

Delivery note remarks

type
required
string
Enum: "INTERNAL" "EXTERNAL" "RETURN" "TRANSFER"

Delivery note type

waybill
required
string

Waybill number (for example Inpost shipment/tracking number)

Responses

Request samples

Content type
{
  • "contractorCode": "KNT_CODE",
  • "deliveryMethod": "DHL",
  • "externalCode": "PZ/2023/01/00003",
  • "items": [
    ],
  • "plannedDeliveryDate": "2023-08-24",
  • "priority": "Normal",
  • "remarks": "Ostro+-nie z palet�� z czarnym stretchem",
  • "type": "EXTERNAL",
  • "waybill": "523000013764117057518412"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "errors": [
    ],
  • "relatedData": [
    ]
}

Get delivery note by NuboWMS internal id

Return delivery note by internal id or 404 Not Found when delivery note with given id does not exist.

Authorizations:
bearer
path Parameters
nuboId
required
string <uuid>
Example: 38dd7a78-3af7-41fc-9477-b019bf84936d

Internal id of delivery note in NuboWMS

Responses

Request samples

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://api-test.nubowms.pl/api/v1/delivery-notes/38dd7a78-3af7-41fc-9477-b019bf84936d"),
    Headers =
    {
        { "Authorization", "Bearer REPLACE_BEARER_TOKEN" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

Response samples

Content type
application/json
{
  • "acceptedAt": "2023-08-26",
  • "contractor": {
    },
  • "createdAt": "2023-08-25",
  • "deliveryMethod": "DHL",
  • "externalCode": "PZ/2023/01/00003",
  • "id": "38dd7a78-3af7-41fc-9477-b019bf84936d",
  • "lastModifiedAt": "2019-08-24",
  • "numberDisplay": "PZ/2023/06/000062",
  • "plannedDeliveryDate": "2023-08-24",
  • "priority": "Normal",
  • "remarks": "Ostro+-nie z palet�� z czarnym stretchem",
  • "status": "IN_ACCEPTANCE",
  • "totalAcceptedQuantity": 9.5,
  • "totalQuantityToAccept": 20,
  • "type": "EXTERNAL",
  • "waybill": "523000013764117057518412"
}

Get delivery note by external code

Return delivery note by external code or 404 Not Found when delivery note with given code does not exist.

Authorizations:
bearer
path Parameters
externalCode
required
string
Example: PZ%2F2023%2F01%2F00003

External code that identifies delivery note in NuboWMS (ensure code is URI escaped)

Responses

Request samples

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://api-test.nubowms.pl/api/v1/delivery-notes/PZ%2F2023%2F01%2F00003"),
    Headers =
    {
        { "Authorization", "Bearer REPLACE_BEARER_TOKEN" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

Response samples

Content type
application/json
{
  • "acceptedAt": "2023-08-26",
  • "contractor": {
    },
  • "createdAt": "2023-08-25",
  • "deliveryMethod": "DHL",
  • "externalCode": "PZ/2023/01/00003",
  • "id": "38dd7a78-3af7-41fc-9477-b019bf84936d",
  • "lastModifiedAt": "2019-08-24",
  • "numberDisplay": "PZ/2023/06/000062",
  • "plannedDeliveryDate": "2023-08-24",
  • "priority": "Normal",
  • "remarks": "Ostro+-nie z palet�� z czarnym stretchem",
  • "status": "IN_ACCEPTANCE",
  • "totalAcceptedQuantity": 9.5,
  • "totalQuantityToAccept": 20,
  • "type": "EXTERNAL",
  • "waybill": "523000013764117057518412"
}

Edit delivery note

Authorizations:
bearer
path Parameters
externalCode
required
string
Example: PZ%2F2023%2F01%2F00003

External code that identifies delivery note in NuboWMS

Request Body schema:

Delivery note (current state will be overwritten)

contractorCode
required
string

Contractor code

deliveryMethod
required
string

Delivery method, ex. name of spedition company / logistic operator

required
Array of objects
plannedDeliveryDate
required
string <date>

Planned delivery date

priority
required
string
Enum: "Normal" "AboveNormal" "High" "Low" "BelowNormal"

Delivery note priority

remarks
string or null

Delivery note remarks

type
required
string
Enum: "INTERNAL" "EXTERNAL" "RETURN" "TRANSFER"

Delivery note type

waybill
required
string

Waybill number (for example Inpost shipment/tracking number)

Responses

Request samples

Content type
{
  • "contractorCode": "KNT_CODE",
  • "deliveryMethod": "DHL",
  • "items": [
    ],
  • "plannedDeliveryDate": "2023-08-24",
  • "priority": "Normal",
  • "remarks": "Ostro+-nie z palet�� z czarnym stretchem",
  • "type": "EXTERNAL",
  • "waybill": "523000013764117057518412"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "errors": [
    ],
  • "relatedData": [
    ]
}

Delete delivery note

Authorizations:
bearer
path Parameters
externalCode
required
string
Example: PZ%2F2023%2F01%2F00003

External code that identifies delivery note in NuboWMS

Responses

Request samples

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Delete,
    RequestUri = new Uri("https://api-test.nubowms.pl/api/v1/delivery-notes/PZ%2F2023%2F01%2F00003"),
    Headers =
    {
        { "Authorization", "Bearer REPLACE_BEARER_TOKEN" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "errors": [
    ],
  • "relatedData": [
    ]
}

Get delivery note's items

Return a complete list of items from the delivery note.

Authorizations:
bearer
path Parameters
nuboId
required
string <uuid>
Example: 38dd7a78-3af7-41fc-9477-b019bf84936d

Internal id of delivery note in NuboWMS

Responses

Request samples

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://api-test.nubowms.pl/api/v1/delivery-notes/38dd7a78-3af7-41fc-9477-b019bf84936d/items"),
    Headers =
    {
        { "Authorization", "Bearer REPLACE_BEARER_TOKEN" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

Response samples

Content type
application/json
[
  • {
    }
]

Get delivery note's items

Return a complete list of items from the delivery note.

Authorizations:
bearer
path Parameters
externalCode
required
string
Example: PZ%2F2023%2F01%2F00003

External code that identifies delivery note in NuboWMS (ensure code is URI escaped)

Responses

Request samples

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://api-test.nubowms.pl/api/v1/delivery-notes/PZ%2F2023%2F01%2F00003/items"),
    Headers =
    {
        { "Authorization", "Bearer REPLACE_BEARER_TOKEN" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

Response samples

Content type
application/json
[
  • {
    }
]

Get accepted resources for specific delivery note

Return a list resources (product, traits, quantity) accepted as a result of completing delivery note.

Authorizations:
bearer
path Parameters
externalCode
required
string
Example: PZ%2F2023%2F01%2F00003

External code that identifies delivery note in NuboWMS (ensure code is URI escaped)

Responses

Request samples

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://api-test.nubowms.pl/api/v1/delivery-notes/PZ%2F2023%2F01%2F00003/accepted-resources"),
    Headers =
    {
        { "Authorization", "Bearer REPLACE_BEARER_TOKEN" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

Response samples

Content type
application/json
[
  • {
    }
]

Change delivery note's status

Currently only cancellation is available.

Authorizations:
bearer
path Parameters
externalCode
required
string
Example: PZ%2F2023%2F01%2F00003

External code that identifies delivery note in NuboWMS

Request Body schema:

New status (cancelled)

status
required
string
Value: "CANCELED"

New delivery note status

Responses

Request samples

Content type
{
  • "status": "CANCELED"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "errors": [
    ],
  • "relatedData": [
    ]
}

Get delivery note's status

Authorizations:
bearer
path Parameters
externalCode
required
string
Example: PZ%2F2023%2F01%2F00003

External code that identifies delivery note in NuboWMS

Responses

Request samples

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://api-test.nubowms.pl/api/v1/delivery-notes/PZ%2F2023%2F01%2F00003/status"),
    Headers =
    {
        { "Authorization", "Bearer REPLACE_BEARER_TOKEN" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

Response samples

Content type
application/json
{
  • "deliveryNoteStatus": "NEW"
}

ExternalReleaseImports

Creates external releases import

Creates batch job that import multiple external releases at once.

Note that execution of imports is asynchronous. After receiving response with 202 Accepted HTTP status code external releases may not be yet present in the system. You have to poll report endpoint by using response Location header value and check import status. When it is DONE_OK external release was successfuly imported.

Import ignores all errors. For example when importing 5 external releases (and 2 of them have import errors ) only 3 external releases will be imported.

Authorizations:
bearer
Request Body schema:

External releases to import

required
Array of objects

Responses

Request samples

Content type
{
  • "externalReleases": [
    ]
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "errors": [
    ],
  • "relatedData": [
    ]
}

Gets external releases import report

Returns information about import progress. Each imported external release will be represented as separate object in the returned array.

Authorizations:
bearer
path Parameters
importId
required
string <uuid>

Import id - can be available from value of Location header in Creates external releases import response.

Responses

Request samples

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://api-test.nubowms.pl/api/v1/external-release-imports/%7BimportId%7D/report"),
    Headers =
    {
        { "Authorization", "Bearer REPLACE_BEARER_TOKEN" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

Response samples

Content type
application/json
[
  • {
    }
]

ExternalReleases

Get external releases

Returns external releases. Result is paginated.

Authorizations:
bearer
query Parameters
createdDateFrom
string <date-time>
Example: createdDateFrom=2025-01-01T00:00:00Z

Filters external releases created after the specified date. If null, the filter is ignored.

createdDateTo
string <date-time>
Example: createdDateTo=2025-01-01T00:00:00Z

Filters external releases created before the specified date. If null, the filter is ignored.

issueDateFrom
string <date-time>
Example: issueDateFrom=2025-01-01T00:00:00Z

Filters external releases accepted after the specified date. If null, the filter is ignored.

issueDateTo
string <date-time>
Example: issueDateTo=2025-01-01T00:00:00Z

Filters external releases accepted before the specified date. If null, the filter is ignored.

lastModifiedDateFrom
string <date-time>
Example: lastModifiedDateFrom=2025-01-01T00:00:00Z

Filters external releases modified after the specified date. If null, the filter is ignored.

lastModifiedDateTo
string <date-time>
Example: lastModifiedDateTo=2025-01-01T00:00:00Z

Filters external releases modified before the specified date. If null, the filter is ignored.

limit
integer <int32>
Example: limit=10

Limits number of results returned in a repsponse. Example: there are 250 products and you want to fetch first 15 of them, then you should pass limit=15.

Max. value is 1000.

Default value is 10.

offset
integer <int32>
Example: offset=0

Offsets results by specified number. Example: there are 250 products and you want to fetch last 50 of them, then you should pass offset=200.

Default value is 0.

showOnlyWithoutExternalCode
boolean
Example: showOnlyWithoutExternalCode=false

When set to true, returns only external releases that don't have an external code assigned. These are typically releases created through NuboWMS Panel app. If null, the filter is ignored.

statuses
Array of strings
Items Enum: "Created" "PickedToRealization" "PickingInProgress" "ReadyForReplenishment" "ReplenishmentInProgress" "ReadyForPacking" "PackingInProgress" "ReadyForLoading" "LoadingInProgress" "Completed" "CompletedWithShortages" "Cancelled" "PassingToPicking" "PickedWithShortages" "WaitingForPackingWithShortages"

Filters external releases with specified statuses. Comma separated string. If null, the filter is ignored.

warehouseCode
string
Example: warehouseCode=MAG_KRAKOW

Warehouse code. If null, the default warehouse will be used.

Responses

Request samples

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://api-test.nubowms.pl/api/v1/external-releases?createdDateFrom=2025-01-01T00%3A00%3A00Z&createdDateTo=2025-01-01T00%3A00%3A00Z&issueDateFrom=2025-01-01T00%3A00%3A00Z&issueDateTo=2025-01-01T00%3A00%3A00Z&lastModifiedDateFrom=2025-01-01T00%3A00%3A00Z&lastModifiedDateTo=2025-01-01T00%3A00%3A00Z&limit=10&offset=0&showOnlyWithoutExternalCode=false&statuses=SOME_ARRAY_VALUE&warehouseCode=SOME_STRING_VALUE"),
    Headers =
    {
        { "Authorization", "Bearer REPLACE_BEARER_TOKEN" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

Response samples

Content type
application/json
{
  • "count": 0,
  • "items": [
    ],
  • "totalCount": 0
}

Create external release

Authorizations:
bearer
query Parameters
warehouseCode
string
Example: warehouseCode=MAG_KRAKOW

Warehouse code. If null, the default warehouse will be used.

Request Body schema:
object or null
contractorCode
string or null

Contractor code

required
object
externalCode
required
string

External release's external code (document code from your system)

required
Array of objects
priority
required
string
Enum: "Normal" "AboveNormal" "High" "Low" "BelowNormal"

External release priority

remarks
string or null

External release remarks

required
object
type
required
string
Enum: "EXTERNAL_RELEASE" "INTERNAL_RELEASE" "LIQUIDATION" "TRANSFER"

External release type

Responses

Request samples

Content type
{
  • "contractor": {
    },
  • "contractorCode": "KNT_CODE",
  • "deliveryAddress": {
    },
  • "externalCode": "RO/124/2023",
  • "items": [
    ],
  • "priority": "Normal",
  • "remarks": "Dodajcie gratis",
  • "shipmentInfo": {
    },
  • "type": "EXTERNAL_RELEASE"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "errors": [
    ],
  • "relatedData": [
    ]
}

Get external release by NuboWMS id

Return external release by nubo internal id or 404 Not Found when external release with given nubo id does not exist.

Authorizations:
bearer
path Parameters
nuboId
required
string <uuid>
Example: 17ab60b6-d9af-4c0b-b109-8881e2357306

Internal id of external release in NuboWMS

Responses

Request samples

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://api-test.nubowms.pl/api/v1/external-releases/17ab60b6-d9af-4c0b-b109-8881e2357306"),
    Headers =
    {
        { "Authorization", "Bearer REPLACE_BEARER_TOKEN" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

Response samples

Content type
application/json
{
  • "contractorCode": "KNT_CODE",
  • "contractorName": "Example contractor name",
  • "contractorTin": "7620850038",
  • "createdAt": "2019-08-24",
  • "deliveryAddressApartmentNumber": "7",
  • "deliveryAddressCity": "Warszawa",
  • "deliveryAddressCountryCode": "PL",
  • "deliveryAddressHouseNumber": "17C",
  • "deliveryAddressStreet": "Wrzosowa",
  • "deliveryAddressZipCode": "33-333",
  • "externalCode": "RO/124/2023",
  • "id": "17ab60b6-d9af-4c0b-b109-8881e2357306",
  • "issueDate": "2019-08-24",
  • "lastModifiedAt": "2019-08-24",
  • "numberDisplay": "RO/124/2023",
  • "priority": "Normal",
  • "remarks": "Dodajcie gratis",
  • "shipmentDate": "2023-08-24",
  • "shipmentMethodCode": "Inpost",
  • "status": "PickingInProgress",
  • "type": "EXTERNAL_RELEASE",
  • "waybills": [
    ]
}

Get external release by external code

Return external release by external code or 404 Not Found when external release with given code does not exist.

Authorizations:
bearer
path Parameters
externalCode
required
string
Example: RO%2F124%2F2023

External code that identifies external release in NuboWMS (ensure code is URI escaped)

Responses

Request samples

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://api-test.nubowms.pl/api/v1/external-releases/RO%2F124%2F2023"),
    Headers =
    {
        { "Authorization", "Bearer REPLACE_BEARER_TOKEN" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

Response samples

Content type
application/json
{
  • "contractorCode": "KNT_CODE",
  • "contractorName": "Example contractor name",
  • "contractorTin": "7620850038",
  • "createdAt": "2019-08-24",
  • "deliveryAddressApartmentNumber": "7",
  • "deliveryAddressCity": "Warszawa",
  • "deliveryAddressCountryCode": "PL",
  • "deliveryAddressHouseNumber": "17C",
  • "deliveryAddressStreet": "Wrzosowa",
  • "deliveryAddressZipCode": "33-333",
  • "externalCode": "RO/124/2023",
  • "id": "17ab60b6-d9af-4c0b-b109-8881e2357306",
  • "issueDate": "2019-08-24",
  • "lastModifiedAt": "2019-08-24",
  • "numberDisplay": "RO/124/2023",
  • "priority": "Normal",
  • "remarks": "Dodajcie gratis",
  • "shipmentDate": "2023-08-24",
  • "shipmentMethodCode": "Inpost",
  • "status": "PickingInProgress",
  • "type": "EXTERNAL_RELEASE",
  • "waybills": [
    ]
}

Edit external release

Authorizations:
bearer
path Parameters
externalCode
required
string
Example: RO%2F124%2F2023

External code that identifies external release in NuboWMS

Request Body schema:

External release data (existsing state will be overwritten)

contractorCode
required
string

Contractor code

required
object
required
Array of objects
priority
required
string
Enum: "Normal" "AboveNormal" "High" "Low" "BelowNormal"
remarks
string or null

External release remarks

required
object
type
required
string
Enum: "EXTERNAL_RELEASE" "INTERNAL_RELEASE" "LIQUIDATION" "TRANSFER"

Responses

Request samples

Content type
{
  • "contractorCode": "KNT_CODE",
  • "deliveryAddress": {
    },
  • "items": [
    ],
  • "priority": "Normal",
  • "remarks": "Dodajcie gratis",
  • "shipmentInfo": {
    },
  • "type": "EXTERNAL_RELEASE"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "errors": [
    ],
  • "relatedData": [
    ]
}

Delete external release

Authorizations:
bearer
path Parameters
externalCode
required
string
Example: RO%2F124%2F2023

External code that identifies external release in NuboWMS

Responses

Request samples

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Delete,
    RequestUri = new Uri("https://api-test.nubowms.pl/api/v1/external-releases/RO%2F124%2F2023"),
    Headers =
    {
        { "Authorization", "Bearer REPLACE_BEARER_TOKEN" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "errors": [
    ],
  • "relatedData": [
    ]
}

Get external release's items by NuboWMS id

Return a complete list of items from the external release.

Authorizations:
bearer
path Parameters
nuboId
required
string <uuid>
Example: 17ab60b6-d9af-4c0b-b109-8881e2357306

Internal id of external release in NuboWMS

Responses

Request samples

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://api-test.nubowms.pl/api/v1/external-releases/17ab60b6-d9af-4c0b-b109-8881e2357306/items"),
    Headers =
    {
        { "Authorization", "Bearer REPLACE_BEARER_TOKEN" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

Response samples

Content type
application/json
[
  • {
    }
]

Get external release's items

Return a complete list of items from the external release.

Authorizations:
bearer
path Parameters
externalCode
required
string
Example: RO%2F124%2F2023

External code that identifies external release in NuboWMS (ensure code is URI escaped)

Responses

Request samples

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://api-test.nubowms.pl/api/v1/external-releases/RO%2F124%2F2023/items"),
    Headers =
    {
        { "Authorization", "Bearer REPLACE_BEARER_TOKEN" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

Response samples

Content type
application/json
[
  • {
    }
]

Get released resources for specific external release

Return a list resources (product, traits, quantity) released as a result of completing external release.

Authorizations:
bearer
path Parameters
externalCode
required
string
Example: RO%2F124%2F2023

External code that identifies external release in NuboWMS (ensure code is URI escaped)

Responses

Request samples

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://api-test.nubowms.pl/api/v1/external-releases/RO%2F124%2F2023/released-resources"),
    Headers =
    {
        { "Authorization", "Bearer REPLACE_BEARER_TOKEN" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

Response samples

Content type
application/json
[
  • {
    }
]

Change external release's status

Currently only cancellation is available.

Authorizations:
bearer
path Parameters
externalCode
required
string
Example: RO%2F124%2F2023

External code that identifies external release in NuboWMS

Request Body schema:

New status (cancelled)

status
required
string
Value: "Cancelled"

Responses

Request samples

Content type
{
  • "status": "Cancelled"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "errors": [
    ],
  • "relatedData": [
    ]
}

Get external release's status

Authorizations:
bearer
path Parameters
externalCode
required
string
Example: RO%2F124%2F2023

External code that identifies external release in NuboWMS

Responses

Request samples

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://api-test.nubowms.pl/api/v1/external-releases/RO%2F124%2F2023/status"),
    Headers =
    {
        { "Authorization", "Bearer REPLACE_BEARER_TOKEN" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

Response samples

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

Images

Get image

Retrieves an image file by its ID. The file is returned in binary format along with its metadata, such as content type and file name.

Authorizations:
bearer
path Parameters
fileId
required
string <uuid>

The ID of the image file to retrieve.

Responses

Request samples

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://api-test.nubowms.pl/api/v1/images/%7BfileId%7D"),
    Headers =
    {
        { "Authorization", "Bearer REPLACE_BEARER_TOKEN" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

ProductImports

Creates products import

Creates batch job that import multiple products at once.

Note that execution of imports is asynchronous. After receiving response with 202 Accepted HTTP status code products may not be yet present in the system. You have to poll report endpoint by using response Location header value and check import status. When it is DONE_OK product was successfuly imported.

Import ignores all errors. For example when importing 5 products (and 2 of them already exists in NuboWMS) only 3 products will be imported.

Authorizations:
bearer
Request Body schema:

Products to import

required
Array of objects

Responses

Request samples

Content type
{
  • "products": [
    ]
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "errors": [
    ],
  • "relatedData": [
    ]
}

Gets products import report

Returns information about import progress. Each imported contractor will be represented as separate object in the returned array.

Authorizations:
bearer
path Parameters
importId
required
string <uuid>

Import id - can be available from value of Location header in Creates products import response.

Responses

Request samples

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://api-test.nubowms.pl/api/v1/product-imports/%7BimportId%7D/report"),
    Headers =
    {
        { "Authorization", "Bearer REPLACE_BEARER_TOKEN" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

Response samples

Content type
application/json
[
  • {
    }
]

Products

Get products

Returns products. Result is paginated.

Authorizations:
bearer
query Parameters
lastModifiedDateFrom
string <date-time>
Example: lastModifiedDateFrom=2025-01-01T00:00:00Z

Filters products modified after the specified date. If null, the filter is ignored.

limit
integer <int32>
Example: limit=10

Limits number of results returned in a repsponse. Example: there are 250 products and you want to fetch first 15 of them, then you should pass limit=15.

Max. value is 1000.

Default value is 10.

offset
integer <int32>
Example: offset=0

Offsets results by specified number. Example: there are 250 products and you want to fetch last 50 of them, then you should pass offset=200.

Default value is 0.

productCodes
Array of strings

Shows only products with specified codes.

searchText
string
Example: searchText=ipho

Shows only products that includes search text phrase in code or name or in product barcodes.

Responses

Request samples

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://api-test.nubowms.pl/api/v1/products?lastModifiedDateFrom=2025-01-01T00%3A00%3A00Z&limit=10&offset=0&productCodes=SOME_ARRAY_VALUE&searchText=ipho"),
    Headers =
    {
        { "Authorization", "Bearer REPLACE_BEARER_TOKEN" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

Response samples

Content type
application/json
{
  • "count": 0,
  • "items": [
    ],
  • "totalCount": 0
}

Create product

Authorizations:
bearer
Request Body schema:
barcodes
Array of strings or null

List of all barcodes that can identify product

code
required
string

Product code

defaultBarcode
string or null

The default barcode used to identify the product. If null, the first barcode from the Barcodes list is used.

defaultUnitOfMeasureCode
string or null

Default (base) unit of measure code

object or null

Represents the dimensions of a product in meters (m).

name
required
string

Product name

nonStandardSize
required
boolean

Indicates whether product has non standard size. For example product is a very long steel rod.

remarks
string or null

Product remarks

object or null

Required traits for product (NuboWMS will force control for this traits)

unitOfMeasures
required
Array of strings

List of all unit of measures available for product

object or null

Represents the weight details of a product in kilograms (kg).

Responses

Request samples

Content type
{
  • "barcodes": 978020137962,
  • "code": "PROD_CODE_1",
  • "defaultBarcode": "5901234123457",
  • "defaultUnitOfMeasureCode": "szt.",
  • "dimensions": {
    },
  • "name": "product descriptive name",
  • "nonStandardSize": false,
  • "remarks": "delikatne opakownie",
  • "requiredTraits": {
    },
  • "unitOfMeasures": [
    ],
  • "weight": {
    }
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "errors": [
    ],
  • "relatedData": [
    ]
}

Get product by code

Return product by code or 404 Not Found when product with given code does not exist.

Authorizations:
bearer
path Parameters
productCode
required
string
Example: iphone

Product code (ensure code is URI escaped)

Responses

Request samples

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://api-test.nubowms.pl/api/v1/products/iphone"),
    Headers =
    {
        { "Authorization", "Bearer REPLACE_BEARER_TOKEN" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

Response samples

Content type
application/json
{
  • "barcodes": 978020137962,
  • "code": "PROD_CODE_1",
  • "defaultUnitOfMeasureCode": "szt.",
  • "dimensions": {
    },
  • "images": [],
  • "lastModifiedAt": "2019-08-24",
  • "name": "product descriptive name",
  • "nonStandardSize": false,
  • "remarks": "delikatne opakownie",
  • "requiredTraits": {
    },
  • "status": "Active",
  • "unitOfMeasuresCodes": [
    ],
  • "weight": {
    }
}

Edit product

Authorizations:
bearer
path Parameters
productCode
required
string
Example: iphone

Product code (ensure code is URI escaped)

Request Body schema:

Product data (current product state will be overwritten)

barcodes
Array of strings or null

List of all barcodes that can identify product

defaultBarcode
string or null

The default barcode used to identify the product. If null, the first barcode from the Barcodes list is used.

defaultUnitOfMeasureCode
string or null

Default (base) unit of measure code

object or null

Represents the dimensions of a product in meters (m).

name
required
string

Product name

nonStandardSize
required
boolean

Indicates whether product has non standard size. For example product is a very long steel rod.

remarks
string or null

Product remarks

object or null

Required traits for product (NuboWMS will force control for this traits)

unitOfMeasures
required
Array of strings

List of all unit of measures available for product

object or null

Represents the weight details of a product in kilograms (kg).

Responses

Request samples

Content type
{
  • "barcodes": [
    ],
  • "defaultBarcode": "5901234123457",
  • "defaultUnitOfMeasureCode": "szt.",
  • "dimensions": {
    },
  • "name": "product descriptive name",
  • "nonStandardSize": false,
  • "remarks": "delikatne opakownie",
  • "requiredTraits": {
    },
  • "unitOfMeasures": [
    ],
  • "weight": {
    }
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "errors": [
    ],
  • "relatedData": [
    ]
}

Delete product

Authorizations:
bearer
path Parameters
productCode
required
string
Example: iphone

Product code (ensure code is URI escaped)

Responses

Request samples

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Delete,
    RequestUri = new Uri("https://api-test.nubowms.pl/api/v1/products/iphone"),
    Headers =
    {
        { "Authorization", "Bearer REPLACE_BEARER_TOKEN" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "errors": [
    ],
  • "relatedData": [
    ]
}

Change product's status

Authorizations:
bearer
path Parameters
productCode
required
string
Example: iphone

Product code (ensure code is URI escaped)

Request Body schema:

New status

newStatus
required
string
Enum: "InActive" "Active" "Archived"

Responses

Request samples

Content type
{
  • "newStatus": "InActive"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "errors": [
    ],
  • "relatedData": [
    ]
}

Change product's required traits

Authorizations:
bearer
path Parameters
productCode
required
string
Example: iphone

Product code (ensure code is URI escaped)

Request Body schema:

New required traits

required
object

Required traits for product (NuboWMS will force control for this traits)

Responses

Request samples

Content type
{
  • "requiredTraits": {
    }
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "errors": [
    ],
  • "relatedData": [
    ]
}

Add product image

Authorizations:
bearer
path Parameters
productCode
required
string
Example: iphone

Product code (ensure code is URI escaped)

Request Body schema: multipart/form-data
file
required
string <binary>

Image file to be added to the product. The file should be uploaded using the multipart/form-data content type, and it is automatically converted to JPEG format. If the image dimensions exceed 1440 pixels in width or height, it is resized proportionally to fit within a 1440 x 1440 pixel frame while maintaining the original aspect ratio.

Responses

Request samples

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Post,
    RequestUri = new Uri("https://api-test.nubowms.pl/api/v1/products/iphone/images"),
    Headers =
    {
        { "Authorization", "Bearer REPLACE_BEARER_TOKEN" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "errors": [
    ],
  • "relatedData": [
    ]
}

Set product image as default

Authorizations:
bearer
path Parameters
fileId
required
string <uuid>
Example: d290f1ee-6c54-4b01-90e6-d701748f0851

Unique identifier of the image file to be set as default.

productCode
required
string
Example: iphone

Product code (ensure code is URI escaped)

Responses

Request samples

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Put,
    RequestUri = new Uri("https://api-test.nubowms.pl/api/v1/products/iphone/images/d290f1ee-6c54-4b01-90e6-d701748f0851/default"),
    Headers =
    {
        { "Authorization", "Bearer REPLACE_BEARER_TOKEN" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "errors": [
    ],
  • "relatedData": [
    ]
}

Remove product image

Authorizations:
bearer
path Parameters
fileId
required
string <uuid>
Example: d290f1ee-6c54-4b01-90e6-d701748f0851

Unique identifier of the image file to be removed.

productCode
required
string
Example: iphone

Product code (ensure code is URI escaped)

Responses

Request samples

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Delete,
    RequestUri = new Uri("https://api-test.nubowms.pl/api/v1/products/iphone/images/d290f1ee-6c54-4b01-90e6-d701748f0851"),
    Headers =
    {
        { "Authorization", "Bearer REPLACE_BEARER_TOKEN" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "errors": [
    ],
  • "relatedData": [
    ]
}

StockInfo

Get stock info

Returns stock info (grouped by product id)

Authorizations:
bearer
query Parameters
hasStock
boolean

Filters stock info based on quantity.

  • true - returns only records where quantity is greater than 0.
  • false - returns only records where quantity is equal to 0.
  • null - returns all records, regardless of quantity (default).
lastModifiedDateFrom
string <date-time>
Example: lastModifiedDateFrom=2025-01-01T00:00:00Z

Filters stock info modified after the specified date. If null, the filter is ignored.

limit
integer <int32>
Example: limit=10

Limits number of results returned in a repsponse. Example: there are 250 products and you want to fetch first 15 of them, then you should pass limit=15.

Max. value is 1000.

Default value is 10.

offset
integer <int32>
Example: offset=0

Offsets results by specified number. Example: there are 250 products and you want to fetch last 50 of them, then you should pass offset=200.

Default value is 0.

productCodes
Array of strings

Filter result set to products with specifed codes. Comma separated string.

warehouseCode
string
Example: warehouseCode=MAG_KRAKOW

Warehouse code. If null, the default warehouse will be used.

Responses

Request samples

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://api-test.nubowms.pl/api/v1/stock-info?hasStock=SOME_BOOLEAN_VALUE&lastModifiedDateFrom=2025-01-01T00%3A00%3A00Z&limit=10&offset=0&productCodes=SOME_ARRAY_VALUE&warehouseCode=SOME_STRING_VALUE"),
    Headers =
    {
        { "Authorization", "Bearer REPLACE_BEARER_TOKEN" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

Response samples

Content type
application/json
{
  • "count": 0,
  • "items": [
    ],
  • "totalCount": 0
}

Transfers

Get transfers

Returns transfers. Result is paginated.

Authorizations:
bearer
query Parameters
lastModifiedDateFrom
string <date-time>
Example: lastModifiedDateFrom=2025-01-01T00:00:00Z

Filters delivery notes modified after the specified date. If null, the filter is ignored.

limit
integer <int32>
Example: limit=10

Limits number of results returned in a repsponse. Example: there are 250 products and you want to fetch first 15 of them, then you should pass limit=15.

Max. value is 1000.

Default value is 10.

offset
integer <int32>
Example: offset=0

Offsets results by specified number. Example: there are 250 products and you want to fetch last 50 of them, then you should pass offset=200.

Default value is 0.

showOnlyWithoutExternalCode
boolean
Example: showOnlyWithoutExternalCode=false

When set to true, returns only transfers that don't have an external code assigned. These are typically transfers created through NuboWMS Panel app. If null, the filter is ignored.

warehouseCode
string
Example: warehouseCode=MAG_KRAKOW

Warehouse code. If null, the default warehouse will be used.

Responses

Request samples

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://api-test.nubowms.pl/api/v1/transfers?lastModifiedDateFrom=2025-01-01T00%3A00%3A00Z&limit=10&offset=0&showOnlyWithoutExternalCode=false&warehouseCode=SOME_STRING_VALUE"),
    Headers =
    {
        { "Authorization", "Bearer REPLACE_BEARER_TOKEN" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

Response samples

Content type
application/json
{
  • "count": 0,
  • "items": [
    ],
  • "totalCount": 0
}

Create transfer

Authorizations:
bearer
query Parameters
warehouseCode
string
Example: warehouseCode=MAG_KRAKOW

Warehouse code. If null, the default warehouse will be used.

Request Body schema:

Transfer data

externalCode
required
string

Transfer's external code (document code from your system)

required
Array of objects
priority
required
string
Enum: "Normal" "AboveNormal" "High" "Low" "BelowNormal"

Transfer priority

recipientWarehouseCode
string or null

Recipient warehouse code

remarks
string or null

Transfer remarks

required
object

Responses

Request samples

Content type
{
  • "externalCode": "RO/124/2023",
  • "items": [
    ],
  • "priority": "Normal",
  • "recipientWarehouseCode": "MAG_KATOWICE",
  • "remarks": "Dodajcie gratis",
  • "shipmentInfo": {
    }
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "errors": [
    ],
  • "relatedData": [
    ]
}

Get transfer by NuboWMS id

Return transfer by nubo internal id or 404 Not Found when transfer with given nubo id does not exist.

Authorizations:
bearer
path Parameters
nuboId
required
string <uuid>
Example: 17ab60b6-d9af-4c0b-b109-8881e2357306

Internal id of transfer in NuboWMS

Responses

Request samples

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://api-test.nubowms.pl/api/v1/transfers/17ab60b6-d9af-4c0b-b109-8881e2357306"),
    Headers =
    {
        { "Authorization", "Bearer REPLACE_BEARER_TOKEN" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

Response samples

Content type
application/json
{
  • "acceptedAt": "2019-08-24",
  • "createdAt": "2019-08-24",
  • "externalCode": "RO/124/2023",
  • "id": "38dd7a78-3af7-41fc-9477-b019bf84936d",
  • "lastModifiedAt": "2019-08-24",
  • "plannedShipmentDate": "2023-08-24",
  • "priority": "Normal",
  • "recipientWarehouse": {
    },
  • "remarks": "Dodajcie gratis",
  • "shipperWarehouse": {
    },
  • "status": "PickingInProgress"
}

Get transfer by external code

Return transfer by external code or 404 Not Found when transfer with given code does not exist.

Authorizations:
bearer
path Parameters
externalCode
required
string
Example: RO%2F124%2F2023

External code that identifies transfer in NuboWMS (ensure code is URI escaped)

Responses

Request samples

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://api-test.nubowms.pl/api/v1/transfers/RO%2F124%2F2023"),
    Headers =
    {
        { "Authorization", "Bearer REPLACE_BEARER_TOKEN" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

Response samples

Content type
application/json
{
  • "acceptedAt": "2019-08-24",
  • "createdAt": "2019-08-24",
  • "externalCode": "RO/124/2023",
  • "id": "38dd7a78-3af7-41fc-9477-b019bf84936d",
  • "lastModifiedAt": "2019-08-24",
  • "plannedShipmentDate": "2023-08-24",
  • "priority": "Normal",
  • "recipientWarehouse": {
    },
  • "remarks": "Dodajcie gratis",
  • "shipperWarehouse": {
    },
  • "status": "PickingInProgress"
}

Edit transfer

Authorizations:
bearer
path Parameters
externalCode
required
string
Example: RO%2F124%2F2023

External code that identifies transfer in NuboWMS

Request Body schema:

External release data (existsing state will be overwritten)

required
Array of objects
priority
required
string
Enum: "Normal" "AboveNormal" "High" "Low" "BelowNormal"
recipientWarehouseCode
string or null

Recipient warehouse code

remarks
string or null

External release remarks

required
object

Responses

Request samples

Content type
{
  • "items": [
    ],
  • "priority": "Normal",
  • "recipientWarehouseCode": "MAG_KATOWICE",
  • "remarks": "Dodajcie gratis",
  • "shipmentInfo": {
    }
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "errors": [
    ],
  • "relatedData": [
    ]
}

Delete transfer

Authorizations:
bearer
path Parameters
externalCode
required
string
Example: RO%2F124%2F2023

External code that identifies transfer in NuboWMS

Responses

Request samples

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Delete,
    RequestUri = new Uri("https://api-test.nubowms.pl/api/v1/transfers/RO%2F124%2F2023"),
    Headers =
    {
        { "Authorization", "Bearer REPLACE_BEARER_TOKEN" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "errors": [
    ],
  • "relatedData": [
    ]
}

Get transfer's items by NuboWMS id

Return a complete list of items from the transfer.

Authorizations:
bearer
path Parameters
nuboId
required
string <uuid>
Example: 17ab60b6-d9af-4c0b-b109-8881e2357306

Internal id of transfer in NuboWMS

Responses

Request samples

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://api-test.nubowms.pl/api/v1/transfers/17ab60b6-d9af-4c0b-b109-8881e2357306/items"),
    Headers =
    {
        { "Authorization", "Bearer REPLACE_BEARER_TOKEN" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

Response samples

Content type
application/json
[
  • {
    }
]

Get transfer's items

Return a complete list of items from the transfer.

Authorizations:
bearer
path Parameters
externalCode
required
string
Example: RO%2F124%2F2023

External code that identifies transfer in NuboWMS (ensure code is URI escaped)

Responses

Request samples

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://api-test.nubowms.pl/api/v1/transfers/RO%2F124%2F2023/items"),
    Headers =
    {
        { "Authorization", "Bearer REPLACE_BEARER_TOKEN" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

Response samples

Content type
application/json
[
  • {
    }
]

Get transfer's status by NuboWMS id

Return the status of a transfer by its internal id.

Authorizations:
bearer
path Parameters
nuboId
required
string <uuid>
Example: 17ab60b6-d9af-4c0b-b109-8881e2357306

Internal id of transfer in NuboWMS

Responses

Request samples

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://api-test.nubowms.pl/api/v1/transfers/17ab60b6-d9af-4c0b-b109-8881e2357306/status"),
    Headers =
    {
        { "Authorization", "Bearer REPLACE_BEARER_TOKEN" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

Response samples

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

Change transfer's status

Currently only cancellation is available.

Authorizations:
bearer
path Parameters
externalCode
required
string
Example: RO%2F124%2F2023

External code that identifies transfer in NuboWMS

Request Body schema:

New status (cancelled)

status
required
string
Value: "Cancelled"

Responses

Request samples

Content type
{
  • "status": "Cancelled"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "errors": [
    ],
  • "relatedData": [
    ]
}

Get transfer's status

Authorizations:
bearer
path Parameters
externalCode
required
string
Example: RO%2F124%2F2023

External code that identifies transfer in NuboWMS

Responses

Request samples

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://api-test.nubowms.pl/api/v1/transfers/RO%2F124%2F2023/status"),
    Headers =
    {
        { "Authorization", "Bearer REPLACE_BEARER_TOKEN" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

Response samples

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

UnitOfMeasures

Get unit of measures

Returns unit of measures.

Authorizations:
bearer

Responses

Request samples

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://api-test.nubowms.pl/api/v1/unit-of-measures"),
    Headers =
    {
        { "Authorization", "Bearer REPLACE_BEARER_TOKEN" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

Response samples

Content type
application/json
[
  • {
    }
]

Warehouses

Get warehouses

Returns available warehouses. Result is paginated.

Authorizations:
bearer
query Parameters
lastModifiedDateFrom
string <date-time>
Example: lastModifiedDateFrom=2025-01-01T00:00:00Z

Filters warehouses modified after the specified date. If null, the filter is ignored.

limit
integer <int32>
Example: limit=10

Limits number of results returned in a repsponse. Example: there are 250 products and you want to fetch first 15 of them, then you should pass limit=15.

Max. value is 1000.

Default value is 10.

offset
integer <int32>
Example: offset=0

Offsets results by specified number. Example: there are 250 products and you want to fetch last 50 of them, then you should pass offset=200.

Default value is 0.

Responses

Request samples

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://api-test.nubowms.pl/api/v1/warehouses?lastModifiedDateFrom=2025-01-01T00%3A00%3A00Z&limit=10&offset=0"),
    Headers =
    {
        { "Authorization", "Bearer REPLACE_BEARER_TOKEN" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

Response samples

Content type
application/json
{
  • "count": 0,
  • "items": [
    ],
  • "totalCount": 0
}

Get warehouse by code

Returns warehouse details for the specified warehouse code.

Authorizations:
bearer
path Parameters
warehouseCode
required
string

Warehouse code identifier

Responses

Request samples

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://api-test.nubowms.pl/api/v1/warehouses/%7BwarehouseCode%7D"),
    Headers =
    {
        { "Authorization", "Bearer REPLACE_BEARER_TOKEN" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

Response samples

Content type
application/json
{
  • "code": "MAG_KRK",
  • "externalCode": "KRK",
  • "name": "Magazyn Krak+-w",
  • "status": "ACTIVE",
  • "warehouseId": "78a4a188-9d6f-4fdc-9fc9-a412cc429408"
}