Alpha Order
API calls concerning orders
Create an order
AuthorizationBearer <token>
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "http://localhost:18080/api/v1/orders" \ -H "Content-Type: application/json" \ -d '{ "products": [ { "price": 0.1, "productId": "string", "quantity": 0.1, "unit": "string" } ], "subsidiaryId": "string" }'{
"cancelledProducts": [
{
"productId": "string",
"quantity": 0.1,
"unit": "string"
}
],
"clientId": "string",
"costValue": 0.1,
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currency": "string",
"deliveryAddress": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"derivedPaymentStatus": "UNPAID",
"directPayments": [
{
"amount": 0.1,
"createdBy": "string",
"currency": "string",
"id": "string",
"note": "string",
"paymentDate": "2019-08-24T14:15:22Z",
"paymentMethod": "CREDIT_CARD",
"receiptAsset": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"receiptGenerated": true,
"reference": "string"
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"expectedDeliveryDate": "2019-08-24T14:15:22Z",
"id": "string",
"internalCancellationReason": "string",
"internalReview": {
"approved": true,
"by": "string",
"on": "2019-08-24T14:15:22Z",
"reason": "string"
},
"invoiceIds": [
"string"
],
"invoicedAmount": 0.1,
"invoicedPercentage": 0.1,
"margin": 0.1,
"orderDate": "2019-08-24T14:15:22Z",
"packages": [
{
"dimension": {
"height": 0.1,
"length": 0.1,
"width": 0.1
},
"location": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"coordinate": {
"latitude": -90,
"longitude": -180
},
"name": "string"
},
"picklistId": "string",
"weight": 0.1
}
],
"paidAmount": 0.1,
"paymentMethod": "CREDIT_CARD",
"paymentPercentage": 0.1,
"paymentTerm": 0,
"picklistIds": [
"string"
],
"productStatus": [
{
"finishedQuantity": 0.1,
"productId": "string",
"quantityCanBeCancelled": 0.1,
"quantityCancelled": 0.1,
"quantityDelivered": 0.1,
"quantityOrdered": 0.1,
"quantityPending": 0.1,
"quantityPicked": 0.1,
"quantityReservedPicklist": 0.1,
"quantityReservedUnassigned": 0.1,
"quantityReturned": 0.1,
"quantityShipped": 0.1,
"returnStarted": true,
"unitPrice": 0.1
}
],
"products": [
{
"applicableDiscount": {
"active": true,
"clientTypes": [
"PERSON"
],
"name": "string",
"regions": [
"string"
],
"volumeThresholds": [
{
"discountPercentage": 1,
"minAmount": 1
}
]
},
"availableStock": 0.1,
"baseUnitConversion": 0.1,
"baseUnitQuantity": 0.1,
"currency": "string",
"discountedPrice": 0.1,
"imageAssets": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"pending": 0.1,
"price": 0.1,
"productCost": 0.1,
"productId": "string",
"productName": "string",
"productType": "RAW_MATERIAL",
"quantity": 0.1,
"quantityCancelled": 0.1,
"quantityDelivered": 0.1,
"quantityInvoiced": 0.1,
"quantityPicked": 0.1,
"quantityRemainingToInvoice": 0.1,
"quantityReturned": 0.1,
"quantityShipped": 0.1,
"reservations": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string",
"siteName": "string"
}
],
"returnStarted": true,
"totalReserved": 0.1,
"unit": "string",
"unitsOfMeasurement": [
{
"baseUnit": true,
"cost": 0.1,
"decimal": true,
"isBaseUnit": true,
"isDecimal": true,
"name": "string",
"quantity": 0.1,
"salesPrice": 0.1,
"unit": "string"
}
]
}
],
"profit": 0.1,
"reference": "string",
"reservationsGroupedBySite": {
"property1": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string",
"siteName": "string"
}
],
"property2": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string",
"siteName": "string"
}
]
},
"reservedProducts": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string",
"siteName": "string"
}
],
"salesValue": 0.1,
"status": "DRAFT",
"subsidiaryId": "string",
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Download Csv_ Order
AuthorizationBearer <token>
In: header
Query Parameters
search?array<>
filters?array<>
page?integer
Default
0Format
int32size?integer
Default
20Format
int32sort?string
Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/orders/csv-export""string"{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Delete a list of entities by their IDs
AuthorizationBearer <token>
In: header
Query Parameters
ids*array<>
Response Body
application/json
application/json
application/json
curl -X DELETE "http://localhost:18080/api/v1/orders/delete-list?ids=string"Empty
{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Dynamic Search_ Order
AuthorizationBearer <token>
In: header
Query Parameters
search?array<>
filters?array<>
page?integer
Default
0Format
int32size?integer
Default
20Format
int32sort?string
Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/orders/dynamic-search"{
"content": [
{
"amountOfProducts": 0.1,
"cachedInvoicePaidAmount": 0.1,
"cachedInvoicedAmount": 0.1,
"cancelledProducts": {
"isNotEmpty": true,
"products": [
{
"productId": "string",
"quantity": 0.1,
"unit": "string"
}
]
},
"clientId": "string",
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currency": "string",
"deliveryAddress": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"directPaymentAmount": 0.1,
"directPayments": [
{
"amount": 0.1,
"createdBy": "string",
"currency": "string",
"id": "string",
"note": "string",
"paymentDate": "2019-08-24T14:15:22Z",
"paymentMethod": "CREDIT_CARD",
"receiptAsset": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"receiptGenerated": true,
"reference": "string"
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"expectedDeliveryDate": "2019-08-24T14:15:22Z",
"id": "string",
"internalCancellationReason": "string",
"internalReview": {
"approved": true,
"by": "string",
"on": "2019-08-24T14:15:22Z",
"reason": "string"
},
"invoiceIds": [
"string"
],
"invoicedProducts": [
{
"invoiceId": "string",
"productId": "string",
"quantityInvoiced": 0.1,
"unit": "string"
}
],
"isFullyCancelled": true,
"isOverdue": true,
"orderDate": "2019-08-24T14:15:22Z",
"packages": [
{
"dimension": {
"height": 0.1,
"length": 0.1,
"width": 0.1
},
"location": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"coordinate": {
"latitude": -90,
"longitude": -180
},
"name": "string"
},
"picklistId": "string",
"weight": 0.1
}
],
"paymentAmount": 0.1,
"paymentMethod": "CREDIT_CARD",
"paymentPercentage": 0.1,
"paymentStatus": "UNPAID",
"paymentTerm": 0,
"picklistIds": [
"string"
],
"products": [
{
"baseUnitConversion": 0.1,
"baseUnitQuantity": 0.1,
"pricePerBaseUnit": 0.1,
"pricePerUnit": 0.1,
"productId": "string",
"quantity": 0.1,
"totalPrice": 0.1,
"unit": "string"
}
],
"reference": "string",
"reservedProducts": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string"
}
],
"salesValue": 0.1,
"status": "DRAFT",
"subsidiaryId": "string",
"tenantId": "string",
"totalAmount": 0.1,
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}
],
"empty": true,
"first": true,
"last": true,
"number": 0,
"numberOfElements": 0,
"pageable": {
"offset": 0,
"pageNumber": 0,
"pageSize": 0,
"paged": true,
"sort": {
"empty": true,
"sorted": true,
"unsorted": true
},
"unpaged": true
},
"size": 0,
"sort": {
"empty": true,
"sorted": true,
"unsorted": true
},
"totalElements": 0,
"totalPages": 0
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Dynamic Search Post_ Order
AuthorizationBearer <token>
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "http://localhost:18080/api/v1/orders/dynamic-search" \ -H "Content-Type: application/json" \ -d '{ "filters": { "property1": null, "property2": null }, "page": 0, "search": [ "string" ], "size": 0, "sort": [ { "ascending": true, "field": "string" } ] }'{
"content": [
{
"amountOfProducts": 0.1,
"cachedInvoicePaidAmount": 0.1,
"cachedInvoicedAmount": 0.1,
"cancelledProducts": {
"isNotEmpty": true,
"products": [
{
"productId": "string",
"quantity": 0.1,
"unit": "string"
}
]
},
"clientId": "string",
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currency": "string",
"deliveryAddress": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"directPaymentAmount": 0.1,
"directPayments": [
{
"amount": 0.1,
"createdBy": "string",
"currency": "string",
"id": "string",
"note": "string",
"paymentDate": "2019-08-24T14:15:22Z",
"paymentMethod": "CREDIT_CARD",
"receiptAsset": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"receiptGenerated": true,
"reference": "string"
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"expectedDeliveryDate": "2019-08-24T14:15:22Z",
"id": "string",
"internalCancellationReason": "string",
"internalReview": {
"approved": true,
"by": "string",
"on": "2019-08-24T14:15:22Z",
"reason": "string"
},
"invoiceIds": [
"string"
],
"invoicedProducts": [
{
"invoiceId": "string",
"productId": "string",
"quantityInvoiced": 0.1,
"unit": "string"
}
],
"isFullyCancelled": true,
"isOverdue": true,
"orderDate": "2019-08-24T14:15:22Z",
"packages": [
{
"dimension": {
"height": 0.1,
"length": 0.1,
"width": 0.1
},
"location": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"coordinate": {
"latitude": -90,
"longitude": -180
},
"name": "string"
},
"picklistId": "string",
"weight": 0.1
}
],
"paymentAmount": 0.1,
"paymentMethod": "CREDIT_CARD",
"paymentPercentage": 0.1,
"paymentStatus": "UNPAID",
"paymentTerm": 0,
"picklistIds": [
"string"
],
"products": [
{
"baseUnitConversion": 0.1,
"baseUnitQuantity": 0.1,
"pricePerBaseUnit": 0.1,
"pricePerUnit": 0.1,
"productId": "string",
"quantity": 0.1,
"totalPrice": 0.1,
"unit": "string"
}
],
"reference": "string",
"reservedProducts": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string"
}
],
"salesValue": 0.1,
"status": "DRAFT",
"subsidiaryId": "string",
"tenantId": "string",
"totalAmount": 0.1,
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}
],
"empty": true,
"first": true,
"last": true,
"number": 0,
"numberOfElements": 0,
"pageable": {
"offset": 0,
"pageNumber": 0,
"pageSize": 0,
"paged": true,
"sort": {
"empty": true,
"sorted": true,
"unsorted": true
},
"unpaged": true
},
"size": 0,
"sort": {
"empty": true,
"sorted": true,
"unsorted": true
},
"totalElements": 0,
"totalPages": 0
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Create a draft order
AuthorizationBearer <token>
In: header
Response Body
application/json
application/json
application/json
application/json
curl -X POST "http://localhost:18080/api/v1/orders/empty"{
"cancelledProducts": [
{
"productId": "string",
"quantity": 0.1,
"unit": "string"
}
],
"clientId": "string",
"costValue": 0.1,
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currency": "string",
"deliveryAddress": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"derivedPaymentStatus": "UNPAID",
"directPayments": [
{
"amount": 0.1,
"createdBy": "string",
"currency": "string",
"id": "string",
"note": "string",
"paymentDate": "2019-08-24T14:15:22Z",
"paymentMethod": "CREDIT_CARD",
"receiptAsset": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"receiptGenerated": true,
"reference": "string"
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"expectedDeliveryDate": "2019-08-24T14:15:22Z",
"id": "string",
"internalCancellationReason": "string",
"internalReview": {
"approved": true,
"by": "string",
"on": "2019-08-24T14:15:22Z",
"reason": "string"
},
"invoiceIds": [
"string"
],
"invoicedAmount": 0.1,
"invoicedPercentage": 0.1,
"margin": 0.1,
"orderDate": "2019-08-24T14:15:22Z",
"packages": [
{
"dimension": {
"height": 0.1,
"length": 0.1,
"width": 0.1
},
"location": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"coordinate": {
"latitude": -90,
"longitude": -180
},
"name": "string"
},
"picklistId": "string",
"weight": 0.1
}
],
"paidAmount": 0.1,
"paymentMethod": "CREDIT_CARD",
"paymentPercentage": 0.1,
"paymentTerm": 0,
"picklistIds": [
"string"
],
"productStatus": [
{
"finishedQuantity": 0.1,
"productId": "string",
"quantityCanBeCancelled": 0.1,
"quantityCancelled": 0.1,
"quantityDelivered": 0.1,
"quantityOrdered": 0.1,
"quantityPending": 0.1,
"quantityPicked": 0.1,
"quantityReservedPicklist": 0.1,
"quantityReservedUnassigned": 0.1,
"quantityReturned": 0.1,
"quantityShipped": 0.1,
"returnStarted": true,
"unitPrice": 0.1
}
],
"products": [
{
"applicableDiscount": {
"active": true,
"clientTypes": [
"PERSON"
],
"name": "string",
"regions": [
"string"
],
"volumeThresholds": [
{
"discountPercentage": 1,
"minAmount": 1
}
]
},
"availableStock": 0.1,
"baseUnitConversion": 0.1,
"baseUnitQuantity": 0.1,
"currency": "string",
"discountedPrice": 0.1,
"imageAssets": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"pending": 0.1,
"price": 0.1,
"productCost": 0.1,
"productId": "string",
"productName": "string",
"productType": "RAW_MATERIAL",
"quantity": 0.1,
"quantityCancelled": 0.1,
"quantityDelivered": 0.1,
"quantityInvoiced": 0.1,
"quantityPicked": 0.1,
"quantityRemainingToInvoice": 0.1,
"quantityReturned": 0.1,
"quantityShipped": 0.1,
"reservations": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string",
"siteName": "string"
}
],
"returnStarted": true,
"totalReserved": 0.1,
"unit": "string",
"unitsOfMeasurement": [
{
"baseUnit": true,
"cost": 0.1,
"decimal": true,
"isBaseUnit": true,
"isDecimal": true,
"name": "string",
"quantity": 0.1,
"salesPrice": 0.1,
"unit": "string"
}
]
}
],
"profit": 0.1,
"reference": "string",
"reservationsGroupedBySite": {
"property1": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string",
"siteName": "string"
}
],
"property2": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string",
"siteName": "string"
}
]
},
"reservedProducts": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string",
"siteName": "string"
}
],
"salesValue": 0.1,
"status": "DRAFT",
"subsidiaryId": "string",
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Find by list of ids in current tenant
AuthorizationBearer <token>
In: header
Query Parameters
ids*array<>
Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/orders/find?ids=string"[
{
"amountOfProducts": 0.1,
"cachedInvoicePaidAmount": 0.1,
"cachedInvoicedAmount": 0.1,
"cancelledProducts": {
"isNotEmpty": true,
"products": [
{
"productId": "string",
"quantity": 0.1,
"unit": "string"
}
]
},
"clientId": "string",
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currency": "string",
"deliveryAddress": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"directPaymentAmount": 0.1,
"directPayments": [
{
"amount": 0.1,
"createdBy": "string",
"currency": "string",
"id": "string",
"note": "string",
"paymentDate": "2019-08-24T14:15:22Z",
"paymentMethod": "CREDIT_CARD",
"receiptAsset": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"receiptGenerated": true,
"reference": "string"
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"expectedDeliveryDate": "2019-08-24T14:15:22Z",
"id": "string",
"internalCancellationReason": "string",
"internalReview": {
"approved": true,
"by": "string",
"on": "2019-08-24T14:15:22Z",
"reason": "string"
},
"invoiceIds": [
"string"
],
"invoicedProducts": [
{
"invoiceId": "string",
"productId": "string",
"quantityInvoiced": 0.1,
"unit": "string"
}
],
"isFullyCancelled": true,
"isOverdue": true,
"orderDate": "2019-08-24T14:15:22Z",
"packages": [
{
"dimension": {
"height": 0.1,
"length": 0.1,
"width": 0.1
},
"location": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"coordinate": {
"latitude": -90,
"longitude": -180
},
"name": "string"
},
"picklistId": "string",
"weight": 0.1
}
],
"paymentAmount": 0.1,
"paymentMethod": "CREDIT_CARD",
"paymentPercentage": 0.1,
"paymentStatus": "UNPAID",
"paymentTerm": 0,
"picklistIds": [
"string"
],
"products": [
{
"baseUnitConversion": 0.1,
"baseUnitQuantity": 0.1,
"pricePerBaseUnit": 0.1,
"pricePerUnit": 0.1,
"productId": "string",
"quantity": 0.1,
"totalPrice": 0.1,
"unit": "string"
}
],
"reference": "string",
"reservedProducts": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string"
}
],
"salesValue": 0.1,
"status": "DRAFT",
"subsidiaryId": "string",
"tenantId": "string",
"totalAmount": 0.1,
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}
]{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Find all for current tenant
AuthorizationBearer <token>
In: header
Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/orders/find-all"[
{
"amountOfProducts": 0.1,
"cachedInvoicePaidAmount": 0.1,
"cachedInvoicedAmount": 0.1,
"cancelledProducts": {
"isNotEmpty": true,
"products": [
{
"productId": "string",
"quantity": 0.1,
"unit": "string"
}
]
},
"clientId": "string",
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currency": "string",
"deliveryAddress": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"directPaymentAmount": 0.1,
"directPayments": [
{
"amount": 0.1,
"createdBy": "string",
"currency": "string",
"id": "string",
"note": "string",
"paymentDate": "2019-08-24T14:15:22Z",
"paymentMethod": "CREDIT_CARD",
"receiptAsset": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"receiptGenerated": true,
"reference": "string"
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"expectedDeliveryDate": "2019-08-24T14:15:22Z",
"id": "string",
"internalCancellationReason": "string",
"internalReview": {
"approved": true,
"by": "string",
"on": "2019-08-24T14:15:22Z",
"reason": "string"
},
"invoiceIds": [
"string"
],
"invoicedProducts": [
{
"invoiceId": "string",
"productId": "string",
"quantityInvoiced": 0.1,
"unit": "string"
}
],
"isFullyCancelled": true,
"isOverdue": true,
"orderDate": "2019-08-24T14:15:22Z",
"packages": [
{
"dimension": {
"height": 0.1,
"length": 0.1,
"width": 0.1
},
"location": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"coordinate": {
"latitude": -90,
"longitude": -180
},
"name": "string"
},
"picklistId": "string",
"weight": 0.1
}
],
"paymentAmount": 0.1,
"paymentMethod": "CREDIT_CARD",
"paymentPercentage": 0.1,
"paymentStatus": "UNPAID",
"paymentTerm": 0,
"picklistIds": [
"string"
],
"products": [
{
"baseUnitConversion": 0.1,
"baseUnitQuantity": 0.1,
"pricePerBaseUnit": 0.1,
"pricePerUnit": 0.1,
"productId": "string",
"quantity": 0.1,
"totalPrice": 0.1,
"unit": "string"
}
],
"reference": "string",
"reservedProducts": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string"
}
],
"salesValue": 0.1,
"status": "DRAFT",
"subsidiaryId": "string",
"tenantId": "string",
"totalAmount": 0.1,
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}
]{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Find orders in range
AuthorizationBearer <token>
In: header
Path Parameters
subsidiaryId*string
start*string
Format
date-timeend*string
Format
date-timeResponse Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/orders/find-in-range/string/2019-08-24T14:15:22Z/2019-08-24T14:15:22Z"[
{
"amountOfProducts": 0.1,
"cachedInvoicePaidAmount": 0.1,
"cachedInvoicedAmount": 0.1,
"cancelledProducts": {
"isNotEmpty": true,
"products": [
{
"productId": "string",
"quantity": 0.1,
"unit": "string"
}
]
},
"clientId": "string",
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currency": "string",
"deliveryAddress": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"directPaymentAmount": 0.1,
"directPayments": [
{
"amount": 0.1,
"createdBy": "string",
"currency": "string",
"id": "string",
"note": "string",
"paymentDate": "2019-08-24T14:15:22Z",
"paymentMethod": "CREDIT_CARD",
"receiptAsset": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"receiptGenerated": true,
"reference": "string"
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"expectedDeliveryDate": "2019-08-24T14:15:22Z",
"id": "string",
"internalCancellationReason": "string",
"internalReview": {
"approved": true,
"by": "string",
"on": "2019-08-24T14:15:22Z",
"reason": "string"
},
"invoiceIds": [
"string"
],
"invoicedProducts": [
{
"invoiceId": "string",
"productId": "string",
"quantityInvoiced": 0.1,
"unit": "string"
}
],
"isFullyCancelled": true,
"isOverdue": true,
"orderDate": "2019-08-24T14:15:22Z",
"packages": [
{
"dimension": {
"height": 0.1,
"length": 0.1,
"width": 0.1
},
"location": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"coordinate": {
"latitude": -90,
"longitude": -180
},
"name": "string"
},
"picklistId": "string",
"weight": 0.1
}
],
"paymentAmount": 0.1,
"paymentMethod": "CREDIT_CARD",
"paymentPercentage": 0.1,
"paymentStatus": "UNPAID",
"paymentTerm": 0,
"picklistIds": [
"string"
],
"products": [
{
"baseUnitConversion": 0.1,
"baseUnitQuantity": 0.1,
"pricePerBaseUnit": 0.1,
"pricePerUnit": 0.1,
"productId": "string",
"quantity": 0.1,
"totalPrice": 0.1,
"unit": "string"
}
],
"reference": "string",
"reservedProducts": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string"
}
],
"salesValue": 0.1,
"status": "DRAFT",
"subsidiaryId": "string",
"tenantId": "string",
"totalAmount": 0.1,
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}
]{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Find a list of entities by their IDs
AuthorizationBearer <token>
In: header
Query Parameters
ids?array<>
Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/orders/find-list"[
{
"amountOfProducts": 0.1,
"cachedInvoicePaidAmount": 0.1,
"cachedInvoicedAmount": 0.1,
"cancelledProducts": {
"isNotEmpty": true,
"products": [
{
"productId": "string",
"quantity": 0.1,
"unit": "string"
}
]
},
"clientId": "string",
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currency": "string",
"deliveryAddress": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"directPaymentAmount": 0.1,
"directPayments": [
{
"amount": 0.1,
"createdBy": "string",
"currency": "string",
"id": "string",
"note": "string",
"paymentDate": "2019-08-24T14:15:22Z",
"paymentMethod": "CREDIT_CARD",
"receiptAsset": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"receiptGenerated": true,
"reference": "string"
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"expectedDeliveryDate": "2019-08-24T14:15:22Z",
"id": "string",
"internalCancellationReason": "string",
"internalReview": {
"approved": true,
"by": "string",
"on": "2019-08-24T14:15:22Z",
"reason": "string"
},
"invoiceIds": [
"string"
],
"invoicedProducts": [
{
"invoiceId": "string",
"productId": "string",
"quantityInvoiced": 0.1,
"unit": "string"
}
],
"isFullyCancelled": true,
"isOverdue": true,
"orderDate": "2019-08-24T14:15:22Z",
"packages": [
{
"dimension": {
"height": 0.1,
"length": 0.1,
"width": 0.1
},
"location": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"coordinate": {
"latitude": -90,
"longitude": -180
},
"name": "string"
},
"picklistId": "string",
"weight": 0.1
}
],
"paymentAmount": 0.1,
"paymentMethod": "CREDIT_CARD",
"paymentPercentage": 0.1,
"paymentStatus": "UNPAID",
"paymentTerm": 0,
"picklistIds": [
"string"
],
"products": [
{
"baseUnitConversion": 0.1,
"baseUnitQuantity": 0.1,
"pricePerBaseUnit": 0.1,
"pricePerUnit": 0.1,
"productId": "string",
"quantity": 0.1,
"totalPrice": 0.1,
"unit": "string"
}
],
"reference": "string",
"reservedProducts": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string"
}
],
"salesValue": 0.1,
"status": "DRAFT",
"subsidiaryId": "string",
"tenantId": "string",
"totalAmount": 0.1,
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}
]{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Find by id in current tenant
AuthorizationBearer <token>
In: header
Path Parameters
id*string
Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/orders/find/string"{
"amountOfProducts": 0.1,
"cachedInvoicePaidAmount": 0.1,
"cachedInvoicedAmount": 0.1,
"cancelledProducts": {
"isNotEmpty": true,
"products": [
{
"productId": "string",
"quantity": 0.1,
"unit": "string"
}
]
},
"clientId": "string",
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currency": "string",
"deliveryAddress": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"directPaymentAmount": 0.1,
"directPayments": [
{
"amount": 0.1,
"createdBy": "string",
"currency": "string",
"id": "string",
"note": "string",
"paymentDate": "2019-08-24T14:15:22Z",
"paymentMethod": "CREDIT_CARD",
"receiptAsset": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"receiptGenerated": true,
"reference": "string"
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"expectedDeliveryDate": "2019-08-24T14:15:22Z",
"id": "string",
"internalCancellationReason": "string",
"internalReview": {
"approved": true,
"by": "string",
"on": "2019-08-24T14:15:22Z",
"reason": "string"
},
"invoiceIds": [
"string"
],
"invoicedProducts": [
{
"invoiceId": "string",
"productId": "string",
"quantityInvoiced": 0.1,
"unit": "string"
}
],
"isFullyCancelled": true,
"isOverdue": true,
"orderDate": "2019-08-24T14:15:22Z",
"packages": [
{
"dimension": {
"height": 0.1,
"length": 0.1,
"width": 0.1
},
"location": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"coordinate": {
"latitude": -90,
"longitude": -180
},
"name": "string"
},
"picklistId": "string",
"weight": 0.1
}
],
"paymentAmount": 0.1,
"paymentMethod": "CREDIT_CARD",
"paymentPercentage": 0.1,
"paymentStatus": "UNPAID",
"paymentTerm": 0,
"picklistIds": [
"string"
],
"products": [
{
"baseUnitConversion": 0.1,
"baseUnitQuantity": 0.1,
"pricePerBaseUnit": 0.1,
"pricePerUnit": 0.1,
"productId": "string",
"quantity": 0.1,
"totalPrice": 0.1,
"unit": "string"
}
],
"reference": "string",
"reservedProducts": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string"
}
],
"salesValue": 0.1,
"status": "DRAFT",
"subsidiaryId": "string",
"tenantId": "string",
"totalAmount": 0.1,
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Get page by page number and size with optional sorting based on field to sortBy and direction
AuthorizationBearer <token>
In: header
Query Parameters
pageNumber?integer
Format
int32pageSize?integer
Format
int32sortBy?string
direction?string
Value in
"ASC" | "DESC"search?string
Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/orders/page"{
"content": [
{
"amountOfProducts": 0.1,
"cachedInvoicePaidAmount": 0.1,
"cachedInvoicedAmount": 0.1,
"cancelledProducts": {
"isNotEmpty": true,
"products": [
{
"productId": "string",
"quantity": 0.1,
"unit": "string"
}
]
},
"clientId": "string",
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currency": "string",
"deliveryAddress": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"directPaymentAmount": 0.1,
"directPayments": [
{
"amount": 0.1,
"createdBy": "string",
"currency": "string",
"id": "string",
"note": "string",
"paymentDate": "2019-08-24T14:15:22Z",
"paymentMethod": "CREDIT_CARD",
"receiptAsset": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"receiptGenerated": true,
"reference": "string"
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"expectedDeliveryDate": "2019-08-24T14:15:22Z",
"id": "string",
"internalCancellationReason": "string",
"internalReview": {
"approved": true,
"by": "string",
"on": "2019-08-24T14:15:22Z",
"reason": "string"
},
"invoiceIds": [
"string"
],
"invoicedProducts": [
{
"invoiceId": "string",
"productId": "string",
"quantityInvoiced": 0.1,
"unit": "string"
}
],
"isFullyCancelled": true,
"isOverdue": true,
"orderDate": "2019-08-24T14:15:22Z",
"packages": [
{
"dimension": {
"height": 0.1,
"length": 0.1,
"width": 0.1
},
"location": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"coordinate": {
"latitude": -90,
"longitude": -180
},
"name": "string"
},
"picklistId": "string",
"weight": 0.1
}
],
"paymentAmount": 0.1,
"paymentMethod": "CREDIT_CARD",
"paymentPercentage": 0.1,
"paymentStatus": "UNPAID",
"paymentTerm": 0,
"picklistIds": [
"string"
],
"products": [
{
"baseUnitConversion": 0.1,
"baseUnitQuantity": 0.1,
"pricePerBaseUnit": 0.1,
"pricePerUnit": 0.1,
"productId": "string",
"quantity": 0.1,
"totalPrice": 0.1,
"unit": "string"
}
],
"reference": "string",
"reservedProducts": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string"
}
],
"salesValue": 0.1,
"status": "DRAFT",
"subsidiaryId": "string",
"tenantId": "string",
"totalAmount": 0.1,
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}
],
"empty": true,
"first": true,
"last": true,
"number": 0,
"numberOfElements": 0,
"pageable": {
"offset": 0,
"pageNumber": 0,
"pageSize": 0,
"paged": true,
"sort": {
"empty": true,
"sorted": true,
"unsorted": true
},
"unpaged": true
},
"size": 0,
"sort": {
"empty": true,
"sorted": true,
"unsorted": true
},
"totalElements": 0,
"totalPages": 0
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Get order statistics
AuthorizationBearer <token>
In: header
Query Parameters
subsidiaryId?string
startDate?string
Format
date-timeendDate?string
Format
date-timeResponse Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/orders/stats"{
"averageOrderValue": 0.1,
"orderByStatus": {
"property1": 0,
"property2": 0
},
"topClients": [
{
"averageOrderValue": 0.1,
"clientAvatar": {
"blobId": "string",
"height": 0,
"thumbnailBlobId": "string",
"width": 0
},
"clientId": "string",
"clientName": "string",
"totalAmount": 0.1,
"totalOrders": 0
}
],
"topProducts": [
{
"productId": "string",
"productInfo": {
"brand": "string",
"category": "string",
"description": "string",
"imageBlobId": "string",
"name": "string",
"productId": "string",
"salesPrice": 0.1,
"stockInfo": {
"amountAvailable": 0.1,
"amountReserved": 0.1,
"baseUnit": {
"baseUnit": true,
"cost": 0.1,
"decimal": true,
"isBaseUnit": true,
"isDecimal": true,
"name": "string",
"quantity": 0.1,
"salesPrice": 0.1,
"unit": "string"
},
"currency": "string",
"destinationProductInfo": {
"amountAvailable": 0.1,
"amountReserved": 0.1,
"maximum": 0.1,
"minimum": 0.1,
"stockSiteId": "string",
"stockSiteName": "string",
"totalAmount": 0.1
},
"imageBlobId": "string",
"maximum": 0.1,
"minimum": 0.1,
"productId": "string",
"productName": "string",
"productType": "RAW_MATERIAL",
"salesPrice": 0.1,
"stockSiteId": "string",
"stockSiteName": "string",
"subsidiaryId": "string",
"totalAmount": 0.1,
"unitPrice": 0.1,
"unitsOfMeasurement": [
{
"baseUnit": true,
"cost": 0.1,
"decimal": true,
"isBaseUnit": true,
"isDecimal": true,
"name": "string",
"quantity": 0.1,
"salesPrice": 0.1,
"unit": "string"
}
]
},
"unitPrice": 0.1,
"unitsOfMeasurement": [
{
"baseUnit": true,
"cost": 0.1,
"decimal": true,
"isBaseUnit": true,
"isDecimal": true,
"name": "string",
"quantity": 0.1,
"salesPrice": 0.1,
"unit": "string"
}
]
},
"totalPrice": 0.1,
"totalQuantity": 0.1
}
],
"totalAmount": 0.1,
"totalOrders": 0
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Get Enriched Order
AuthorizationBearer <token>
In: header
Path Parameters
id*string
Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/orders/string"{
"cancelledProducts": [
{
"productId": "string",
"quantity": 0.1,
"unit": "string"
}
],
"clientId": "string",
"costValue": 0.1,
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currency": "string",
"deliveryAddress": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"derivedPaymentStatus": "UNPAID",
"directPayments": [
{
"amount": 0.1,
"createdBy": "string",
"currency": "string",
"id": "string",
"note": "string",
"paymentDate": "2019-08-24T14:15:22Z",
"paymentMethod": "CREDIT_CARD",
"receiptAsset": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"receiptGenerated": true,
"reference": "string"
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"expectedDeliveryDate": "2019-08-24T14:15:22Z",
"id": "string",
"internalCancellationReason": "string",
"internalReview": {
"approved": true,
"by": "string",
"on": "2019-08-24T14:15:22Z",
"reason": "string"
},
"invoiceIds": [
"string"
],
"invoicedAmount": 0.1,
"invoicedPercentage": 0.1,
"margin": 0.1,
"orderDate": "2019-08-24T14:15:22Z",
"packages": [
{
"dimension": {
"height": 0.1,
"length": 0.1,
"width": 0.1
},
"location": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"coordinate": {
"latitude": -90,
"longitude": -180
},
"name": "string"
},
"picklistId": "string",
"weight": 0.1
}
],
"paidAmount": 0.1,
"paymentMethod": "CREDIT_CARD",
"paymentPercentage": 0.1,
"paymentTerm": 0,
"picklistIds": [
"string"
],
"productStatus": [
{
"finishedQuantity": 0.1,
"productId": "string",
"quantityCanBeCancelled": 0.1,
"quantityCancelled": 0.1,
"quantityDelivered": 0.1,
"quantityOrdered": 0.1,
"quantityPending": 0.1,
"quantityPicked": 0.1,
"quantityReservedPicklist": 0.1,
"quantityReservedUnassigned": 0.1,
"quantityReturned": 0.1,
"quantityShipped": 0.1,
"returnStarted": true,
"unitPrice": 0.1
}
],
"products": [
{
"applicableDiscount": {
"active": true,
"clientTypes": [
"PERSON"
],
"name": "string",
"regions": [
"string"
],
"volumeThresholds": [
{
"discountPercentage": 1,
"minAmount": 1
}
]
},
"availableStock": 0.1,
"baseUnitConversion": 0.1,
"baseUnitQuantity": 0.1,
"currency": "string",
"discountedPrice": 0.1,
"imageAssets": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"pending": 0.1,
"price": 0.1,
"productCost": 0.1,
"productId": "string",
"productName": "string",
"productType": "RAW_MATERIAL",
"quantity": 0.1,
"quantityCancelled": 0.1,
"quantityDelivered": 0.1,
"quantityInvoiced": 0.1,
"quantityPicked": 0.1,
"quantityRemainingToInvoice": 0.1,
"quantityReturned": 0.1,
"quantityShipped": 0.1,
"reservations": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string",
"siteName": "string"
}
],
"returnStarted": true,
"totalReserved": 0.1,
"unit": "string",
"unitsOfMeasurement": [
{
"baseUnit": true,
"cost": 0.1,
"decimal": true,
"isBaseUnit": true,
"isDecimal": true,
"name": "string",
"quantity": 0.1,
"salesPrice": 0.1,
"unit": "string"
}
]
}
],
"profit": 0.1,
"reference": "string",
"reservationsGroupedBySite": {
"property1": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string",
"siteName": "string"
}
],
"property2": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string",
"siteName": "string"
}
]
},
"reservedProducts": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string",
"siteName": "string"
}
],
"salesValue": 0.1,
"status": "DRAFT",
"subsidiaryId": "string",
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Update an order
AuthorizationBearer <token>
In: header
Path Parameters
id*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X PATCH "http://localhost:18080/api/v1/orders/string" \ -H "Content-Type: application/json" \ -d '{ "products": [ { "price": 0.1, "productId": "string", "quantity": 0.1, "unit": "string" } ], "subsidiaryId": "string" }'{
"cancelledProducts": [
{
"productId": "string",
"quantity": 0.1,
"unit": "string"
}
],
"clientId": "string",
"costValue": 0.1,
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currency": "string",
"deliveryAddress": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"derivedPaymentStatus": "UNPAID",
"directPayments": [
{
"amount": 0.1,
"createdBy": "string",
"currency": "string",
"id": "string",
"note": "string",
"paymentDate": "2019-08-24T14:15:22Z",
"paymentMethod": "CREDIT_CARD",
"receiptAsset": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"receiptGenerated": true,
"reference": "string"
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"expectedDeliveryDate": "2019-08-24T14:15:22Z",
"id": "string",
"internalCancellationReason": "string",
"internalReview": {
"approved": true,
"by": "string",
"on": "2019-08-24T14:15:22Z",
"reason": "string"
},
"invoiceIds": [
"string"
],
"invoicedAmount": 0.1,
"invoicedPercentage": 0.1,
"margin": 0.1,
"orderDate": "2019-08-24T14:15:22Z",
"packages": [
{
"dimension": {
"height": 0.1,
"length": 0.1,
"width": 0.1
},
"location": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"coordinate": {
"latitude": -90,
"longitude": -180
},
"name": "string"
},
"picklistId": "string",
"weight": 0.1
}
],
"paidAmount": 0.1,
"paymentMethod": "CREDIT_CARD",
"paymentPercentage": 0.1,
"paymentTerm": 0,
"picklistIds": [
"string"
],
"productStatus": [
{
"finishedQuantity": 0.1,
"productId": "string",
"quantityCanBeCancelled": 0.1,
"quantityCancelled": 0.1,
"quantityDelivered": 0.1,
"quantityOrdered": 0.1,
"quantityPending": 0.1,
"quantityPicked": 0.1,
"quantityReservedPicklist": 0.1,
"quantityReservedUnassigned": 0.1,
"quantityReturned": 0.1,
"quantityShipped": 0.1,
"returnStarted": true,
"unitPrice": 0.1
}
],
"products": [
{
"applicableDiscount": {
"active": true,
"clientTypes": [
"PERSON"
],
"name": "string",
"regions": [
"string"
],
"volumeThresholds": [
{
"discountPercentage": 1,
"minAmount": 1
}
]
},
"availableStock": 0.1,
"baseUnitConversion": 0.1,
"baseUnitQuantity": 0.1,
"currency": "string",
"discountedPrice": 0.1,
"imageAssets": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"pending": 0.1,
"price": 0.1,
"productCost": 0.1,
"productId": "string",
"productName": "string",
"productType": "RAW_MATERIAL",
"quantity": 0.1,
"quantityCancelled": 0.1,
"quantityDelivered": 0.1,
"quantityInvoiced": 0.1,
"quantityPicked": 0.1,
"quantityRemainingToInvoice": 0.1,
"quantityReturned": 0.1,
"quantityShipped": 0.1,
"reservations": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string",
"siteName": "string"
}
],
"returnStarted": true,
"totalReserved": 0.1,
"unit": "string",
"unitsOfMeasurement": [
{
"baseUnit": true,
"cost": 0.1,
"decimal": true,
"isBaseUnit": true,
"isDecimal": true,
"name": "string",
"quantity": 0.1,
"salesPrice": 0.1,
"unit": "string"
}
]
}
],
"profit": 0.1,
"reference": "string",
"reservationsGroupedBySite": {
"property1": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string",
"siteName": "string"
}
],
"property2": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string",
"siteName": "string"
}
]
},
"reservedProducts": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string",
"siteName": "string"
}
],
"salesValue": 0.1,
"status": "DRAFT",
"subsidiaryId": "string",
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Delete by id in current tenant
AuthorizationBearer <token>
In: header
Path Parameters
id*string
Response Body
application/json
application/json
application/json
curl -X DELETE "http://localhost:18080/api/v1/orders/string"Empty
{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Add or update package details
AuthorizationBearer <token>
In: header
Path Parameters
id*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "http://localhost:18080/api/v1/orders/string/add-package-details" \ -H "Content-Type: application/json" \ -d '{ "dimension": { "height": 0.1, "length": 0.1, "width": 0.1 }, "picklistId": "string", "weight": 0.1 }'{
"cancelledProducts": [
{
"productId": "string",
"quantity": 0.1,
"unit": "string"
}
],
"clientId": "string",
"costValue": 0.1,
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currency": "string",
"deliveryAddress": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"derivedPaymentStatus": "UNPAID",
"directPayments": [
{
"amount": 0.1,
"createdBy": "string",
"currency": "string",
"id": "string",
"note": "string",
"paymentDate": "2019-08-24T14:15:22Z",
"paymentMethod": "CREDIT_CARD",
"receiptAsset": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"receiptGenerated": true,
"reference": "string"
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"expectedDeliveryDate": "2019-08-24T14:15:22Z",
"id": "string",
"internalCancellationReason": "string",
"internalReview": {
"approved": true,
"by": "string",
"on": "2019-08-24T14:15:22Z",
"reason": "string"
},
"invoiceIds": [
"string"
],
"invoicedAmount": 0.1,
"invoicedPercentage": 0.1,
"margin": 0.1,
"orderDate": "2019-08-24T14:15:22Z",
"packages": [
{
"dimension": {
"height": 0.1,
"length": 0.1,
"width": 0.1
},
"location": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"coordinate": {
"latitude": -90,
"longitude": -180
},
"name": "string"
},
"picklistId": "string",
"weight": 0.1
}
],
"paidAmount": 0.1,
"paymentMethod": "CREDIT_CARD",
"paymentPercentage": 0.1,
"paymentTerm": 0,
"picklistIds": [
"string"
],
"productStatus": [
{
"finishedQuantity": 0.1,
"productId": "string",
"quantityCanBeCancelled": 0.1,
"quantityCancelled": 0.1,
"quantityDelivered": 0.1,
"quantityOrdered": 0.1,
"quantityPending": 0.1,
"quantityPicked": 0.1,
"quantityReservedPicklist": 0.1,
"quantityReservedUnassigned": 0.1,
"quantityReturned": 0.1,
"quantityShipped": 0.1,
"returnStarted": true,
"unitPrice": 0.1
}
],
"products": [
{
"applicableDiscount": {
"active": true,
"clientTypes": [
"PERSON"
],
"name": "string",
"regions": [
"string"
],
"volumeThresholds": [
{
"discountPercentage": 1,
"minAmount": 1
}
]
},
"availableStock": 0.1,
"baseUnitConversion": 0.1,
"baseUnitQuantity": 0.1,
"currency": "string",
"discountedPrice": 0.1,
"imageAssets": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"pending": 0.1,
"price": 0.1,
"productCost": 0.1,
"productId": "string",
"productName": "string",
"productType": "RAW_MATERIAL",
"quantity": 0.1,
"quantityCancelled": 0.1,
"quantityDelivered": 0.1,
"quantityInvoiced": 0.1,
"quantityPicked": 0.1,
"quantityRemainingToInvoice": 0.1,
"quantityReturned": 0.1,
"quantityShipped": 0.1,
"reservations": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string",
"siteName": "string"
}
],
"returnStarted": true,
"totalReserved": 0.1,
"unit": "string",
"unitsOfMeasurement": [
{
"baseUnit": true,
"cost": 0.1,
"decimal": true,
"isBaseUnit": true,
"isDecimal": true,
"name": "string",
"quantity": 0.1,
"salesPrice": 0.1,
"unit": "string"
}
]
}
],
"profit": 0.1,
"reference": "string",
"reservationsGroupedBySite": {
"property1": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string",
"siteName": "string"
}
],
"property2": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string",
"siteName": "string"
}
]
},
"reservedProducts": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string",
"siteName": "string"
}
],
"salesValue": 0.1,
"status": "DRAFT",
"subsidiaryId": "string",
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Approve an order
AuthorizationBearer <token>
In: header
Path Parameters
id*string
Response Body
application/json
application/json
application/json
application/json
curl -X PATCH "http://localhost:18080/api/v1/orders/string/approve"{
"cancelledProducts": [
{
"productId": "string",
"quantity": 0.1,
"unit": "string"
}
],
"clientId": "string",
"costValue": 0.1,
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currency": "string",
"deliveryAddress": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"derivedPaymentStatus": "UNPAID",
"directPayments": [
{
"amount": 0.1,
"createdBy": "string",
"currency": "string",
"id": "string",
"note": "string",
"paymentDate": "2019-08-24T14:15:22Z",
"paymentMethod": "CREDIT_CARD",
"receiptAsset": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"receiptGenerated": true,
"reference": "string"
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"expectedDeliveryDate": "2019-08-24T14:15:22Z",
"id": "string",
"internalCancellationReason": "string",
"internalReview": {
"approved": true,
"by": "string",
"on": "2019-08-24T14:15:22Z",
"reason": "string"
},
"invoiceIds": [
"string"
],
"invoicedAmount": 0.1,
"invoicedPercentage": 0.1,
"margin": 0.1,
"orderDate": "2019-08-24T14:15:22Z",
"packages": [
{
"dimension": {
"height": 0.1,
"length": 0.1,
"width": 0.1
},
"location": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"coordinate": {
"latitude": -90,
"longitude": -180
},
"name": "string"
},
"picklistId": "string",
"weight": 0.1
}
],
"paidAmount": 0.1,
"paymentMethod": "CREDIT_CARD",
"paymentPercentage": 0.1,
"paymentTerm": 0,
"picklistIds": [
"string"
],
"productStatus": [
{
"finishedQuantity": 0.1,
"productId": "string",
"quantityCanBeCancelled": 0.1,
"quantityCancelled": 0.1,
"quantityDelivered": 0.1,
"quantityOrdered": 0.1,
"quantityPending": 0.1,
"quantityPicked": 0.1,
"quantityReservedPicklist": 0.1,
"quantityReservedUnassigned": 0.1,
"quantityReturned": 0.1,
"quantityShipped": 0.1,
"returnStarted": true,
"unitPrice": 0.1
}
],
"products": [
{
"applicableDiscount": {
"active": true,
"clientTypes": [
"PERSON"
],
"name": "string",
"regions": [
"string"
],
"volumeThresholds": [
{
"discountPercentage": 1,
"minAmount": 1
}
]
},
"availableStock": 0.1,
"baseUnitConversion": 0.1,
"baseUnitQuantity": 0.1,
"currency": "string",
"discountedPrice": 0.1,
"imageAssets": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"pending": 0.1,
"price": 0.1,
"productCost": 0.1,
"productId": "string",
"productName": "string",
"productType": "RAW_MATERIAL",
"quantity": 0.1,
"quantityCancelled": 0.1,
"quantityDelivered": 0.1,
"quantityInvoiced": 0.1,
"quantityPicked": 0.1,
"quantityRemainingToInvoice": 0.1,
"quantityReturned": 0.1,
"quantityShipped": 0.1,
"reservations": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string",
"siteName": "string"
}
],
"returnStarted": true,
"totalReserved": 0.1,
"unit": "string",
"unitsOfMeasurement": [
{
"baseUnit": true,
"cost": 0.1,
"decimal": true,
"isBaseUnit": true,
"isDecimal": true,
"name": "string",
"quantity": 0.1,
"salesPrice": 0.1,
"unit": "string"
}
]
}
],
"profit": 0.1,
"reference": "string",
"reservationsGroupedBySite": {
"property1": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string",
"siteName": "string"
}
],
"property2": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string",
"siteName": "string"
}
]
},
"reservedProducts": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string",
"siteName": "string"
}
],
"salesValue": 0.1,
"status": "DRAFT",
"subsidiaryId": "string",
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Cancel full order by customer
AuthorizationBearer <token>
In: header
Path Parameters
id*string
Response Body
application/json
application/json
application/json
application/json
curl -X PATCH "http://localhost:18080/api/v1/orders/string/cancel-by-customer"{
"cancelledProducts": [
{
"productId": "string",
"quantity": 0.1,
"unit": "string"
}
],
"clientId": "string",
"costValue": 0.1,
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currency": "string",
"deliveryAddress": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"derivedPaymentStatus": "UNPAID",
"directPayments": [
{
"amount": 0.1,
"createdBy": "string",
"currency": "string",
"id": "string",
"note": "string",
"paymentDate": "2019-08-24T14:15:22Z",
"paymentMethod": "CREDIT_CARD",
"receiptAsset": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"receiptGenerated": true,
"reference": "string"
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"expectedDeliveryDate": "2019-08-24T14:15:22Z",
"id": "string",
"internalCancellationReason": "string",
"internalReview": {
"approved": true,
"by": "string",
"on": "2019-08-24T14:15:22Z",
"reason": "string"
},
"invoiceIds": [
"string"
],
"invoicedAmount": 0.1,
"invoicedPercentage": 0.1,
"margin": 0.1,
"orderDate": "2019-08-24T14:15:22Z",
"packages": [
{
"dimension": {
"height": 0.1,
"length": 0.1,
"width": 0.1
},
"location": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"coordinate": {
"latitude": -90,
"longitude": -180
},
"name": "string"
},
"picklistId": "string",
"weight": 0.1
}
],
"paidAmount": 0.1,
"paymentMethod": "CREDIT_CARD",
"paymentPercentage": 0.1,
"paymentTerm": 0,
"picklistIds": [
"string"
],
"productStatus": [
{
"finishedQuantity": 0.1,
"productId": "string",
"quantityCanBeCancelled": 0.1,
"quantityCancelled": 0.1,
"quantityDelivered": 0.1,
"quantityOrdered": 0.1,
"quantityPending": 0.1,
"quantityPicked": 0.1,
"quantityReservedPicklist": 0.1,
"quantityReservedUnassigned": 0.1,
"quantityReturned": 0.1,
"quantityShipped": 0.1,
"returnStarted": true,
"unitPrice": 0.1
}
],
"products": [
{
"applicableDiscount": {
"active": true,
"clientTypes": [
"PERSON"
],
"name": "string",
"regions": [
"string"
],
"volumeThresholds": [
{
"discountPercentage": 1,
"minAmount": 1
}
]
},
"availableStock": 0.1,
"baseUnitConversion": 0.1,
"baseUnitQuantity": 0.1,
"currency": "string",
"discountedPrice": 0.1,
"imageAssets": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"pending": 0.1,
"price": 0.1,
"productCost": 0.1,
"productId": "string",
"productName": "string",
"productType": "RAW_MATERIAL",
"quantity": 0.1,
"quantityCancelled": 0.1,
"quantityDelivered": 0.1,
"quantityInvoiced": 0.1,
"quantityPicked": 0.1,
"quantityRemainingToInvoice": 0.1,
"quantityReturned": 0.1,
"quantityShipped": 0.1,
"reservations": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string",
"siteName": "string"
}
],
"returnStarted": true,
"totalReserved": 0.1,
"unit": "string",
"unitsOfMeasurement": [
{
"baseUnit": true,
"cost": 0.1,
"decimal": true,
"isBaseUnit": true,
"isDecimal": true,
"name": "string",
"quantity": 0.1,
"salesPrice": 0.1,
"unit": "string"
}
]
}
],
"profit": 0.1,
"reference": "string",
"reservationsGroupedBySite": {
"property1": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string",
"siteName": "string"
}
],
"property2": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string",
"siteName": "string"
}
]
},
"reservedProducts": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string",
"siteName": "string"
}
],
"salesValue": 0.1,
"status": "DRAFT",
"subsidiaryId": "string",
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Cancel an order internally
AuthorizationBearer <token>
In: header
Path Parameters
id*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
body?string
Response Body
application/json
application/json
application/json
application/json
curl -X PATCH "http://localhost:18080/api/v1/orders/string/cancel-internally" \ -H "Content-Type: application/json" \ -d 'string'{
"cancelledProducts": [
{
"productId": "string",
"quantity": 0.1,
"unit": "string"
}
],
"clientId": "string",
"costValue": 0.1,
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currency": "string",
"deliveryAddress": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"derivedPaymentStatus": "UNPAID",
"directPayments": [
{
"amount": 0.1,
"createdBy": "string",
"currency": "string",
"id": "string",
"note": "string",
"paymentDate": "2019-08-24T14:15:22Z",
"paymentMethod": "CREDIT_CARD",
"receiptAsset": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"receiptGenerated": true,
"reference": "string"
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"expectedDeliveryDate": "2019-08-24T14:15:22Z",
"id": "string",
"internalCancellationReason": "string",
"internalReview": {
"approved": true,
"by": "string",
"on": "2019-08-24T14:15:22Z",
"reason": "string"
},
"invoiceIds": [
"string"
],
"invoicedAmount": 0.1,
"invoicedPercentage": 0.1,
"margin": 0.1,
"orderDate": "2019-08-24T14:15:22Z",
"packages": [
{
"dimension": {
"height": 0.1,
"length": 0.1,
"width": 0.1
},
"location": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"coordinate": {
"latitude": -90,
"longitude": -180
},
"name": "string"
},
"picklistId": "string",
"weight": 0.1
}
],
"paidAmount": 0.1,
"paymentMethod": "CREDIT_CARD",
"paymentPercentage": 0.1,
"paymentTerm": 0,
"picklistIds": [
"string"
],
"productStatus": [
{
"finishedQuantity": 0.1,
"productId": "string",
"quantityCanBeCancelled": 0.1,
"quantityCancelled": 0.1,
"quantityDelivered": 0.1,
"quantityOrdered": 0.1,
"quantityPending": 0.1,
"quantityPicked": 0.1,
"quantityReservedPicklist": 0.1,
"quantityReservedUnassigned": 0.1,
"quantityReturned": 0.1,
"quantityShipped": 0.1,
"returnStarted": true,
"unitPrice": 0.1
}
],
"products": [
{
"applicableDiscount": {
"active": true,
"clientTypes": [
"PERSON"
],
"name": "string",
"regions": [
"string"
],
"volumeThresholds": [
{
"discountPercentage": 1,
"minAmount": 1
}
]
},
"availableStock": 0.1,
"baseUnitConversion": 0.1,
"baseUnitQuantity": 0.1,
"currency": "string",
"discountedPrice": 0.1,
"imageAssets": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"pending": 0.1,
"price": 0.1,
"productCost": 0.1,
"productId": "string",
"productName": "string",
"productType": "RAW_MATERIAL",
"quantity": 0.1,
"quantityCancelled": 0.1,
"quantityDelivered": 0.1,
"quantityInvoiced": 0.1,
"quantityPicked": 0.1,
"quantityRemainingToInvoice": 0.1,
"quantityReturned": 0.1,
"quantityShipped": 0.1,
"reservations": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string",
"siteName": "string"
}
],
"returnStarted": true,
"totalReserved": 0.1,
"unit": "string",
"unitsOfMeasurement": [
{
"baseUnit": true,
"cost": 0.1,
"decimal": true,
"isBaseUnit": true,
"isDecimal": true,
"name": "string",
"quantity": 0.1,
"salesPrice": 0.1,
"unit": "string"
}
]
}
],
"profit": 0.1,
"reference": "string",
"reservationsGroupedBySite": {
"property1": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string",
"siteName": "string"
}
],
"property2": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string",
"siteName": "string"
}
]
},
"reservedProducts": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string",
"siteName": "string"
}
],
"salesValue": 0.1,
"status": "DRAFT",
"subsidiaryId": "string",
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Cancel order products
AuthorizationBearer <token>
In: header
Path Parameters
id*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X PATCH "http://localhost:18080/api/v1/orders/string/cancel-products" \ -H "Content-Type: application/json" \ -d '[ { "productId": "string", "quantity": 0.1, "unit": "string" } ]'{
"cancelledProducts": [
{
"productId": "string",
"quantity": 0.1,
"unit": "string"
}
],
"clientId": "string",
"costValue": 0.1,
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currency": "string",
"deliveryAddress": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"derivedPaymentStatus": "UNPAID",
"directPayments": [
{
"amount": 0.1,
"createdBy": "string",
"currency": "string",
"id": "string",
"note": "string",
"paymentDate": "2019-08-24T14:15:22Z",
"paymentMethod": "CREDIT_CARD",
"receiptAsset": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"receiptGenerated": true,
"reference": "string"
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"expectedDeliveryDate": "2019-08-24T14:15:22Z",
"id": "string",
"internalCancellationReason": "string",
"internalReview": {
"approved": true,
"by": "string",
"on": "2019-08-24T14:15:22Z",
"reason": "string"
},
"invoiceIds": [
"string"
],
"invoicedAmount": 0.1,
"invoicedPercentage": 0.1,
"margin": 0.1,
"orderDate": "2019-08-24T14:15:22Z",
"packages": [
{
"dimension": {
"height": 0.1,
"length": 0.1,
"width": 0.1
},
"location": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"coordinate": {
"latitude": -90,
"longitude": -180
},
"name": "string"
},
"picklistId": "string",
"weight": 0.1
}
],
"paidAmount": 0.1,
"paymentMethod": "CREDIT_CARD",
"paymentPercentage": 0.1,
"paymentTerm": 0,
"picklistIds": [
"string"
],
"productStatus": [
{
"finishedQuantity": 0.1,
"productId": "string",
"quantityCanBeCancelled": 0.1,
"quantityCancelled": 0.1,
"quantityDelivered": 0.1,
"quantityOrdered": 0.1,
"quantityPending": 0.1,
"quantityPicked": 0.1,
"quantityReservedPicklist": 0.1,
"quantityReservedUnassigned": 0.1,
"quantityReturned": 0.1,
"quantityShipped": 0.1,
"returnStarted": true,
"unitPrice": 0.1
}
],
"products": [
{
"applicableDiscount": {
"active": true,
"clientTypes": [
"PERSON"
],
"name": "string",
"regions": [
"string"
],
"volumeThresholds": [
{
"discountPercentage": 1,
"minAmount": 1
}
]
},
"availableStock": 0.1,
"baseUnitConversion": 0.1,
"baseUnitQuantity": 0.1,
"currency": "string",
"discountedPrice": 0.1,
"imageAssets": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"pending": 0.1,
"price": 0.1,
"productCost": 0.1,
"productId": "string",
"productName": "string",
"productType": "RAW_MATERIAL",
"quantity": 0.1,
"quantityCancelled": 0.1,
"quantityDelivered": 0.1,
"quantityInvoiced": 0.1,
"quantityPicked": 0.1,
"quantityRemainingToInvoice": 0.1,
"quantityReturned": 0.1,
"quantityShipped": 0.1,
"reservations": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string",
"siteName": "string"
}
],
"returnStarted": true,
"totalReserved": 0.1,
"unit": "string",
"unitsOfMeasurement": [
{
"baseUnit": true,
"cost": 0.1,
"decimal": true,
"isBaseUnit": true,
"isDecimal": true,
"name": "string",
"quantity": 0.1,
"salesPrice": 0.1,
"unit": "string"
}
]
}
],
"profit": 0.1,
"reference": "string",
"reservationsGroupedBySite": {
"property1": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string",
"siteName": "string"
}
],
"property2": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string",
"siteName": "string"
}
]
},
"reservedProducts": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string",
"siteName": "string"
}
],
"salesValue": 0.1,
"status": "DRAFT",
"subsidiaryId": "string",
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Close an order
AuthorizationBearer <token>
In: header
Path Parameters
id*string
Response Body
application/json
application/json
application/json
application/json
curl -X PATCH "http://localhost:18080/api/v1/orders/string/close"{
"cancelledProducts": [
{
"productId": "string",
"quantity": 0.1,
"unit": "string"
}
],
"clientId": "string",
"costValue": 0.1,
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currency": "string",
"deliveryAddress": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"derivedPaymentStatus": "UNPAID",
"directPayments": [
{
"amount": 0.1,
"createdBy": "string",
"currency": "string",
"id": "string",
"note": "string",
"paymentDate": "2019-08-24T14:15:22Z",
"paymentMethod": "CREDIT_CARD",
"receiptAsset": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"receiptGenerated": true,
"reference": "string"
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"expectedDeliveryDate": "2019-08-24T14:15:22Z",
"id": "string",
"internalCancellationReason": "string",
"internalReview": {
"approved": true,
"by": "string",
"on": "2019-08-24T14:15:22Z",
"reason": "string"
},
"invoiceIds": [
"string"
],
"invoicedAmount": 0.1,
"invoicedPercentage": 0.1,
"margin": 0.1,
"orderDate": "2019-08-24T14:15:22Z",
"packages": [
{
"dimension": {
"height": 0.1,
"length": 0.1,
"width": 0.1
},
"location": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"coordinate": {
"latitude": -90,
"longitude": -180
},
"name": "string"
},
"picklistId": "string",
"weight": 0.1
}
],
"paidAmount": 0.1,
"paymentMethod": "CREDIT_CARD",
"paymentPercentage": 0.1,
"paymentTerm": 0,
"picklistIds": [
"string"
],
"productStatus": [
{
"finishedQuantity": 0.1,
"productId": "string",
"quantityCanBeCancelled": 0.1,
"quantityCancelled": 0.1,
"quantityDelivered": 0.1,
"quantityOrdered": 0.1,
"quantityPending": 0.1,
"quantityPicked": 0.1,
"quantityReservedPicklist": 0.1,
"quantityReservedUnassigned": 0.1,
"quantityReturned": 0.1,
"quantityShipped": 0.1,
"returnStarted": true,
"unitPrice": 0.1
}
],
"products": [
{
"applicableDiscount": {
"active": true,
"clientTypes": [
"PERSON"
],
"name": "string",
"regions": [
"string"
],
"volumeThresholds": [
{
"discountPercentage": 1,
"minAmount": 1
}
]
},
"availableStock": 0.1,
"baseUnitConversion": 0.1,
"baseUnitQuantity": 0.1,
"currency": "string",
"discountedPrice": 0.1,
"imageAssets": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"pending": 0.1,
"price": 0.1,
"productCost": 0.1,
"productId": "string",
"productName": "string",
"productType": "RAW_MATERIAL",
"quantity": 0.1,
"quantityCancelled": 0.1,
"quantityDelivered": 0.1,
"quantityInvoiced": 0.1,
"quantityPicked": 0.1,
"quantityRemainingToInvoice": 0.1,
"quantityReturned": 0.1,
"quantityShipped": 0.1,
"reservations": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string",
"siteName": "string"
}
],
"returnStarted": true,
"totalReserved": 0.1,
"unit": "string",
"unitsOfMeasurement": [
{
"baseUnit": true,
"cost": 0.1,
"decimal": true,
"isBaseUnit": true,
"isDecimal": true,
"name": "string",
"quantity": 0.1,
"salesPrice": 0.1,
"unit": "string"
}
]
}
],
"profit": 0.1,
"reference": "string",
"reservationsGroupedBySite": {
"property1": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string",
"siteName": "string"
}
],
"property2": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string",
"siteName": "string"
}
]
},
"reservedProducts": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string",
"siteName": "string"
}
],
"salesValue": 0.1,
"status": "DRAFT",
"subsidiaryId": "string",
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Add a comment to an entity
AuthorizationBearer <token>
In: header
Path Parameters
id*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
body*string
Response Body
application/json
application/json
application/json
application/json
curl -X POST "http://localhost:18080/api/v1/orders/string/comment" \ -H "Content-Type: application/json" \ -d 'string'{
"cancelledProducts": [
{
"productId": "string",
"quantity": 0.1,
"unit": "string"
}
],
"clientId": "string",
"costValue": 0.1,
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currency": "string",
"deliveryAddress": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"derivedPaymentStatus": "UNPAID",
"directPayments": [
{
"amount": 0.1,
"createdBy": "string",
"currency": "string",
"id": "string",
"note": "string",
"paymentDate": "2019-08-24T14:15:22Z",
"paymentMethod": "CREDIT_CARD",
"receiptAsset": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"receiptGenerated": true,
"reference": "string"
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"expectedDeliveryDate": "2019-08-24T14:15:22Z",
"id": "string",
"internalCancellationReason": "string",
"internalReview": {
"approved": true,
"by": "string",
"on": "2019-08-24T14:15:22Z",
"reason": "string"
},
"invoiceIds": [
"string"
],
"invoicedAmount": 0.1,
"invoicedPercentage": 0.1,
"margin": 0.1,
"orderDate": "2019-08-24T14:15:22Z",
"packages": [
{
"dimension": {
"height": 0.1,
"length": 0.1,
"width": 0.1
},
"location": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"coordinate": {
"latitude": -90,
"longitude": -180
},
"name": "string"
},
"picklistId": "string",
"weight": 0.1
}
],
"paidAmount": 0.1,
"paymentMethod": "CREDIT_CARD",
"paymentPercentage": 0.1,
"paymentTerm": 0,
"picklistIds": [
"string"
],
"productStatus": [
{
"finishedQuantity": 0.1,
"productId": "string",
"quantityCanBeCancelled": 0.1,
"quantityCancelled": 0.1,
"quantityDelivered": 0.1,
"quantityOrdered": 0.1,
"quantityPending": 0.1,
"quantityPicked": 0.1,
"quantityReservedPicklist": 0.1,
"quantityReservedUnassigned": 0.1,
"quantityReturned": 0.1,
"quantityShipped": 0.1,
"returnStarted": true,
"unitPrice": 0.1
}
],
"products": [
{
"applicableDiscount": {
"active": true,
"clientTypes": [
"PERSON"
],
"name": "string",
"regions": [
"string"
],
"volumeThresholds": [
{
"discountPercentage": 1,
"minAmount": 1
}
]
},
"availableStock": 0.1,
"baseUnitConversion": 0.1,
"baseUnitQuantity": 0.1,
"currency": "string",
"discountedPrice": 0.1,
"imageAssets": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"pending": 0.1,
"price": 0.1,
"productCost": 0.1,
"productId": "string",
"productName": "string",
"productType": "RAW_MATERIAL",
"quantity": 0.1,
"quantityCancelled": 0.1,
"quantityDelivered": 0.1,
"quantityInvoiced": 0.1,
"quantityPicked": 0.1,
"quantityRemainingToInvoice": 0.1,
"quantityReturned": 0.1,
"quantityShipped": 0.1,
"reservations": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string",
"siteName": "string"
}
],
"returnStarted": true,
"totalReserved": 0.1,
"unit": "string",
"unitsOfMeasurement": [
{
"baseUnit": true,
"cost": 0.1,
"decimal": true,
"isBaseUnit": true,
"isDecimal": true,
"name": "string",
"quantity": 0.1,
"salesPrice": 0.1,
"unit": "string"
}
]
}
],
"profit": 0.1,
"reference": "string",
"reservationsGroupedBySite": {
"property1": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string",
"siteName": "string"
}
],
"property2": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string",
"siteName": "string"
}
]
},
"reservedProducts": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string",
"siteName": "string"
}
],
"salesValue": 0.1,
"status": "DRAFT",
"subsidiaryId": "string",
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Generate invoice from order
AuthorizationBearer <token>
In: header
Path Parameters
id*string
Response Body
application/json
application/json
application/json
application/json
curl -X POST "http://localhost:18080/api/v1/orders/string/generate-invoice"{
"attachments": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"clientId": "string",
"contactEmail": "string",
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currency": "string",
"datePaid": "2019-08-24T14:15:22Z",
"dueDate": "2019-08-24T14:15:22Z",
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"id": "string",
"invoiceDate": "2019-08-24T14:15:22Z",
"invoiceNumber": "string",
"mailBody": "string",
"milestoneId": "string",
"note": "string",
"opportunityId": "string",
"overdueNotifiedAt": "2019-08-24T14:15:22Z",
"paid": 0.1,
"paidExcludingTax": 0.1,
"paymentReference": "string",
"paymentTermDays": 0,
"pdf": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"recurringAgreement": {
"autoSend": true,
"endDate": "2019-08-24T14:15:22Z",
"intervalDays": 0,
"intervalMonths": 0,
"nextInvoiceDate": "2019-08-24T14:15:22Z"
},
"reminderBody": "string",
"reminders": [
{
"createdBy": "string",
"sentOn": "2019-08-24T14:15:22Z"
}
],
"rows": [
{
"description": "string",
"id": "string",
"productId": "string",
"quantity": 0.1,
"quantityType": "AMOUNT",
"taxAmount": 0.1,
"taxRate": 0.1,
"total": 0.1,
"totalWithTax": 0.1,
"type": "ITEM",
"unitPrice": 0.1
}
],
"salesOrderId": "string",
"sentMails": [
"string"
],
"status": "DRAFT",
"subsidiaryId": "string",
"tenantId": "string",
"total": 0.1,
"totalExcludingTax": 0.1,
"totalTax": 0.1,
"totalWithTax": 0.1,
"transactions": [
{
"accountId": "string",
"amount": 0.1,
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"paymentMethod": "CREDIT_CARD",
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}
],
"type": "MANUAL",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Generate partial invoice from order
AuthorizationBearer <token>
In: header
Path Parameters
id*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "http://localhost:18080/api/v1/orders/string/generate-invoice-partial" \ -H "Content-Type: application/json" \ -d '{}'{
"attachments": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"clientId": "string",
"contactEmail": "string",
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currency": "string",
"datePaid": "2019-08-24T14:15:22Z",
"dueDate": "2019-08-24T14:15:22Z",
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"id": "string",
"invoiceDate": "2019-08-24T14:15:22Z",
"invoiceNumber": "string",
"mailBody": "string",
"milestoneId": "string",
"note": "string",
"opportunityId": "string",
"overdueNotifiedAt": "2019-08-24T14:15:22Z",
"paid": 0.1,
"paidExcludingTax": 0.1,
"paymentReference": "string",
"paymentTermDays": 0,
"pdf": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"recurringAgreement": {
"autoSend": true,
"endDate": "2019-08-24T14:15:22Z",
"intervalDays": 0,
"intervalMonths": 0,
"nextInvoiceDate": "2019-08-24T14:15:22Z"
},
"reminderBody": "string",
"reminders": [
{
"createdBy": "string",
"sentOn": "2019-08-24T14:15:22Z"
}
],
"rows": [
{
"description": "string",
"id": "string",
"productId": "string",
"quantity": 0.1,
"quantityType": "AMOUNT",
"taxAmount": 0.1,
"taxRate": 0.1,
"total": 0.1,
"totalWithTax": 0.1,
"type": "ITEM",
"unitPrice": 0.1
}
],
"salesOrderId": "string",
"sentMails": [
"string"
],
"status": "DRAFT",
"subsidiaryId": "string",
"tenantId": "string",
"total": 0.1,
"totalExcludingTax": 0.1,
"totalTax": 0.1,
"totalWithTax": 0.1,
"transactions": [
{
"accountId": "string",
"amount": 0.1,
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"paymentMethod": "CREDIT_CARD",
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}
],
"type": "MANUAL",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Create a picklist for an order
AuthorizationBearer <token>
In: header
Path Parameters
id*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "http://localhost:18080/api/v1/orders/string/picklists" \ -H "Content-Type: application/json" \ -d '{ "priority": "LOW_PRIORITY", "products": [ { "productId": "string", "quantity": 0.1 } ], "stockSiteId": "string" }'{
"cancelledProducts": [
{
"productId": "string",
"quantity": 0.1,
"unit": "string"
}
],
"clientId": "string",
"costValue": 0.1,
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currency": "string",
"deliveryAddress": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"derivedPaymentStatus": "UNPAID",
"directPayments": [
{
"amount": 0.1,
"createdBy": "string",
"currency": "string",
"id": "string",
"note": "string",
"paymentDate": "2019-08-24T14:15:22Z",
"paymentMethod": "CREDIT_CARD",
"receiptAsset": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"receiptGenerated": true,
"reference": "string"
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"expectedDeliveryDate": "2019-08-24T14:15:22Z",
"id": "string",
"internalCancellationReason": "string",
"internalReview": {
"approved": true,
"by": "string",
"on": "2019-08-24T14:15:22Z",
"reason": "string"
},
"invoiceIds": [
"string"
],
"invoicedAmount": 0.1,
"invoicedPercentage": 0.1,
"margin": 0.1,
"orderDate": "2019-08-24T14:15:22Z",
"packages": [
{
"dimension": {
"height": 0.1,
"length": 0.1,
"width": 0.1
},
"location": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"coordinate": {
"latitude": -90,
"longitude": -180
},
"name": "string"
},
"picklistId": "string",
"weight": 0.1
}
],
"paidAmount": 0.1,
"paymentMethod": "CREDIT_CARD",
"paymentPercentage": 0.1,
"paymentTerm": 0,
"picklistIds": [
"string"
],
"productStatus": [
{
"finishedQuantity": 0.1,
"productId": "string",
"quantityCanBeCancelled": 0.1,
"quantityCancelled": 0.1,
"quantityDelivered": 0.1,
"quantityOrdered": 0.1,
"quantityPending": 0.1,
"quantityPicked": 0.1,
"quantityReservedPicklist": 0.1,
"quantityReservedUnassigned": 0.1,
"quantityReturned": 0.1,
"quantityShipped": 0.1,
"returnStarted": true,
"unitPrice": 0.1
}
],
"products": [
{
"applicableDiscount": {
"active": true,
"clientTypes": [
"PERSON"
],
"name": "string",
"regions": [
"string"
],
"volumeThresholds": [
{
"discountPercentage": 1,
"minAmount": 1
}
]
},
"availableStock": 0.1,
"baseUnitConversion": 0.1,
"baseUnitQuantity": 0.1,
"currency": "string",
"discountedPrice": 0.1,
"imageAssets": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"pending": 0.1,
"price": 0.1,
"productCost": 0.1,
"productId": "string",
"productName": "string",
"productType": "RAW_MATERIAL",
"quantity": 0.1,
"quantityCancelled": 0.1,
"quantityDelivered": 0.1,
"quantityInvoiced": 0.1,
"quantityPicked": 0.1,
"quantityRemainingToInvoice": 0.1,
"quantityReturned": 0.1,
"quantityShipped": 0.1,
"reservations": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string",
"siteName": "string"
}
],
"returnStarted": true,
"totalReserved": 0.1,
"unit": "string",
"unitsOfMeasurement": [
{
"baseUnit": true,
"cost": 0.1,
"decimal": true,
"isBaseUnit": true,
"isDecimal": true,
"name": "string",
"quantity": 0.1,
"salesPrice": 0.1,
"unit": "string"
}
]
}
],
"profit": 0.1,
"reference": "string",
"reservationsGroupedBySite": {
"property1": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string",
"siteName": "string"
}
],
"property2": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string",
"siteName": "string"
}
]
},
"reservedProducts": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string",
"siteName": "string"
}
],
"salesValue": 0.1,
"status": "DRAFT",
"subsidiaryId": "string",
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Cancel a picklist of an order
AuthorizationBearer <token>
In: header
Path Parameters
id*string
picklistId*string
Response Body
application/json
application/json
application/json
application/json
curl -X PATCH "http://localhost:18080/api/v1/orders/string/picklists/string/cancel"{
"cancelledProducts": [
{
"productId": "string",
"quantity": 0.1,
"unit": "string"
}
],
"clientId": "string",
"costValue": 0.1,
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currency": "string",
"deliveryAddress": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"derivedPaymentStatus": "UNPAID",
"directPayments": [
{
"amount": 0.1,
"createdBy": "string",
"currency": "string",
"id": "string",
"note": "string",
"paymentDate": "2019-08-24T14:15:22Z",
"paymentMethod": "CREDIT_CARD",
"receiptAsset": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"receiptGenerated": true,
"reference": "string"
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"expectedDeliveryDate": "2019-08-24T14:15:22Z",
"id": "string",
"internalCancellationReason": "string",
"internalReview": {
"approved": true,
"by": "string",
"on": "2019-08-24T14:15:22Z",
"reason": "string"
},
"invoiceIds": [
"string"
],
"invoicedAmount": 0.1,
"invoicedPercentage": 0.1,
"margin": 0.1,
"orderDate": "2019-08-24T14:15:22Z",
"packages": [
{
"dimension": {
"height": 0.1,
"length": 0.1,
"width": 0.1
},
"location": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"coordinate": {
"latitude": -90,
"longitude": -180
},
"name": "string"
},
"picklistId": "string",
"weight": 0.1
}
],
"paidAmount": 0.1,
"paymentMethod": "CREDIT_CARD",
"paymentPercentage": 0.1,
"paymentTerm": 0,
"picklistIds": [
"string"
],
"productStatus": [
{
"finishedQuantity": 0.1,
"productId": "string",
"quantityCanBeCancelled": 0.1,
"quantityCancelled": 0.1,
"quantityDelivered": 0.1,
"quantityOrdered": 0.1,
"quantityPending": 0.1,
"quantityPicked": 0.1,
"quantityReservedPicklist": 0.1,
"quantityReservedUnassigned": 0.1,
"quantityReturned": 0.1,
"quantityShipped": 0.1,
"returnStarted": true,
"unitPrice": 0.1
}
],
"products": [
{
"applicableDiscount": {
"active": true,
"clientTypes": [
"PERSON"
],
"name": "string",
"regions": [
"string"
],
"volumeThresholds": [
{
"discountPercentage": 1,
"minAmount": 1
}
]
},
"availableStock": 0.1,
"baseUnitConversion": 0.1,
"baseUnitQuantity": 0.1,
"currency": "string",
"discountedPrice": 0.1,
"imageAssets": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"pending": 0.1,
"price": 0.1,
"productCost": 0.1,
"productId": "string",
"productName": "string",
"productType": "RAW_MATERIAL",
"quantity": 0.1,
"quantityCancelled": 0.1,
"quantityDelivered": 0.1,
"quantityInvoiced": 0.1,
"quantityPicked": 0.1,
"quantityRemainingToInvoice": 0.1,
"quantityReturned": 0.1,
"quantityShipped": 0.1,
"reservations": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string",
"siteName": "string"
}
],
"returnStarted": true,
"totalReserved": 0.1,
"unit": "string",
"unitsOfMeasurement": [
{
"baseUnit": true,
"cost": 0.1,
"decimal": true,
"isBaseUnit": true,
"isDecimal": true,
"name": "string",
"quantity": 0.1,
"salesPrice": 0.1,
"unit": "string"
}
]
}
],
"profit": 0.1,
"reference": "string",
"reservationsGroupedBySite": {
"property1": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string",
"siteName": "string"
}
],
"property2": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string",
"siteName": "string"
}
]
},
"reservedProducts": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string",
"siteName": "string"
}
],
"salesValue": 0.1,
"status": "DRAFT",
"subsidiaryId": "string",
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Start return for a picklist of an order
AuthorizationBearer <token>
In: header
Path Parameters
id*string
picklistId*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X PATCH "http://localhost:18080/api/v1/orders/string/picklists/string/return" \ -H "Content-Type: application/json" \ -d '[ { "productId": "string", "quantity": 0.1 } ]'{
"cancelledProducts": [
{
"productId": "string",
"quantity": 0.1,
"unit": "string"
}
],
"clientId": "string",
"costValue": 0.1,
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currency": "string",
"deliveryAddress": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"derivedPaymentStatus": "UNPAID",
"directPayments": [
{
"amount": 0.1,
"createdBy": "string",
"currency": "string",
"id": "string",
"note": "string",
"paymentDate": "2019-08-24T14:15:22Z",
"paymentMethod": "CREDIT_CARD",
"receiptAsset": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"receiptGenerated": true,
"reference": "string"
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"expectedDeliveryDate": "2019-08-24T14:15:22Z",
"id": "string",
"internalCancellationReason": "string",
"internalReview": {
"approved": true,
"by": "string",
"on": "2019-08-24T14:15:22Z",
"reason": "string"
},
"invoiceIds": [
"string"
],
"invoicedAmount": 0.1,
"invoicedPercentage": 0.1,
"margin": 0.1,
"orderDate": "2019-08-24T14:15:22Z",
"packages": [
{
"dimension": {
"height": 0.1,
"length": 0.1,
"width": 0.1
},
"location": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"coordinate": {
"latitude": -90,
"longitude": -180
},
"name": "string"
},
"picklistId": "string",
"weight": 0.1
}
],
"paidAmount": 0.1,
"paymentMethod": "CREDIT_CARD",
"paymentPercentage": 0.1,
"paymentTerm": 0,
"picklistIds": [
"string"
],
"productStatus": [
{
"finishedQuantity": 0.1,
"productId": "string",
"quantityCanBeCancelled": 0.1,
"quantityCancelled": 0.1,
"quantityDelivered": 0.1,
"quantityOrdered": 0.1,
"quantityPending": 0.1,
"quantityPicked": 0.1,
"quantityReservedPicklist": 0.1,
"quantityReservedUnassigned": 0.1,
"quantityReturned": 0.1,
"quantityShipped": 0.1,
"returnStarted": true,
"unitPrice": 0.1
}
],
"products": [
{
"applicableDiscount": {
"active": true,
"clientTypes": [
"PERSON"
],
"name": "string",
"regions": [
"string"
],
"volumeThresholds": [
{
"discountPercentage": 1,
"minAmount": 1
}
]
},
"availableStock": 0.1,
"baseUnitConversion": 0.1,
"baseUnitQuantity": 0.1,
"currency": "string",
"discountedPrice": 0.1,
"imageAssets": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"pending": 0.1,
"price": 0.1,
"productCost": 0.1,
"productId": "string",
"productName": "string",
"productType": "RAW_MATERIAL",
"quantity": 0.1,
"quantityCancelled": 0.1,
"quantityDelivered": 0.1,
"quantityInvoiced": 0.1,
"quantityPicked": 0.1,
"quantityRemainingToInvoice": 0.1,
"quantityReturned": 0.1,
"quantityShipped": 0.1,
"reservations": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string",
"siteName": "string"
}
],
"returnStarted": true,
"totalReserved": 0.1,
"unit": "string",
"unitsOfMeasurement": [
{
"baseUnit": true,
"cost": 0.1,
"decimal": true,
"isBaseUnit": true,
"isDecimal": true,
"name": "string",
"quantity": 0.1,
"salesPrice": 0.1,
"unit": "string"
}
]
}
],
"profit": 0.1,
"reference": "string",
"reservationsGroupedBySite": {
"property1": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string",
"siteName": "string"
}
],
"property2": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string",
"siteName": "string"
}
]
},
"reservedProducts": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string",
"siteName": "string"
}
],
"salesValue": 0.1,
"status": "DRAFT",
"subsidiaryId": "string",
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Register payment for an order
AuthorizationBearer <token>
In: header
Path Parameters
id*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "http://localhost:18080/api/v1/orders/string/register-payment" \ -H "Content-Type: application/json" \ -d '{ "amount": 0.1, "currency": "string", "paymentDate": "2019-08-24T14:15:22Z", "paymentMethod": "CREDIT_CARD" }'{
"cancelledProducts": [
{
"productId": "string",
"quantity": 0.1,
"unit": "string"
}
],
"clientId": "string",
"costValue": 0.1,
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currency": "string",
"deliveryAddress": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"derivedPaymentStatus": "UNPAID",
"directPayments": [
{
"amount": 0.1,
"createdBy": "string",
"currency": "string",
"id": "string",
"note": "string",
"paymentDate": "2019-08-24T14:15:22Z",
"paymentMethod": "CREDIT_CARD",
"receiptAsset": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"receiptGenerated": true,
"reference": "string"
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"expectedDeliveryDate": "2019-08-24T14:15:22Z",
"id": "string",
"internalCancellationReason": "string",
"internalReview": {
"approved": true,
"by": "string",
"on": "2019-08-24T14:15:22Z",
"reason": "string"
},
"invoiceIds": [
"string"
],
"invoicedAmount": 0.1,
"invoicedPercentage": 0.1,
"margin": 0.1,
"orderDate": "2019-08-24T14:15:22Z",
"packages": [
{
"dimension": {
"height": 0.1,
"length": 0.1,
"width": 0.1
},
"location": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"coordinate": {
"latitude": -90,
"longitude": -180
},
"name": "string"
},
"picklistId": "string",
"weight": 0.1
}
],
"paidAmount": 0.1,
"paymentMethod": "CREDIT_CARD",
"paymentPercentage": 0.1,
"paymentTerm": 0,
"picklistIds": [
"string"
],
"productStatus": [
{
"finishedQuantity": 0.1,
"productId": "string",
"quantityCanBeCancelled": 0.1,
"quantityCancelled": 0.1,
"quantityDelivered": 0.1,
"quantityOrdered": 0.1,
"quantityPending": 0.1,
"quantityPicked": 0.1,
"quantityReservedPicklist": 0.1,
"quantityReservedUnassigned": 0.1,
"quantityReturned": 0.1,
"quantityShipped": 0.1,
"returnStarted": true,
"unitPrice": 0.1
}
],
"products": [
{
"applicableDiscount": {
"active": true,
"clientTypes": [
"PERSON"
],
"name": "string",
"regions": [
"string"
],
"volumeThresholds": [
{
"discountPercentage": 1,
"minAmount": 1
}
]
},
"availableStock": 0.1,
"baseUnitConversion": 0.1,
"baseUnitQuantity": 0.1,
"currency": "string",
"discountedPrice": 0.1,
"imageAssets": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"pending": 0.1,
"price": 0.1,
"productCost": 0.1,
"productId": "string",
"productName": "string",
"productType": "RAW_MATERIAL",
"quantity": 0.1,
"quantityCancelled": 0.1,
"quantityDelivered": 0.1,
"quantityInvoiced": 0.1,
"quantityPicked": 0.1,
"quantityRemainingToInvoice": 0.1,
"quantityReturned": 0.1,
"quantityShipped": 0.1,
"reservations": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string",
"siteName": "string"
}
],
"returnStarted": true,
"totalReserved": 0.1,
"unit": "string",
"unitsOfMeasurement": [
{
"baseUnit": true,
"cost": 0.1,
"decimal": true,
"isBaseUnit": true,
"isDecimal": true,
"name": "string",
"quantity": 0.1,
"salesPrice": 0.1,
"unit": "string"
}
]
}
],
"profit": 0.1,
"reference": "string",
"reservationsGroupedBySite": {
"property1": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string",
"siteName": "string"
}
],
"property2": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string",
"siteName": "string"
}
]
},
"reservedProducts": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string",
"siteName": "string"
}
],
"salesValue": 0.1,
"status": "DRAFT",
"subsidiaryId": "string",
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Reinstate an order
AuthorizationBearer <token>
In: header
Path Parameters
id*string
Response Body
application/json
application/json
application/json
application/json
curl -X PATCH "http://localhost:18080/api/v1/orders/string/reinstate"{
"cancelledProducts": [
{
"productId": "string",
"quantity": 0.1,
"unit": "string"
}
],
"clientId": "string",
"costValue": 0.1,
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currency": "string",
"deliveryAddress": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"derivedPaymentStatus": "UNPAID",
"directPayments": [
{
"amount": 0.1,
"createdBy": "string",
"currency": "string",
"id": "string",
"note": "string",
"paymentDate": "2019-08-24T14:15:22Z",
"paymentMethod": "CREDIT_CARD",
"receiptAsset": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"receiptGenerated": true,
"reference": "string"
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"expectedDeliveryDate": "2019-08-24T14:15:22Z",
"id": "string",
"internalCancellationReason": "string",
"internalReview": {
"approved": true,
"by": "string",
"on": "2019-08-24T14:15:22Z",
"reason": "string"
},
"invoiceIds": [
"string"
],
"invoicedAmount": 0.1,
"invoicedPercentage": 0.1,
"margin": 0.1,
"orderDate": "2019-08-24T14:15:22Z",
"packages": [
{
"dimension": {
"height": 0.1,
"length": 0.1,
"width": 0.1
},
"location": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"coordinate": {
"latitude": -90,
"longitude": -180
},
"name": "string"
},
"picklistId": "string",
"weight": 0.1
}
],
"paidAmount": 0.1,
"paymentMethod": "CREDIT_CARD",
"paymentPercentage": 0.1,
"paymentTerm": 0,
"picklistIds": [
"string"
],
"productStatus": [
{
"finishedQuantity": 0.1,
"productId": "string",
"quantityCanBeCancelled": 0.1,
"quantityCancelled": 0.1,
"quantityDelivered": 0.1,
"quantityOrdered": 0.1,
"quantityPending": 0.1,
"quantityPicked": 0.1,
"quantityReservedPicklist": 0.1,
"quantityReservedUnassigned": 0.1,
"quantityReturned": 0.1,
"quantityShipped": 0.1,
"returnStarted": true,
"unitPrice": 0.1
}
],
"products": [
{
"applicableDiscount": {
"active": true,
"clientTypes": [
"PERSON"
],
"name": "string",
"regions": [
"string"
],
"volumeThresholds": [
{
"discountPercentage": 1,
"minAmount": 1
}
]
},
"availableStock": 0.1,
"baseUnitConversion": 0.1,
"baseUnitQuantity": 0.1,
"currency": "string",
"discountedPrice": 0.1,
"imageAssets": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"pending": 0.1,
"price": 0.1,
"productCost": 0.1,
"productId": "string",
"productName": "string",
"productType": "RAW_MATERIAL",
"quantity": 0.1,
"quantityCancelled": 0.1,
"quantityDelivered": 0.1,
"quantityInvoiced": 0.1,
"quantityPicked": 0.1,
"quantityRemainingToInvoice": 0.1,
"quantityReturned": 0.1,
"quantityShipped": 0.1,
"reservations": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string",
"siteName": "string"
}
],
"returnStarted": true,
"totalReserved": 0.1,
"unit": "string",
"unitsOfMeasurement": [
{
"baseUnit": true,
"cost": 0.1,
"decimal": true,
"isBaseUnit": true,
"isDecimal": true,
"name": "string",
"quantity": 0.1,
"salesPrice": 0.1,
"unit": "string"
}
]
}
],
"profit": 0.1,
"reference": "string",
"reservationsGroupedBySite": {
"property1": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string",
"siteName": "string"
}
],
"property2": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string",
"siteName": "string"
}
]
},
"reservedProducts": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string",
"siteName": "string"
}
],
"salesValue": 0.1,
"status": "DRAFT",
"subsidiaryId": "string",
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Reject an order
AuthorizationBearer <token>
In: header
Path Parameters
id*string
Response Body
application/json
application/json
application/json
application/json
curl -X PATCH "http://localhost:18080/api/v1/orders/string/reject"{
"cancelledProducts": [
{
"productId": "string",
"quantity": 0.1,
"unit": "string"
}
],
"clientId": "string",
"costValue": 0.1,
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currency": "string",
"deliveryAddress": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"derivedPaymentStatus": "UNPAID",
"directPayments": [
{
"amount": 0.1,
"createdBy": "string",
"currency": "string",
"id": "string",
"note": "string",
"paymentDate": "2019-08-24T14:15:22Z",
"paymentMethod": "CREDIT_CARD",
"receiptAsset": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"receiptGenerated": true,
"reference": "string"
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"expectedDeliveryDate": "2019-08-24T14:15:22Z",
"id": "string",
"internalCancellationReason": "string",
"internalReview": {
"approved": true,
"by": "string",
"on": "2019-08-24T14:15:22Z",
"reason": "string"
},
"invoiceIds": [
"string"
],
"invoicedAmount": 0.1,
"invoicedPercentage": 0.1,
"margin": 0.1,
"orderDate": "2019-08-24T14:15:22Z",
"packages": [
{
"dimension": {
"height": 0.1,
"length": 0.1,
"width": 0.1
},
"location": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"coordinate": {
"latitude": -90,
"longitude": -180
},
"name": "string"
},
"picklistId": "string",
"weight": 0.1
}
],
"paidAmount": 0.1,
"paymentMethod": "CREDIT_CARD",
"paymentPercentage": 0.1,
"paymentTerm": 0,
"picklistIds": [
"string"
],
"productStatus": [
{
"finishedQuantity": 0.1,
"productId": "string",
"quantityCanBeCancelled": 0.1,
"quantityCancelled": 0.1,
"quantityDelivered": 0.1,
"quantityOrdered": 0.1,
"quantityPending": 0.1,
"quantityPicked": 0.1,
"quantityReservedPicklist": 0.1,
"quantityReservedUnassigned": 0.1,
"quantityReturned": 0.1,
"quantityShipped": 0.1,
"returnStarted": true,
"unitPrice": 0.1
}
],
"products": [
{
"applicableDiscount": {
"active": true,
"clientTypes": [
"PERSON"
],
"name": "string",
"regions": [
"string"
],
"volumeThresholds": [
{
"discountPercentage": 1,
"minAmount": 1
}
]
},
"availableStock": 0.1,
"baseUnitConversion": 0.1,
"baseUnitQuantity": 0.1,
"currency": "string",
"discountedPrice": 0.1,
"imageAssets": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"pending": 0.1,
"price": 0.1,
"productCost": 0.1,
"productId": "string",
"productName": "string",
"productType": "RAW_MATERIAL",
"quantity": 0.1,
"quantityCancelled": 0.1,
"quantityDelivered": 0.1,
"quantityInvoiced": 0.1,
"quantityPicked": 0.1,
"quantityRemainingToInvoice": 0.1,
"quantityReturned": 0.1,
"quantityShipped": 0.1,
"reservations": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string",
"siteName": "string"
}
],
"returnStarted": true,
"totalReserved": 0.1,
"unit": "string",
"unitsOfMeasurement": [
{
"baseUnit": true,
"cost": 0.1,
"decimal": true,
"isBaseUnit": true,
"isDecimal": true,
"name": "string",
"quantity": 0.1,
"salesPrice": 0.1,
"unit": "string"
}
]
}
],
"profit": 0.1,
"reference": "string",
"reservationsGroupedBySite": {
"property1": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string",
"siteName": "string"
}
],
"property2": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string",
"siteName": "string"
}
]
},
"reservedProducts": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string",
"siteName": "string"
}
],
"salesValue": 0.1,
"status": "DRAFT",
"subsidiaryId": "string",
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Request approval for order
AuthorizationBearer <token>
In: header
Path Parameters
id*string
Response Body
application/json
application/json
application/json
application/json
curl -X PATCH "http://localhost:18080/api/v1/orders/string/request-approval"{
"cancelledProducts": [
{
"productId": "string",
"quantity": 0.1,
"unit": "string"
}
],
"clientId": "string",
"costValue": 0.1,
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currency": "string",
"deliveryAddress": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"derivedPaymentStatus": "UNPAID",
"directPayments": [
{
"amount": 0.1,
"createdBy": "string",
"currency": "string",
"id": "string",
"note": "string",
"paymentDate": "2019-08-24T14:15:22Z",
"paymentMethod": "CREDIT_CARD",
"receiptAsset": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"receiptGenerated": true,
"reference": "string"
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"expectedDeliveryDate": "2019-08-24T14:15:22Z",
"id": "string",
"internalCancellationReason": "string",
"internalReview": {
"approved": true,
"by": "string",
"on": "2019-08-24T14:15:22Z",
"reason": "string"
},
"invoiceIds": [
"string"
],
"invoicedAmount": 0.1,
"invoicedPercentage": 0.1,
"margin": 0.1,
"orderDate": "2019-08-24T14:15:22Z",
"packages": [
{
"dimension": {
"height": 0.1,
"length": 0.1,
"width": 0.1
},
"location": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"coordinate": {
"latitude": -90,
"longitude": -180
},
"name": "string"
},
"picklistId": "string",
"weight": 0.1
}
],
"paidAmount": 0.1,
"paymentMethod": "CREDIT_CARD",
"paymentPercentage": 0.1,
"paymentTerm": 0,
"picklistIds": [
"string"
],
"productStatus": [
{
"finishedQuantity": 0.1,
"productId": "string",
"quantityCanBeCancelled": 0.1,
"quantityCancelled": 0.1,
"quantityDelivered": 0.1,
"quantityOrdered": 0.1,
"quantityPending": 0.1,
"quantityPicked": 0.1,
"quantityReservedPicklist": 0.1,
"quantityReservedUnassigned": 0.1,
"quantityReturned": 0.1,
"quantityShipped": 0.1,
"returnStarted": true,
"unitPrice": 0.1
}
],
"products": [
{
"applicableDiscount": {
"active": true,
"clientTypes": [
"PERSON"
],
"name": "string",
"regions": [
"string"
],
"volumeThresholds": [
{
"discountPercentage": 1,
"minAmount": 1
}
]
},
"availableStock": 0.1,
"baseUnitConversion": 0.1,
"baseUnitQuantity": 0.1,
"currency": "string",
"discountedPrice": 0.1,
"imageAssets": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"pending": 0.1,
"price": 0.1,
"productCost": 0.1,
"productId": "string",
"productName": "string",
"productType": "RAW_MATERIAL",
"quantity": 0.1,
"quantityCancelled": 0.1,
"quantityDelivered": 0.1,
"quantityInvoiced": 0.1,
"quantityPicked": 0.1,
"quantityRemainingToInvoice": 0.1,
"quantityReturned": 0.1,
"quantityShipped": 0.1,
"reservations": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string",
"siteName": "string"
}
],
"returnStarted": true,
"totalReserved": 0.1,
"unit": "string",
"unitsOfMeasurement": [
{
"baseUnit": true,
"cost": 0.1,
"decimal": true,
"isBaseUnit": true,
"isDecimal": true,
"name": "string",
"quantity": 0.1,
"salesPrice": 0.1,
"unit": "string"
}
]
}
],
"profit": 0.1,
"reference": "string",
"reservationsGroupedBySite": {
"property1": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string",
"siteName": "string"
}
],
"property2": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string",
"siteName": "string"
}
]
},
"reservedProducts": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string",
"siteName": "string"
}
],
"salesValue": 0.1,
"status": "DRAFT",
"subsidiaryId": "string",
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}(partially) Reserve products for an order
AuthorizationBearer <token>
In: header
Path Parameters
id*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "http://localhost:18080/api/v1/orders/string/reservations" \ -H "Content-Type: application/json" \ -d '{ "reservations": [ { "products": [ { "productId": "string", "quantity": 0.1 } ], "stockSiteId": "string" } ] }'{
"cancelledProducts": [
{
"productId": "string",
"quantity": 0.1,
"unit": "string"
}
],
"clientId": "string",
"costValue": 0.1,
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currency": "string",
"deliveryAddress": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"derivedPaymentStatus": "UNPAID",
"directPayments": [
{
"amount": 0.1,
"createdBy": "string",
"currency": "string",
"id": "string",
"note": "string",
"paymentDate": "2019-08-24T14:15:22Z",
"paymentMethod": "CREDIT_CARD",
"receiptAsset": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"receiptGenerated": true,
"reference": "string"
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"expectedDeliveryDate": "2019-08-24T14:15:22Z",
"id": "string",
"internalCancellationReason": "string",
"internalReview": {
"approved": true,
"by": "string",
"on": "2019-08-24T14:15:22Z",
"reason": "string"
},
"invoiceIds": [
"string"
],
"invoicedAmount": 0.1,
"invoicedPercentage": 0.1,
"margin": 0.1,
"orderDate": "2019-08-24T14:15:22Z",
"packages": [
{
"dimension": {
"height": 0.1,
"length": 0.1,
"width": 0.1
},
"location": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"coordinate": {
"latitude": -90,
"longitude": -180
},
"name": "string"
},
"picklistId": "string",
"weight": 0.1
}
],
"paidAmount": 0.1,
"paymentMethod": "CREDIT_CARD",
"paymentPercentage": 0.1,
"paymentTerm": 0,
"picklistIds": [
"string"
],
"productStatus": [
{
"finishedQuantity": 0.1,
"productId": "string",
"quantityCanBeCancelled": 0.1,
"quantityCancelled": 0.1,
"quantityDelivered": 0.1,
"quantityOrdered": 0.1,
"quantityPending": 0.1,
"quantityPicked": 0.1,
"quantityReservedPicklist": 0.1,
"quantityReservedUnassigned": 0.1,
"quantityReturned": 0.1,
"quantityShipped": 0.1,
"returnStarted": true,
"unitPrice": 0.1
}
],
"products": [
{
"applicableDiscount": {
"active": true,
"clientTypes": [
"PERSON"
],
"name": "string",
"regions": [
"string"
],
"volumeThresholds": [
{
"discountPercentage": 1,
"minAmount": 1
}
]
},
"availableStock": 0.1,
"baseUnitConversion": 0.1,
"baseUnitQuantity": 0.1,
"currency": "string",
"discountedPrice": 0.1,
"imageAssets": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"pending": 0.1,
"price": 0.1,
"productCost": 0.1,
"productId": "string",
"productName": "string",
"productType": "RAW_MATERIAL",
"quantity": 0.1,
"quantityCancelled": 0.1,
"quantityDelivered": 0.1,
"quantityInvoiced": 0.1,
"quantityPicked": 0.1,
"quantityRemainingToInvoice": 0.1,
"quantityReturned": 0.1,
"quantityShipped": 0.1,
"reservations": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string",
"siteName": "string"
}
],
"returnStarted": true,
"totalReserved": 0.1,
"unit": "string",
"unitsOfMeasurement": [
{
"baseUnit": true,
"cost": 0.1,
"decimal": true,
"isBaseUnit": true,
"isDecimal": true,
"name": "string",
"quantity": 0.1,
"salesPrice": 0.1,
"unit": "string"
}
]
}
],
"profit": 0.1,
"reference": "string",
"reservationsGroupedBySite": {
"property1": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string",
"siteName": "string"
}
],
"property2": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string",
"siteName": "string"
}
]
},
"reservedProducts": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string",
"siteName": "string"
}
],
"salesValue": 0.1,
"status": "DRAFT",
"subsidiaryId": "string",
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Cancel (partial) reservations of an order
AuthorizationBearer <token>
In: header
Path Parameters
id*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X PATCH "http://localhost:18080/api/v1/orders/string/reservations/cancel" \ -H "Content-Type: application/json" \ -d '[ { "productId": "string", "quantity": 0.1, "stockSiteId": "string" } ]'{
"cancelledProducts": [
{
"productId": "string",
"quantity": 0.1,
"unit": "string"
}
],
"clientId": "string",
"costValue": 0.1,
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currency": "string",
"deliveryAddress": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"derivedPaymentStatus": "UNPAID",
"directPayments": [
{
"amount": 0.1,
"createdBy": "string",
"currency": "string",
"id": "string",
"note": "string",
"paymentDate": "2019-08-24T14:15:22Z",
"paymentMethod": "CREDIT_CARD",
"receiptAsset": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"receiptGenerated": true,
"reference": "string"
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"expectedDeliveryDate": "2019-08-24T14:15:22Z",
"id": "string",
"internalCancellationReason": "string",
"internalReview": {
"approved": true,
"by": "string",
"on": "2019-08-24T14:15:22Z",
"reason": "string"
},
"invoiceIds": [
"string"
],
"invoicedAmount": 0.1,
"invoicedPercentage": 0.1,
"margin": 0.1,
"orderDate": "2019-08-24T14:15:22Z",
"packages": [
{
"dimension": {
"height": 0.1,
"length": 0.1,
"width": 0.1
},
"location": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"coordinate": {
"latitude": -90,
"longitude": -180
},
"name": "string"
},
"picklistId": "string",
"weight": 0.1
}
],
"paidAmount": 0.1,
"paymentMethod": "CREDIT_CARD",
"paymentPercentage": 0.1,
"paymentTerm": 0,
"picklistIds": [
"string"
],
"productStatus": [
{
"finishedQuantity": 0.1,
"productId": "string",
"quantityCanBeCancelled": 0.1,
"quantityCancelled": 0.1,
"quantityDelivered": 0.1,
"quantityOrdered": 0.1,
"quantityPending": 0.1,
"quantityPicked": 0.1,
"quantityReservedPicklist": 0.1,
"quantityReservedUnassigned": 0.1,
"quantityReturned": 0.1,
"quantityShipped": 0.1,
"returnStarted": true,
"unitPrice": 0.1
}
],
"products": [
{
"applicableDiscount": {
"active": true,
"clientTypes": [
"PERSON"
],
"name": "string",
"regions": [
"string"
],
"volumeThresholds": [
{
"discountPercentage": 1,
"minAmount": 1
}
]
},
"availableStock": 0.1,
"baseUnitConversion": 0.1,
"baseUnitQuantity": 0.1,
"currency": "string",
"discountedPrice": 0.1,
"imageAssets": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"pending": 0.1,
"price": 0.1,
"productCost": 0.1,
"productId": "string",
"productName": "string",
"productType": "RAW_MATERIAL",
"quantity": 0.1,
"quantityCancelled": 0.1,
"quantityDelivered": 0.1,
"quantityInvoiced": 0.1,
"quantityPicked": 0.1,
"quantityRemainingToInvoice": 0.1,
"quantityReturned": 0.1,
"quantityShipped": 0.1,
"reservations": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string",
"siteName": "string"
}
],
"returnStarted": true,
"totalReserved": 0.1,
"unit": "string",
"unitsOfMeasurement": [
{
"baseUnit": true,
"cost": 0.1,
"decimal": true,
"isBaseUnit": true,
"isDecimal": true,
"name": "string",
"quantity": 0.1,
"salesPrice": 0.1,
"unit": "string"
}
]
}
],
"profit": 0.1,
"reference": "string",
"reservationsGroupedBySite": {
"property1": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string",
"siteName": "string"
}
],
"property2": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string",
"siteName": "string"
}
]
},
"reservedProducts": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string",
"siteName": "string"
}
],
"salesValue": 0.1,
"status": "DRAFT",
"subsidiaryId": "string",
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}