Alpha API ReferenceOrder
Add or update package details
Adds or updates 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
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,
"number": "string",
"opportunityId": "string",
"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,
"sku": "string",
"supplierId": "string",
"supplierName": "string",
"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"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}