Download OpenAPI specification:Download
NuboWMS API enables you to create and manage:
Products
If you want more information about products in NuboWMS please refer to products section of user's guide.
Contractors
If you want more information about contractors in NuboWMS please refer to contractors section of user's guide.
External releases
External releases in NuboWMS enable fulfilment of a sales document.
If you want more information about external releases in NuboWMS please refer to external releases section of user's guide.
Delivery notes
Delivery note is a document that serves as proof of delivery of goods from a supplier.
If you want more information about external releases in NuboWMS please refer to delivery note section of user's guide.
For products, contractors, external releases and delivery notes there is also a possibility of batch import (multiple objects at once).
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
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.
/ char. For endpoints that accepts such codes as a route parameter you have to URI escape the code.Returns ad hoc delivery notes (created without external system notice; by warehouse workers). Result is paginated.
| acceptedDateFrom | string <date-time> Example: acceptedDateFrom=2025-01-01T00:00:00Z Filters delivery notes accepted after the specified date.
If |
| acceptedDateTo | string <date-time> Example: acceptedDateTo=2025-01-01T00:00:00Z Filters delivery notes accepted before the specified date.
If |
| createdDateFrom | string <date-time> Example: createdDateFrom=2025-01-01T00:00:00Z Filters delivery notes created after the specified date.
If |
| createdDateTo | string <date-time> Example: createdDateTo=2025-01-01T00:00:00Z Filters delivery notes created before the specified date.
If |
| lastModifiedDateFrom | string <date-time> Example: lastModifiedDateFrom=2025-01-01T00:00:00Z Filters delivery notes modified after the specified date.
If |
| lastModifiedDateTo | string <date-time> Example: lastModifiedDateTo=2025-01-01T00:00:00Z Filters delivery notes modified before the specified date.
If |
| 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 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 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 |
| 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 |
| warehouseCode | string Example: warehouseCode=MAG_KRAKOW Warehouse code. If null, the default warehouse will be used. |
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); }
{- "count": 0,
- "items": [
- {
- "acceptedAt": "2023-08-26",
- "contractor": {
- "address": {
- "addressName": "KNT address descriptive name",
- "apartmentNumber": "7",
- "city": "Warszawa",
- "countryCode": "Pan Janek tel. 333 999 999",
- "emailAddress": "example@example.com",
- "houseNumber": "17C",
- "mainPhoneNumber": "222555666",
- "street": "Wrzosowa",
- "zipCode": "33-333"
}, - "code": "KNT_CODE",
- "name": "Example contractor name",
- "tin": "7620850038"
}, - "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"
}
], - "totalCount": 0
}Returns ad hoc delivery note or 404 Not Found when delivery note with given id does not exist.
| deliveryNoteId required | string <uuid> Example: d8f1fbde-bfae-4db7-9fd4-a9c49ae5a685 Id that identifies delivery note in NuboWMS |
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); }
{- "acceptedAt": "2023-08-26",
- "contractor": {
- "address": {
- "addressName": "KNT address descriptive name",
- "apartmentNumber": "7",
- "city": "Warszawa",
- "countryCode": "Pan Janek tel. 333 999 999",
- "emailAddress": "example@example.com",
- "houseNumber": "17C",
- "mainPhoneNumber": "222555666",
- "street": "Wrzosowa",
- "zipCode": "33-333"
}, - "code": "KNT_CODE",
- "name": "Example contractor name",
- "tin": "7620850038"
}, - "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"
}Return a complete list of items of the delivery note.
| deliveryNoteId required | string <uuid> Example: d8f1fbde-bfae-4db7-9fd4-a9c49ae5a685 Id that identifies delivery note in NuboWMS |
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); }
[- {
- "acceptedQuantity": 9.5,
- "no": 1,
- "productCode": "PROD_CODE_1",
- "productName": "product descriptive name",
- "quantityToAccept": 20,
- "unitOfMeasure": "szt."
}
]Return a list resources (product, traits, quantity) accepted as a result of completing ad hoc delivery note.
| deliveryNoteId required | string <uuid> Example: d8f1fbde-bfae-4db7-9fd4-a9c49ae5a685 Id that identifies delivery note in NuboWMS |
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); }
[- {
- "productCode": "string",
- "productId": "dcd53ddb-8104-4e48-8cc0-5df1088c6113",
- "productName": "string",
- "quantity": 0.1,
- "traitSet": {
- "bestBeforeDate": "2019-08-24",
- "lot": "string",
- "productionDate": "2019-08-24",
- "qualityControlStatus": "OK",
- "serialNumber": "string"
}, - "unitOfMeasureCode": "string"
}
]| deliveryNoteId required | string <uuid> Example: d8f1fbde-bfae-4db7-9fd4-a9c49ae5a685 Id that identifies delivery note in NuboWMS |
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); }
{- "deliveryNoteStatus": "NEW"
}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).
| deliveryNoteId required | string <uuid> Example: d8f1fbde-bfae-4db7-9fd4-a9c49ae5a685 Id that identifies delivery note in NuboWMS |
New external code.
| newExternalCode required | string |
{- "newExternalCode": "string"
}{- "code": "string",
- "errors": [
- {
- "details": "string",
- "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
- "entityType": "string",
- "errorMessages": [
- {
- "code": "string",
- "message": "string"
}
], - "field": "string",
- "messages": [
- "string"
], - "path": "string"
}
], - "relatedData": [
- {
- "description": "string",
- "interpolationOrder": 0,
- "interpolationValue": "string"
}
]
}Returns ad hoc external releases (created without external system notice; by warehouse workers). Result is paginated.
| createdDateFrom | string <date-time> Example: createdDateFrom=2025-01-01T00:00:00Z Filters external releases created after the specified date.
If |
| createdDateTo | string <date-time> Example: createdDateTo=2025-01-01T00:00:00Z Filters external releases created before the specified date.
If |
| issueDateFrom | string <date-time> Example: issueDateFrom=2025-01-01T00:00:00Z Filters external releases accepted after the specified date.
If |
| issueDateTo | string <date-time> Example: issueDateTo=2025-01-01T00:00:00Z Filters external releases accepted before the specified date.
If |
| lastModifiedDateFrom | string <date-time> Example: lastModifiedDateFrom=2025-01-01T00:00:00Z Filters external releases modified after the specified date.
If |
| lastModifiedDateTo | string <date-time> Example: lastModifiedDateTo=2025-01-01T00:00:00Z Filters external releases modified before the specified date.
If |
| 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 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 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 |
| 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 |
| warehouseCode | string Example: warehouseCode=MAG_KRAKOW Warehouse code. If null, the default warehouse will be used. |
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); }
{- "count": 0,
- "items": [
- {
- "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": [
- "string"
]
}
], - "totalCount": 0
}Return ad hoc external release or 404 Not Found when external release with given id does not exist.
| externalReleaseId required | string <uuid> Example: 9339cd2a-5458-4d7f-a193-c6ba2f055424 Id that identifies an ad hoc external release in NuboWMS |
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); }
{- "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": [
- "string"
]
}Return a complete list of items from the external release.
| externalReleaseId required | string <uuid> Example: 9339cd2a-5458-4d7f-a193-c6ba2f055424 Id that identifies an ad hoc external release in NuboWMS |
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); }
[- {
- "productCode": "PROD_CODE_1",
- "productName": "product descriptive name",
- "quantity": 20,
- "releasedQuantity": 20
}
]Return a list resources (product, traits, quantity) released as a result of completing ad hoc external release.
| externalReleaseId required | string <uuid> Example: 9339cd2a-5458-4d7f-a193-c6ba2f055424 Id that identifies an ad hoc external release in NuboWMS |
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); }
[- {
- "baseUnitOfMeasureCode": "string",
- "productCode": "string",
- "productId": "dcd53ddb-8104-4e48-8cc0-5df1088c6113",
- "productName": "string",
- "quantity": 0.1,
- "traitSet": {
- "bestBeforeDate": "2019-08-24",
- "lot": "string",
- "productionDate": "2019-08-24",
- "qualityControlStatus": "OK",
- "serialNumber": "string"
}
}
]| externalReleaseId required | string <uuid> Example: 9339cd2a-5458-4d7f-a193-c6ba2f055424 Id that identifies an ad hoc external release in NuboWMS |
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); }
{- "status": "Completed"
}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).
| externalReleaseId required | string <uuid> Example: 9339cd2a-5458-4d7f-a193-c6ba2f055424 Id that identifies an ad hoc external release in NuboWMS |
New external code.
| newExternalCode required | string |
{- "newExternalCode": "string"
}{- "code": "string",
- "errors": [
- {
- "details": "string",
- "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
- "entityType": "string",
- "errorMessages": [
- {
- "code": "string",
- "message": "string"
}
], - "field": "string",
- "messages": [
- "string"
], - "path": "string"
}
], - "relatedData": [
- {
- "description": "string",
- "interpolationOrder": 0,
- "interpolationValue": "string"
}
]
}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.
| refreshToken required | string Refresh token (valid for 2 months). |
{- "refreshToken": "string"
}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.
Contractors to import
required | Array of objects |
{- "contractorsImports": [
- {
- "addresses": [
- {
- "addressName": "KNT HQ address name",
- "apartmentNumber": "7",
- "city": "Warszawa",
- "contactPerson": "Pan Janek tel. 333 999 999",
- "countryCode": "PL",
- "emailAddress": "example@example.com",
- "houseNumber": "17C",
- "isHeadquarters": true,
- "mainPhoneNumber": "222555666",
- "secondaryPhoneNumber": "333444777",
- "street": "Wrzosowa",
- "zipCode": "33-333"
}
], - "contractorCode": "KNT_CODE",
- "contractorName": "Example contractor name",
- "contractorPriority": "Normal",
- "contractorType": "COMPANY",
- "regon": "570984220",
- "tin": "7620850038"
}
]
}{- "code": "string",
- "errors": [
- {
- "details": "string",
- "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
- "entityType": "string",
- "errorMessages": [
- {
- "code": "string",
- "message": "string"
}
], - "field": "string",
- "messages": [
- "string"
], - "path": "string"
}
], - "relatedData": [
- {
- "description": "string",
- "interpolationOrder": 0,
- "interpolationValue": "string"
}
]
}Returns information about import progress. Each imported contractor will be represented as separate object in the returned array.
| importId required | string <uuid> Import id - can be available from value of |
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); }
[- {
- "addresses": [
- {
- "addressName": "KNT HQ address name",
- "apartmentNumber": "7",
- "city": "Warszawa",
- "contactPerson": "Pan Janek tel. 333 999 999",
- "countryCode": "PL",
- "emailAddress": "example@example.com",
- "houseNumber": "17C",
- "isHeadquarters": true,
- "mainPhoneNumber": "222555666",
- "secondaryPhoneNumber": "333444777",
- "street": "Wrzosowa",
- "zipCode": "33-333"
}
], - "contractorCode": "KNT_CODE",
- "contractorExists": false,
- "contractorName": "Example contractor name",
- "contractorPriority": "Normal",
- "contractorType": "COMPANY",
- "errors": [
- {
- "errorType": ""
}
], - "hasErrors": false,
- "importStatus": "CREATED",
- "regon": "570984220",
- "tin": "7620850038"
}
]Returns contractors. Result is paginated.
| lastModifiedDateFrom | string <date-time> Example: lastModifiedDateFrom=2025-01-01T00:00:00Z Filters contractors modified after the specified date.
If |
| 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 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 Default value is 0. |
| searchText | string Example: searchText=knt Shows only contractors that includes |
| statuses | Array of strings Items Enum: "InActive" "Active" "Archived" Show contractors with specified statuses. If |
| types | Array of strings Items Enum: "PERSON" "COMPANY" Show contractors with specified types. If |
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); }
{- "count": 0,
- "items": [
- {
- "code": "KNT_CODE",
- "headquarterAddress": {
- "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",
- "phoneNumber": "string",
- "secondaryPhoneNumber": "333444777",
- "street": "Wrzosowa",
- "zipCode": "33-333"
}, - "name": "Example contractor name",
- "status": "ACTIVE",
- "tin": "7620850038",
- "type": "COMPANY"
}
], - "totalCount": 0
}| 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 |
{- "active": true,
- "addresses": [
- {
- "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"
}
], - "code": "KNT_CODE",
- "headquarterAddress": {
- "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"
}, - "name": "Example contractor name",
- "priority": "Normal",
- "regon": "570984220",
- "remarks": "rabat 5% na wszystko",
- "tin": "7620850038",
- "type": "COMPANY"
}{- "code": "string",
- "errors": [
- {
- "details": "string",
- "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
- "entityType": "string",
- "errorMessages": [
- {
- "code": "string",
- "message": "string"
}
], - "field": "string",
- "messages": [
- "string"
], - "path": "string"
}
], - "relatedData": [
- {
- "description": "string",
- "interpolationOrder": 0,
- "interpolationValue": "string"
}
]
}Returns contractor by code or 404 Not Found when contractor with given code does not exist.
| contractorCode required | string Example: knt_code Contractor code. (ensure code is URI escaped) |
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); }
{- "active": true,
- "addresses": [
- {
- "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"
}
], - "code": "KNT_CODE",
- "headquarterAddress": {
- "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",
- "phoneNumber": "string",
- "secondaryPhoneNumber": "333444777",
- "street": "Wrzosowa",
- "zipCode": "33-333"
}, - "name": "Example contractor name",
- "priority": "Normal",
- "regon": "570984220",
- "remarks": "rabat 5% na wszystko",
- "status": "ACTIVE",
- "tin": "7620850038",
- "type": "COMPANY"
}| contractorCode required | string Example: knt_code Contractor code. (ensure code is URI escaped) |
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); }
{- "code": "string",
- "errors": [
- {
- "details": "string",
- "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
- "entityType": "string",
- "errorMessages": [
- {
- "code": "string",
- "message": "string"
}
], - "field": "string",
- "messages": [
- "string"
], - "path": "string"
}
], - "relatedData": [
- {
- "description": "string",
- "interpolationOrder": 0,
- "interpolationValue": "string"
}
]
}| contractorCode required | string Example: knt_code Contractor code. (ensure code is URI escaped) |
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 |
{- "active": true,
- "addresses": [
- {
- "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"
}
], - "headquarterAddress": {
- "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"
}, - "name": "Example contractor name",
- "priority": "Normal",
- "regon": "570984220",
- "remarks": "rabat 5% na wszystko",
- "tin": "7620850038",
- "type": "COMPANY"
}{- "code": "string",
- "errors": [
- {
- "details": "string",
- "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
- "entityType": "string",
- "errorMessages": [
- {
- "code": "string",
- "message": "string"
}
], - "field": "string",
- "messages": [
- "string"
], - "path": "string"
}
], - "relatedData": [
- {
- "description": "string",
- "interpolationOrder": 0,
- "interpolationValue": "string"
}
]
}Returns contractor's addresses. Result is paginated.
| contractorCode required | string Example: knt_code Contractor code (ensure code is URI escaped) |
| 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 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 Default value is 0. |
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); }
{- "count": 0,
- "items": [
- {
- "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"
}
], - "totalCount": 0
}| contractorCode required | string Example: knt_code Contractor code (ensure code is URI escaped) |
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) |
| 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 |
{- "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"
}{- "code": "string",
- "errors": [
- {
- "details": "string",
- "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
- "entityType": "string",
- "errorMessages": [
- {
- "code": "string",
- "message": "string"
}
], - "field": "string",
- "messages": [
- "string"
], - "path": "string"
}
], - "relatedData": [
- {
- "description": "string",
- "interpolationOrder": 0,
- "interpolationValue": "string"
}
]
}| 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) |
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); }
{- "code": "string",
- "errors": [
- {
- "details": "string",
- "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
- "entityType": "string",
- "errorMessages": [
- {
- "code": "string",
- "message": "string"
}
], - "field": "string",
- "messages": [
- "string"
], - "path": "string"
}
], - "relatedData": [
- {
- "description": "string",
- "interpolationOrder": 0,
- "interpolationValue": "string"
}
]
}| 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) |
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) |
| 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 |
{- "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"
}{- "code": "string",
- "errors": [
- {
- "details": "string",
- "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
- "entityType": "string",
- "errorMessages": [
- {
- "code": "string",
- "message": "string"
}
], - "field": "string",
- "messages": [
- "string"
], - "path": "string"
}
], - "relatedData": [
- {
- "description": "string",
- "interpolationOrder": 0,
- "interpolationValue": "string"
}
]
}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.
Delivery notes to import
required | Array of objects |
{- "deliveryNotes": [
- {
- "contractorCode": "KNT_CODE",
- "deliveryMethod": "DHL",
- "deliveryNoteType": "EXTERNAL",
- "externalCode": "PZ/2023/01/00003",
- "items": [
- {
- "itemNo": 1,
- "productCode": "PROD_CODE_1",
- "productName": "product descriptive name",
- "quantity": 1.15
}
], - "plannedDeliveryDate": "2023-08-24",
- "priority": "Normal",
- "remarks": "Ostro+-nie z palet�� z czarnym stretchem",
- "warehouseCode": "MAG_KRAKOW"
}
]
}{- "code": "string",
- "errors": [
- {
- "details": "string",
- "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
- "entityType": "string",
- "errorMessages": [
- {
- "code": "string",
- "message": "string"
}
], - "field": "string",
- "messages": [
- "string"
], - "path": "string"
}
], - "relatedData": [
- {
- "description": "string",
- "interpolationOrder": 0,
- "interpolationValue": "string"
}
]
}Returns information about import progress. Each imported delivery note will be represented as separate object in the returned array.
| importId required | string <uuid> Import id - can be available from value of |
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); }
[- {
- "contractorCode": "KNT_CODE",
- "contractorExists": false,
- "contractorName": "Example contractor name",
- "contractorTin": "7620850038",
- "deliveryMethod": "DHL",
- "deliveryNoteType": "EXTERNAL",
- "errors": [
- {
- "errorType": ""
}
], - "externalCode": "PZ/2023/01/00003",
- "hasErrors": false,
- "importStatus": "CREATED",
- "items": [
- {
- "isImportError": false,
- "productCode": "PROD_CODE_1",
- "productName": "product descriptive name"
}
], - "plannedDeliveryDate": "2023-08-24",
- "priority": "Normal",
- "remarks": "Ostro+-nie z palet�� z czarnym stretchem",
- "warehouseCode": "MAG_KRAKOW"
}
]Returns delivery notes. Result is paginated.
| acceptedDateFrom | string <date-time> Example: acceptedDateFrom=2025-01-01T00:00:00Z Filters delivery notes accepted after the specified date.
If |
| acceptedDateTo | string <date-time> Example: acceptedDateTo=2025-01-01T00:00:00Z Filters delivery notes accepted before the specified date.
If |
| createdDateFrom | string <date-time> Example: createdDateFrom=2025-01-01T00:00:00Z Filters delivery notes created after the specified date.
If |
| createdDateTo | string <date-time> Example: createdDateTo=2025-01-01T00:00:00Z Filters delivery notes created before the specified date.
If |
| lastModifiedDateFrom | string <date-time> Example: lastModifiedDateFrom=2025-01-01T00:00:00Z Filters delivery notes modified after the specified date.
If |
| lastModifiedDateTo | string <date-time> Example: lastModifiedDateTo=2025-01-01T00:00:00Z Filters delivery notes modified before the specified date.
If |
| 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 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 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 |
| 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 |
| warehouseCode | string Example: warehouseCode=MAG_KRAKOW Warehouse code. If null, the default warehouse will be used. |
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); }
{- "count": 0,
- "items": [
- {
- "acceptedAt": "2023-08-26",
- "contractor": {
- "address": {
- "addressName": "KNT address descriptive name",
- "apartmentNumber": "7",
- "city": "Warszawa",
- "countryCode": "Pan Janek tel. 333 999 999",
- "emailAddress": "example@example.com",
- "houseNumber": "17C",
- "mainPhoneNumber": "222555666",
- "street": "Wrzosowa",
- "zipCode": "33-333"
}, - "code": "KNT_CODE",
- "name": "Example contractor name",
- "tin": "7620850038"
}, - "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"
}
], - "totalCount": 0
}| warehouseCode | string Example: warehouseCode=MAG_KRAKOW Warehouse code. If null, the default warehouse will be used. |
| 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) |
{- "contractorCode": "KNT_CODE",
- "deliveryMethod": "DHL",
- "externalCode": "PZ/2023/01/00003",
- "items": [
- {
- "productCode": "PROD_CODE_1",
- "quantity": 20
}
], - "plannedDeliveryDate": "2023-08-24",
- "priority": "Normal",
- "remarks": "Ostro+-nie z palet�� z czarnym stretchem",
- "type": "EXTERNAL",
- "waybill": "523000013764117057518412"
}{- "code": "string",
- "errors": [
- {
- "details": "string",
- "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
- "entityType": "string",
- "errorMessages": [
- {
- "code": "string",
- "message": "string"
}
], - "field": "string",
- "messages": [
- "string"
], - "path": "string"
}
], - "relatedData": [
- {
- "description": "string",
- "interpolationOrder": 0,
- "interpolationValue": "string"
}
]
}Return delivery note by internal id or 404 Not Found when delivery note with given id does not exist.
| nuboId required | string <uuid> Example: 38dd7a78-3af7-41fc-9477-b019bf84936d Internal id of delivery note in NuboWMS |
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); }
{- "acceptedAt": "2023-08-26",
- "contractor": {
- "address": {
- "addressName": "KNT address descriptive name",
- "apartmentNumber": "7",
- "city": "Warszawa",
- "countryCode": "Pan Janek tel. 333 999 999",
- "emailAddress": "example@example.com",
- "houseNumber": "17C",
- "mainPhoneNumber": "222555666",
- "street": "Wrzosowa",
- "zipCode": "33-333"
}, - "code": "KNT_CODE",
- "name": "Example contractor name",
- "tin": "7620850038"
}, - "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"
}Return delivery note by external code or 404 Not Found when delivery note with given code does not exist.
| externalCode required | string Example: PZ%2F2023%2F01%2F00003 External code that identifies delivery note in NuboWMS (ensure code is URI escaped) |
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); }
{- "acceptedAt": "2023-08-26",
- "contractor": {
- "address": {
- "addressName": "KNT address descriptive name",
- "apartmentNumber": "7",
- "city": "Warszawa",
- "countryCode": "Pan Janek tel. 333 999 999",
- "emailAddress": "example@example.com",
- "houseNumber": "17C",
- "mainPhoneNumber": "222555666",
- "street": "Wrzosowa",
- "zipCode": "33-333"
}, - "code": "KNT_CODE",
- "name": "Example contractor name",
- "tin": "7620850038"
}, - "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"
}| externalCode required | string Example: PZ%2F2023%2F01%2F00003 External code that identifies delivery note in NuboWMS |
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) |
{- "contractorCode": "KNT_CODE",
- "deliveryMethod": "DHL",
- "items": [
- {
- "productCode": "PROD_CODE_1",
- "quantity": 20
}
], - "plannedDeliveryDate": "2023-08-24",
- "priority": "Normal",
- "remarks": "Ostro+-nie z palet�� z czarnym stretchem",
- "type": "EXTERNAL",
- "waybill": "523000013764117057518412"
}{- "code": "string",
- "errors": [
- {
- "details": "string",
- "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
- "entityType": "string",
- "errorMessages": [
- {
- "code": "string",
- "message": "string"
}
], - "field": "string",
- "messages": [
- "string"
], - "path": "string"
}
], - "relatedData": [
- {
- "description": "string",
- "interpolationOrder": 0,
- "interpolationValue": "string"
}
]
}| externalCode required | string Example: PZ%2F2023%2F01%2F00003 External code that identifies delivery note in NuboWMS |
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); }
{- "code": "string",
- "errors": [
- {
- "details": "string",
- "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
- "entityType": "string",
- "errorMessages": [
- {
- "code": "string",
- "message": "string"
}
], - "field": "string",
- "messages": [
- "string"
], - "path": "string"
}
], - "relatedData": [
- {
- "description": "string",
- "interpolationOrder": 0,
- "interpolationValue": "string"
}
]
}Return a complete list of items from the delivery note.
| nuboId required | string <uuid> Example: 38dd7a78-3af7-41fc-9477-b019bf84936d Internal id of delivery note in NuboWMS |
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); }
[- {
- "acceptedQuantity": 9.5,
- "no": 1,
- "productCode": "PROD_CODE_1",
- "productName": "product descriptive name",
- "quantityToAccept": 20,
- "unitOfMeasure": "szt."
}
]Return a complete list of items from the delivery note.
| externalCode required | string Example: PZ%2F2023%2F01%2F00003 External code that identifies delivery note in NuboWMS (ensure code is URI escaped) |
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); }
[- {
- "acceptedQuantity": 9.5,
- "no": 1,
- "productCode": "PROD_CODE_1",
- "productName": "product descriptive name",
- "quantityToAccept": 20,
- "unitOfMeasure": "szt."
}
]Return a list resources (product, traits, quantity) accepted as a result of completing delivery note.
| externalCode required | string Example: PZ%2F2023%2F01%2F00003 External code that identifies delivery note in NuboWMS (ensure code is URI escaped) |
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); }
[- {
- "productCode": "string",
- "productId": "dcd53ddb-8104-4e48-8cc0-5df1088c6113",
- "productName": "string",
- "quantity": 0.1,
- "traitSet": {
- "bestBeforeDate": "2019-08-24",
- "lot": "string",
- "productionDate": "2019-08-24",
- "qualityControlStatus": "OK",
- "serialNumber": "string"
}, - "unitOfMeasureCode": "string"
}
]Currently only cancellation is available.
| externalCode required | string Example: PZ%2F2023%2F01%2F00003 External code that identifies delivery note in NuboWMS |
New status (cancelled)
| status required | string Value: "CANCELED" New delivery note status |
{- "status": "CANCELED"
}{- "code": "string",
- "errors": [
- {
- "details": "string",
- "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
- "entityType": "string",
- "errorMessages": [
- {
- "code": "string",
- "message": "string"
}
], - "field": "string",
- "messages": [
- "string"
], - "path": "string"
}
], - "relatedData": [
- {
- "description": "string",
- "interpolationOrder": 0,
- "interpolationValue": "string"
}
]
}| externalCode required | string Example: PZ%2F2023%2F01%2F00003 External code that identifies delivery note in NuboWMS |
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); }
{- "deliveryNoteStatus": "NEW"
}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.
External releases to import
required | Array of objects |
{- "externalReleases": [
- {
- "contractorCode": "KNT_CODE",
- "contractorName": "Example contractor name",
- "contractorTin": "7620850038",
- "deliveryAddress": {
- "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"
}, - "externalCode": "RO/124/2023",
- "externalReleaseRemarks": "Dodajcie gratis",
- "headquartersAddress": {
- "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"
}, - "items": [
- {
- "itemNo": 1,
- "productCode": "PROD_CODE_1",
- "productName": "product descriptive name",
- "quantity": 1.15
}
], - "plannedShipmentDate": "2023-08-24",
- "priority": "Normal",
- "speditionInformation": {
- "cashOnDeliveryAmount": 52.3,
- "cashOnDeliveryCurrency": "PLN",
- "configurationSetName": "INPOST_PACZKOMAT",
- "pickupPointId": "KRA29A",
- "pickupPointName": "Paczkomat przy Stokrotce",
- "shipmentMethodCode": "Inpost",
- "speditionRemarks": "Paczkomat przy Stokrotce",
- "waybill": "55220144552144"
}, - "type": "EXTERNAL_RELEASE",
- "warehouseCode": "MAG_KRAKOW"
}
]
}{- "code": "string",
- "errors": [
- {
- "details": "string",
- "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
- "entityType": "string",
- "errorMessages": [
- {
- "code": "string",
- "message": "string"
}
], - "field": "string",
- "messages": [
- "string"
], - "path": "string"
}
], - "relatedData": [
- {
- "description": "string",
- "interpolationOrder": 0,
- "interpolationValue": "string"
}
]
}Returns information about import progress. Each imported external release will be represented as separate object in the returned array.
| importId required | string <uuid> Import id - can be available from value of |
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); }
[- {
- "contractorCode": "KNT_CODE",
- "contractorName": "Example contractor name",
- "contractorTin": "7620850038",
- "deliveryAddress": {
- "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",
- "phoneNumber": "string",
- "secondaryPhoneNumber": "333444777",
- "street": "Wrzosowa",
- "zipCode": "33-333"
}, - "errors": [
- {
- "errorType": "PICKUP_ID_NOT_NULL_EMAIL_PHONE_REQUIRED"
}
], - "externalCode": "RO/124/2023",
- "externalReleaseRemarks": "Dodajcie gratis",
- "hasErrors": false,
- "headquartersAddress": {
- "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",
- "phoneNumber": "string",
- "secondaryPhoneNumber": "333444777",
- "street": "Wrzosowa",
- "zipCode": "33-333"
}, - "importStatus": "CREATED",
- "items": [
- {
- "isImportError": false,
- "itemNo": 1,
- "productCode": "PROD_CODE_1",
- "productName": "product descriptive name"
}
], - "plannedShipmentDate": "2023-08-24",
- "priority": "Normal",
- "speditionInformation": {
- "cashOnDeliveryAmount": 52.3,
- "cashOnDeliveryCurrency": "PLN",
- "configurationSetName": "INPOST_PACZKOMAT",
- "pickupPointId": "KRA29A",
- "pickupPointName": "Paczkomat przy Stokrotce",
- "shipmentMethodCode": "Inpost",
- "speditionRemarks": "Paczkomat przy Stokrotce",
- "waybill": "55220144552144"
}, - "type": "EXTERNAL_RELEASE",
- "warehouseCode": "MAG_KRAKOW"
}
]Returns external releases. Result is paginated.
| createdDateFrom | string <date-time> Example: createdDateFrom=2025-01-01T00:00:00Z Filters external releases created after the specified date.
If |
| createdDateTo | string <date-time> Example: createdDateTo=2025-01-01T00:00:00Z Filters external releases created before the specified date.
If |
| issueDateFrom | string <date-time> Example: issueDateFrom=2025-01-01T00:00:00Z Filters external releases accepted after the specified date.
If |
| issueDateTo | string <date-time> Example: issueDateTo=2025-01-01T00:00:00Z Filters external releases accepted before the specified date.
If |
| lastModifiedDateFrom | string <date-time> Example: lastModifiedDateFrom=2025-01-01T00:00:00Z Filters external releases modified after the specified date.
If |
| lastModifiedDateTo | string <date-time> Example: lastModifiedDateTo=2025-01-01T00:00:00Z Filters external releases modified before the specified date.
If |
| 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 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 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 |
| 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 |
| warehouseCode | string Example: warehouseCode=MAG_KRAKOW Warehouse code. If null, the default warehouse will be used. |
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); }
{- "count": 0,
- "items": [
- {
- "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": [
- "string"
]
}
], - "totalCount": 0
}| warehouseCode | string Example: warehouseCode=MAG_KRAKOW Warehouse code. If null, the default warehouse will be used. |
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 |
{- "contractor": {
- "headquarterAddress": {
- "addressName": "KNT delivery addr",
- "apartmentNumber": "7",
- "city": "Warszawa",
- "countryCode": "PL",
- "emailAddress": "example@example.com",
- "houseNumber": "17C",
- "mainPhoneNumber": "222555666",
- "street": "Wrzosowa",
- "zipCode": "33-333"
}, - "name": "Example contractor name",
- "tin": "7620850038"
}, - "contractorCode": "KNT_CODE",
- "deliveryAddress": {
- "addressName": "KNT delivery addr",
- "apartmentNumber": "7",
- "city": "Warszawa",
- "countryCode": "PL",
- "emailAddress": "example@example.com",
- "houseNumber": "17C",
- "mainPhoneNumber": "222555666",
- "street": "Wrzosowa",
- "zipCode": "33-333"
}, - "externalCode": "RO/124/2023",
- "items": [
- {
- "productCode": "PROD_CODE_1",
- "quantity": 20
}
], - "priority": "Normal",
- "remarks": "Dodajcie gratis",
- "shipmentInfo": {
- "cashOnDelivery": {
- "amount": 10.3,
- "currency": "PLN"
}, - "deliverAtSpecificDate": {
- "requestedDeliveryDate": "2019-08-24T14:15:22Z"
}, - "enabledServices": {
- "ACKNOWLEDGEMENT": true,
- "CAREFULLY": true,
- "CONTENT_CHECK": true,
- "DELIVERY_AFTER_17": true,
- "DELIVERY_UP_TO_12": true,
- "DELIVERY_UP_TO_9": true,
- "EMAIL": true,
- "NOT_STANDARD_PARCEL": true,
- "PROOF_OF_DELIVERY": true,
- "ROD": true,
- "SATURDAY_DELIVERY": true,
- "SMS": true
}, - "insurance": {
- "amount": 10.3,
- "currency": "PLN"
}, - "shipmentDate": "2019-08-24T14:15:22Z",
- "shipmentMethodCode": "Inpost",
- "shipmentPickupPointId": "KRA29A",
- "shipmentPickupPointName": "Paczkomat przy Stokrotce",
- "shipmentRemarks": "string",
- "shipmentValue": {
- "amount": 10.3,
- "currency": "PLN"
}, - "waybills": [
- "string"
]
}, - "type": "EXTERNAL_RELEASE"
}{- "code": "string",
- "errors": [
- {
- "details": "string",
- "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
- "entityType": "string",
- "errorMessages": [
- {
- "code": "string",
- "message": "string"
}
], - "field": "string",
- "messages": [
- "string"
], - "path": "string"
}
], - "relatedData": [
- {
- "description": "string",
- "interpolationOrder": 0,
- "interpolationValue": "string"
}
]
}Return external release by nubo internal id or 404 Not Found when external release with given nubo id does not exist.
| nuboId required | string <uuid> Example: 17ab60b6-d9af-4c0b-b109-8881e2357306 Internal id of external release in NuboWMS |
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); }
{- "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": [
- "string"
]
}Return external release by external code or 404 Not Found when external release with given code does not exist.
| externalCode required | string Example: RO%2F124%2F2023 External code that identifies external release in NuboWMS (ensure code is URI escaped) |
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); }
{- "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": [
- "string"
]
}| externalCode required | string Example: RO%2F124%2F2023 External code that identifies external release in NuboWMS |
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" |
{- "contractorCode": "KNT_CODE",
- "deliveryAddress": {
- "addressName": "KNT delivery addr",
- "apartmentNumber": "7",
- "city": "Warszawa",
- "countryCode": "PL",
- "emailAddress": "example@example.com",
- "houseNumber": "17C",
- "mainPhoneNumber": "222555666",
- "street": "Wrzosowa",
- "zipCode": "33-333"
}, - "items": [
- {
- "productCode": "PROD_CODE_1",
- "quantity": 20
}
], - "priority": "Normal",
- "remarks": "Dodajcie gratis",
- "shipmentInfo": {
- "cashOnDelivery": {
- "amount": 10.3,
- "currency": "PLN"
}, - "deliverAtSpecificDate": {
- "requestedDeliveryDate": "2019-08-24T14:15:22Z"
}, - "enabledServices": {
- "ACKNOWLEDGEMENT": true,
- "CAREFULLY": true,
- "CONTENT_CHECK": true,
- "DELIVERY_AFTER_17": true,
- "DELIVERY_UP_TO_12": true,
- "DELIVERY_UP_TO_9": true,
- "EMAIL": true,
- "NOT_STANDARD_PARCEL": true,
- "PROOF_OF_DELIVERY": true,
- "ROD": true,
- "SATURDAY_DELIVERY": true,
- "SMS": true
}, - "insurance": {
- "amount": 10.3,
- "currency": "PLN"
}, - "shipmentDate": "2019-08-24T14:15:22Z",
- "shipmentMethodCode": "Inpost",
- "shipmentPickupPointId": "KRA29A",
- "shipmentPickupPointName": "Paczkomat przy Stokrotce",
- "shipmentRemarks": "string",
- "shipmentValue": {
- "amount": 10.3,
- "currency": "PLN"
}, - "waybills": [
- "string"
]
}, - "type": "EXTERNAL_RELEASE"
}{- "code": "string",
- "errors": [
- {
- "details": "string",
- "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
- "entityType": "string",
- "errorMessages": [
- {
- "code": "string",
- "message": "string"
}
], - "field": "string",
- "messages": [
- "string"
], - "path": "string"
}
], - "relatedData": [
- {
- "description": "string",
- "interpolationOrder": 0,
- "interpolationValue": "string"
}
]
}| externalCode required | string Example: RO%2F124%2F2023 External code that identifies external release in NuboWMS |
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); }
{- "code": "string",
- "errors": [
- {
- "details": "string",
- "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
- "entityType": "string",
- "errorMessages": [
- {
- "code": "string",
- "message": "string"
}
], - "field": "string",
- "messages": [
- "string"
], - "path": "string"
}
], - "relatedData": [
- {
- "description": "string",
- "interpolationOrder": 0,
- "interpolationValue": "string"
}
]
}Return a complete list of items from the external release.
| nuboId required | string <uuid> Example: 17ab60b6-d9af-4c0b-b109-8881e2357306 Internal id of external release in NuboWMS |
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); }
[- {
- "productCode": "PROD_CODE_1",
- "productName": "product descriptive name",
- "quantity": 20,
- "releasedQuantity": 20
}
]Return a complete list of items from the external release.
| externalCode required | string Example: RO%2F124%2F2023 External code that identifies external release in NuboWMS (ensure code is URI escaped) |
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); }
[- {
- "productCode": "PROD_CODE_1",
- "productName": "product descriptive name",
- "quantity": 20,
- "releasedQuantity": 20
}
]Return a list resources (product, traits, quantity) released as a result of completing external release.
| externalCode required | string Example: RO%2F124%2F2023 External code that identifies external release in NuboWMS (ensure code is URI escaped) |
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); }
[- {
- "baseUnitOfMeasureCode": "string",
- "productCode": "string",
- "productId": "dcd53ddb-8104-4e48-8cc0-5df1088c6113",
- "productName": "string",
- "quantity": 0.1,
- "traitSet": {
- "bestBeforeDate": "2019-08-24",
- "lot": "string",
- "productionDate": "2019-08-24",
- "qualityControlStatus": "OK",
- "serialNumber": "string"
}
}
]Currently only cancellation is available.
| externalCode required | string Example: RO%2F124%2F2023 External code that identifies external release in NuboWMS |
New status (cancelled)
| status required | string Value: "Cancelled" |
{- "status": "Cancelled"
}{- "code": "string",
- "errors": [
- {
- "details": "string",
- "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
- "entityType": "string",
- "errorMessages": [
- {
- "code": "string",
- "message": "string"
}
], - "field": "string",
- "messages": [
- "string"
], - "path": "string"
}
], - "relatedData": [
- {
- "description": "string",
- "interpolationOrder": 0,
- "interpolationValue": "string"
}
]
}| externalCode required | string Example: RO%2F124%2F2023 External code that identifies external release in NuboWMS |
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); }
{- "status": "Completed"
}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.
| fileId required | string <uuid> The ID of the image file to retrieve. |
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); }
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.
Products to import
required | Array of objects |
{- "products": [
- {
- "barcode": "978020137962",
- "bestBeforeDateEnabled": false,
- "lotEnabled": false,
- "nonStandardSize": false,
- "productCode": "PROD_CODE_1",
- "productionDateEnabled": false,
- "productName": "product descriptive name",
- "qualityControlEnabled": false,
- "remarks": "delikatne opakownie",
- "serialNumberEnabled": false,
- "unitOfMeasureCode": "szt."
}
]
}{- "code": "string",
- "errors": [
- {
- "details": "string",
- "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
- "entityType": "string",
- "errorMessages": [
- {
- "code": "string",
- "message": "string"
}
], - "field": "string",
- "messages": [
- "string"
], - "path": "string"
}
], - "relatedData": [
- {
- "description": "string",
- "interpolationOrder": 0,
- "interpolationValue": "string"
}
]
}Returns information about import progress. Each imported contractor will be represented as separate object in the returned array.
| importId required | string <uuid> Import id - can be available from value of |
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); }
[- {
- "barcodes": [
- "string"
], - "bestBeforeDateEnabled": true,
- "errors": [
- {
- "errorMessage": "string",
- "errorType": "CREATE_MODE_PRODUCT_EXIST",
- "productImportErrorId": "a3a0cf58-87ba-4b76-af65-b05c799b6471"
}
], - "importId": "84402506-7f34-4409-8ec1-a4e0ffb6b608",
- "importStatus": "CREATED",
- "lotEnabled": true,
- "nonStandardSize": true,
- "productCode": "string",
- "productionDateEnabled": true,
- "productName": "string",
- "qualityControlEnabled": true,
- "remarks": "string",
- "serialNumberEnabled": true,
- "unitOfMeasureCode": "string",
- "unitOfMeasureId": "fd215922-b7a3-49a8-9803-63113a404f96"
}
]Returns products. Result is paginated.
| lastModifiedDateFrom | string <date-time> Example: lastModifiedDateFrom=2025-01-01T00:00:00Z Filters products modified after the specified date.
If |
| 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 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 Default value is 0. |
| productCodes | Array of strings Shows only products with specified codes. |
| searchText | string Example: searchText=ipho Shows only products that includes |
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); }
{- "count": 0,
- "items": [
- {
- "barcodes": 978020137962,
- "code": "PROD_CODE_1",
- "defaultUnitOfMeasureCode": "szt.",
- "dimensions": {
- "depth": 5,
- "height": 15,
- "volume": 750,
- "width": 10
}, - "images": [
- {
- "FileId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
- "IsDefault": true
}
], - "lastModifiedAt": "2019-08-24",
- "name": "product descriptive name",
- "nonStandardSize": false,
- "remarks": "delikatne opakownie",
- "requiredTraits": {
- "bestBeforeDateRequired": false,
- "lotRequired": false,
- "productionDateRequired": false,
- "qualityControlRequired": false,
- "serialNumberRequired": false
}, - "status": "Active",
- "unitOfMeasuresCodes": [
- "string"
], - "weight": {
- "gross": 25.5,
- "net": 24,
- "tare": 1.5
}
}
], - "totalCount": 0
}| 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). |
{- "barcodes": 978020137962,
- "code": "PROD_CODE_1",
- "defaultBarcode": "5901234123457",
- "defaultUnitOfMeasureCode": "szt.",
- "dimensions": {
- "depth": 5,
- "height": 15,
- "volume": 750,
- "width": 10
}, - "name": "product descriptive name",
- "nonStandardSize": false,
- "remarks": "delikatne opakownie",
- "requiredTraits": {
- "bestBeforeDateRequired": false,
- "lotRequired": false,
- "productionDateRequired": false,
- "qualityControlRequired": false,
- "serialNumberRequired": false
}, - "unitOfMeasures": [
- "string"
], - "weight": {
- "gross": 25.5,
- "net": 24,
- "tare": 1.5
}
}{- "code": "string",
- "errors": [
- {
- "details": "string",
- "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
- "entityType": "string",
- "errorMessages": [
- {
- "code": "string",
- "message": "string"
}
], - "field": "string",
- "messages": [
- "string"
], - "path": "string"
}
], - "relatedData": [
- {
- "description": "string",
- "interpolationOrder": 0,
- "interpolationValue": "string"
}
]
}Return product by code or 404 Not Found when product with given code does not exist.
| productCode required | string Example: iphone Product code (ensure code is URI escaped) |
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); }
{- "barcodes": 978020137962,
- "code": "PROD_CODE_1",
- "defaultUnitOfMeasureCode": "szt.",
- "dimensions": {
- "depth": 5,
- "height": 15,
- "volume": 750,
- "width": 10
}, - "images": [
- {
- "FileId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
- "IsDefault": true
}
], - "lastModifiedAt": "2019-08-24",
- "name": "product descriptive name",
- "nonStandardSize": false,
- "remarks": "delikatne opakownie",
- "requiredTraits": {
- "bestBeforeDateRequired": false,
- "lotRequired": false,
- "productionDateRequired": false,
- "qualityControlRequired": false,
- "serialNumberRequired": false
}, - "status": "Active",
- "unitOfMeasuresCodes": [
- "string"
], - "weight": {
- "gross": 25.5,
- "net": 24,
- "tare": 1.5
}
}| productCode required | string Example: iphone Product code (ensure code is URI escaped) |
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). |
{- "barcodes": [
- "string"
], - "defaultBarcode": "5901234123457",
- "defaultUnitOfMeasureCode": "szt.",
- "dimensions": {
- "depth": 5,
- "height": 15,
- "volume": 750,
- "width": 10
}, - "name": "product descriptive name",
- "nonStandardSize": false,
- "remarks": "delikatne opakownie",
- "requiredTraits": {
- "bestBeforeDateRequired": false,
- "lotRequired": false,
- "productionDateRequired": false,
- "qualityControlRequired": false,
- "serialNumberRequired": false
}, - "unitOfMeasures": [
- "string"
], - "weight": {
- "gross": 25.5,
- "net": 24,
- "tare": 1.5
}
}{- "code": "string",
- "errors": [
- {
- "details": "string",
- "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
- "entityType": "string",
- "errorMessages": [
- {
- "code": "string",
- "message": "string"
}
], - "field": "string",
- "messages": [
- "string"
], - "path": "string"
}
], - "relatedData": [
- {
- "description": "string",
- "interpolationOrder": 0,
- "interpolationValue": "string"
}
]
}| productCode required | string Example: iphone Product code (ensure code is URI escaped) |
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); }
{- "code": "string",
- "errors": [
- {
- "details": "string",
- "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
- "entityType": "string",
- "errorMessages": [
- {
- "code": "string",
- "message": "string"
}
], - "field": "string",
- "messages": [
- "string"
], - "path": "string"
}
], - "relatedData": [
- {
- "description": "string",
- "interpolationOrder": 0,
- "interpolationValue": "string"
}
]
}| productCode required | string Example: iphone Product code (ensure code is URI escaped) |
New status
| newStatus required | string Enum: "InActive" "Active" "Archived" |
{- "newStatus": "InActive"
}{- "code": "string",
- "errors": [
- {
- "details": "string",
- "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
- "entityType": "string",
- "errorMessages": [
- {
- "code": "string",
- "message": "string"
}
], - "field": "string",
- "messages": [
- "string"
], - "path": "string"
}
], - "relatedData": [
- {
- "description": "string",
- "interpolationOrder": 0,
- "interpolationValue": "string"
}
]
}| productCode required | string Example: iphone Product code (ensure code is URI escaped) |
New required traits
required | object Required traits for product (NuboWMS will force control for this traits) |
{- "requiredTraits": {
- "bestBeforeDateRequired": false,
- "lotRequired": false,
- "productionDateRequired": false,
- "qualityControlRequired": false,
- "serialNumberRequired": false
}
}{- "code": "string",
- "errors": [
- {
- "details": "string",
- "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
- "entityType": "string",
- "errorMessages": [
- {
- "code": "string",
- "message": "string"
}
], - "field": "string",
- "messages": [
- "string"
], - "path": "string"
}
], - "relatedData": [
- {
- "description": "string",
- "interpolationOrder": 0,
- "interpolationValue": "string"
}
]
}| productCode required | string Example: iphone Product code (ensure code is URI escaped) |
| file required | string <binary> Image file to be added to the product. The file should be uploaded using
the |
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); }
{- "code": "string",
- "errors": [
- {
- "details": "string",
- "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
- "entityType": "string",
- "errorMessages": [
- {
- "code": "string",
- "message": "string"
}
], - "field": "string",
- "messages": [
- "string"
], - "path": "string"
}
], - "relatedData": [
- {
- "description": "string",
- "interpolationOrder": 0,
- "interpolationValue": "string"
}
]
}| 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) |
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); }
{- "code": "string",
- "errors": [
- {
- "details": "string",
- "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
- "entityType": "string",
- "errorMessages": [
- {
- "code": "string",
- "message": "string"
}
], - "field": "string",
- "messages": [
- "string"
], - "path": "string"
}
], - "relatedData": [
- {
- "description": "string",
- "interpolationOrder": 0,
- "interpolationValue": "string"
}
]
}| 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) |
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); }
{- "code": "string",
- "errors": [
- {
- "details": "string",
- "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
- "entityType": "string",
- "errorMessages": [
- {
- "code": "string",
- "message": "string"
}
], - "field": "string",
- "messages": [
- "string"
], - "path": "string"
}
], - "relatedData": [
- {
- "description": "string",
- "interpolationOrder": 0,
- "interpolationValue": "string"
}
]
}Returns stock info (grouped by product id)
| hasStock | boolean Filters stock info based on quantity.
|
| lastModifiedDateFrom | string <date-time> Example: lastModifiedDateFrom=2025-01-01T00:00:00Z Filters stock info modified after the specified date.
If |
| 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 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 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. |
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); }
{- "count": 0,
- "items": [
- {
- "allResourcesAmount": 1000,
- "productCode": "PROD_CODE_1",
- "productName": "product descriptive name",
- "traitSet": {
- "bestBeforeDate": "2019-08-24",
- "lot": "string",
- "productionDate": "2019-08-24",
- "qualityControlStatus": "OK",
- "serialNumber": "string"
}, - "unitOfMeasureCode": "szt."
}
], - "totalCount": 0
}Returns transfers. Result is paginated.
| lastModifiedDateFrom | string <date-time> Example: lastModifiedDateFrom=2025-01-01T00:00:00Z Filters delivery notes modified after the specified date.
If |
| 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 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 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 |
| warehouseCode | string Example: warehouseCode=MAG_KRAKOW Warehouse code. If null, the default warehouse will be used. |
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); }
{- "count": 0,
- "items": [
- {
- "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": {
- "address": {
- "apartmentNumber": "7",
- "buildingNumber": "17C",
- "city": "Warszawa",
- "countryCode": "PL",
- "emailAddress": "example@example.com",
- "mainPhoneNumber": "222555666",
- "street": "Wrzosowa",
- "zipCode": "33-333"
}, - "code": "MAG_KRAKOW",
- "name": "Magazyn Krak+-w"
}, - "remarks": "Dodajcie gratis",
- "shipperWarehouse": {
- "address": {
- "apartmentNumber": "7",
- "buildingNumber": "17C",
- "city": "Warszawa",
- "countryCode": "PL",
- "emailAddress": "example@example.com",
- "mainPhoneNumber": "222555666",
- "street": "Wrzosowa",
- "zipCode": "33-333"
}, - "code": "MAG_KRAKOW",
- "name": "Magazyn Krak+-w"
}, - "status": "PickingInProgress"
}
], - "totalCount": 0
}| warehouseCode | string Example: warehouseCode=MAG_KRAKOW Warehouse code. If null, the default warehouse will be used. |
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 |
{- "externalCode": "RO/124/2023",
- "items": [
- {
- "productCode": "PROD_CODE_1",
- "quantity": 20
}
], - "priority": "Normal",
- "recipientWarehouseCode": "MAG_KATOWICE",
- "remarks": "Dodajcie gratis",
- "shipmentInfo": {
- "cashOnDelivery": {
- "amount": 10.3,
- "currency": "PLN"
}, - "deliverAtSpecificDate": {
- "requestedDeliveryDate": "2019-08-24T14:15:22Z"
}, - "enabledServices": {
- "ACKNOWLEDGEMENT": true,
- "CAREFULLY": true,
- "CONTENT_CHECK": true,
- "DELIVERY_AFTER_17": true,
- "DELIVERY_UP_TO_12": true,
- "DELIVERY_UP_TO_9": true,
- "EMAIL": true,
- "NOT_STANDARD_PARCEL": true,
- "PROOF_OF_DELIVERY": true,
- "ROD": true,
- "SATURDAY_DELIVERY": true,
- "SMS": true
}, - "insurance": {
- "amount": 10.3,
- "currency": "PLN"
}, - "shipmentDate": "2019-08-24T14:15:22Z",
- "shipmentMethodCode": "Inpost",
- "shipmentPickupPointId": "KRA29A",
- "shipmentPickupPointName": "Paczkomat przy Stokrotce",
- "shipmentRemarks": "string",
- "shipmentValue": {
- "amount": 10.3,
- "currency": "PLN"
}, - "waybills": [
- "string"
]
}
}{- "code": "string",
- "errors": [
- {
- "details": "string",
- "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
- "entityType": "string",
- "errorMessages": [
- {
- "code": "string",
- "message": "string"
}
], - "field": "string",
- "messages": [
- "string"
], - "path": "string"
}
], - "relatedData": [
- {
- "description": "string",
- "interpolationOrder": 0,
- "interpolationValue": "string"
}
]
}Return transfer by nubo internal id or 404 Not Found when transfer with given nubo id does not exist.
| nuboId required | string <uuid> Example: 17ab60b6-d9af-4c0b-b109-8881e2357306 Internal id of transfer in NuboWMS |
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); }
{- "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": {
- "address": {
- "apartmentNumber": "7",
- "buildingNumber": "17C",
- "city": "Warszawa",
- "countryCode": "PL",
- "emailAddress": "example@example.com",
- "mainPhoneNumber": "222555666",
- "street": "Wrzosowa",
- "zipCode": "33-333"
}, - "code": "MAG_KRAKOW",
- "name": "Magazyn Krak+-w"
}, - "remarks": "Dodajcie gratis",
- "shipperWarehouse": {
- "address": {
- "apartmentNumber": "7",
- "buildingNumber": "17C",
- "city": "Warszawa",
- "countryCode": "PL",
- "emailAddress": "example@example.com",
- "mainPhoneNumber": "222555666",
- "street": "Wrzosowa",
- "zipCode": "33-333"
}, - "code": "MAG_KRAKOW",
- "name": "Magazyn Krak+-w"
}, - "status": "PickingInProgress"
}Return transfer by external code or 404 Not Found when transfer with given code does not exist.
| externalCode required | string Example: RO%2F124%2F2023 External code that identifies transfer in NuboWMS (ensure code is URI escaped) |
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); }
{- "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": {
- "address": {
- "apartmentNumber": "7",
- "buildingNumber": "17C",
- "city": "Warszawa",
- "countryCode": "PL",
- "emailAddress": "example@example.com",
- "mainPhoneNumber": "222555666",
- "street": "Wrzosowa",
- "zipCode": "33-333"
}, - "code": "MAG_KRAKOW",
- "name": "Magazyn Krak+-w"
}, - "remarks": "Dodajcie gratis",
- "shipperWarehouse": {
- "address": {
- "apartmentNumber": "7",
- "buildingNumber": "17C",
- "city": "Warszawa",
- "countryCode": "PL",
- "emailAddress": "example@example.com",
- "mainPhoneNumber": "222555666",
- "street": "Wrzosowa",
- "zipCode": "33-333"
}, - "code": "MAG_KRAKOW",
- "name": "Magazyn Krak+-w"
}, - "status": "PickingInProgress"
}| externalCode required | string Example: RO%2F124%2F2023 External code that identifies transfer in NuboWMS |
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 |
{- "items": [
- {
- "productCode": "PROD_CODE_1",
- "quantity": 20
}
], - "priority": "Normal",
- "recipientWarehouseCode": "MAG_KATOWICE",
- "remarks": "Dodajcie gratis",
- "shipmentInfo": {
- "cashOnDelivery": {
- "amount": 10.3,
- "currency": "PLN"
}, - "deliverAtSpecificDate": {
- "requestedDeliveryDate": "2019-08-24T14:15:22Z"
}, - "enabledServices": {
- "ACKNOWLEDGEMENT": true,
- "CAREFULLY": true,
- "CONTENT_CHECK": true,
- "DELIVERY_AFTER_17": true,
- "DELIVERY_UP_TO_12": true,
- "DELIVERY_UP_TO_9": true,
- "EMAIL": true,
- "NOT_STANDARD_PARCEL": true,
- "PROOF_OF_DELIVERY": true,
- "ROD": true,
- "SATURDAY_DELIVERY": true,
- "SMS": true
}, - "insurance": {
- "amount": 10.3,
- "currency": "PLN"
}, - "shipmentDate": "2019-08-24T14:15:22Z",
- "shipmentMethodCode": "Inpost",
- "shipmentPickupPointId": "KRA29A",
- "shipmentPickupPointName": "Paczkomat przy Stokrotce",
- "shipmentRemarks": "string",
- "shipmentValue": {
- "amount": 10.3,
- "currency": "PLN"
}, - "waybills": [
- "string"
]
}
}{- "code": "string",
- "errors": [
- {
- "details": "string",
- "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
- "entityType": "string",
- "errorMessages": [
- {
- "code": "string",
- "message": "string"
}
], - "field": "string",
- "messages": [
- "string"
], - "path": "string"
}
], - "relatedData": [
- {
- "description": "string",
- "interpolationOrder": 0,
- "interpolationValue": "string"
}
]
}| externalCode required | string Example: RO%2F124%2F2023 External code that identifies transfer in NuboWMS |
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); }
{- "code": "string",
- "errors": [
- {
- "details": "string",
- "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
- "entityType": "string",
- "errorMessages": [
- {
- "code": "string",
- "message": "string"
}
], - "field": "string",
- "messages": [
- "string"
], - "path": "string"
}
], - "relatedData": [
- {
- "description": "string",
- "interpolationOrder": 0,
- "interpolationValue": "string"
}
]
}Return a complete list of items from the transfer.
| nuboId required | string <uuid> Example: 17ab60b6-d9af-4c0b-b109-8881e2357306 Internal id of transfer in NuboWMS |
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); }
[- {
- "orderedQuantity": 6,
- "productCode": "TWR",
- "productName": "Towar",
- "quantityDisposed": 1,
- "quantityReturnedToShipperWarehouse": 1,
- "receivedQuantity": 3,
- "shippedQuantity": 5,
- "traitSet": {
- "bestBeforeDate": "2019-08-24",
- "lot": "string",
- "productionDate": "2019-08-24",
- "qualityControlStatus": "OK",
- "serialNumber": "string"
}
}
]Return a complete list of items from the transfer.
| externalCode required | string Example: RO%2F124%2F2023 External code that identifies transfer in NuboWMS (ensure code is URI escaped) |
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); }
[- {
- "orderedQuantity": 6,
- "productCode": "TWR",
- "productName": "Towar",
- "quantityDisposed": 1,
- "quantityReturnedToShipperWarehouse": 1,
- "receivedQuantity": 3,
- "shippedQuantity": 5,
- "traitSet": {
- "bestBeforeDate": "2019-08-24",
- "lot": "string",
- "productionDate": "2019-08-24",
- "qualityControlStatus": "OK",
- "serialNumber": "string"
}
}
]Return the status of a transfer by its internal id.
| nuboId required | string <uuid> Example: 17ab60b6-d9af-4c0b-b109-8881e2357306 Internal id of transfer in NuboWMS |
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); }
{- "status": "Completed"
}Currently only cancellation is available.
| externalCode required | string Example: RO%2F124%2F2023 External code that identifies transfer in NuboWMS |
New status (cancelled)
| status required | string Value: "Cancelled" |
{- "status": "Cancelled"
}{- "code": "string",
- "errors": [
- {
- "details": "string",
- "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
- "entityType": "string",
- "errorMessages": [
- {
- "code": "string",
- "message": "string"
}
], - "field": "string",
- "messages": [
- "string"
], - "path": "string"
}
], - "relatedData": [
- {
- "description": "string",
- "interpolationOrder": 0,
- "interpolationValue": "string"
}
]
}| externalCode required | string Example: RO%2F124%2F2023 External code that identifies transfer in NuboWMS |
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); }
{- "status": "Completed"
}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); }
[- {
- "code": "l",
- "name": "litry",
- "precision": 4
}
]Returns available warehouses. Result is paginated.
| lastModifiedDateFrom | string <date-time> Example: lastModifiedDateFrom=2025-01-01T00:00:00Z Filters warehouses modified after the specified date.
If |
| 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 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 Default value is 0. |
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); }
{- "count": 0,
- "items": [
- {
- "code": "MAG_KRK",
- "externalCode": "KRK",
- "name": "Magazyn Krak+-w",
- "status": "ACTIVE",
- "warehouseId": "78a4a188-9d6f-4fdc-9fc9-a412cc429408"
}
], - "totalCount": 0
}Returns warehouse details for the specified warehouse code.
| warehouseCode required | string Warehouse code identifier |
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); }
{- "code": "MAG_KRK",
- "externalCode": "KRK",
- "name": "Magazyn Krak+-w",
- "status": "ACTIVE",
- "warehouseId": "78a4a188-9d6f-4fdc-9fc9-a412cc429408"
}