Orders
Manage pick-pack orders
Your Emporix tenant's name.
Note: The tenant name should always be written in lowercase.
^[a-z][a-z0-9]+$
Order's unique identifier.
Token provided by the Emporix system, used to identify logged in customers. This token has an expiry date and is signed with a passphrase.
POST /pick-pack/{tenant}/orders/{orderId}/finish HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
saas-token: text
Accept: */*
{
"message": "Success",
"code": 200
}
Your Emporix tenant's name.
Note: The tenant name should always be written in lowercase.
^[a-z][a-z0-9]+$
site code for the tenant
[a-zA-Z0-9_-]+
Date after which we want to filter the orders.
YYYY-MM-DD
GET /pick-pack/{tenant}/orders HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
{
"orderId": "01LIWJ40",
"customerName": "John Smith",
"packingStatus": "INITIAL",
"productsTotal": 3000,
"productsPacked": 2266,
"productsCanceled": 734,
"assignees": [
{
"id": "123",
"siteCode": "main",
"firstName": "John",
"lastName": "Smith"
}
],
"packagingProducts": [
{
"entryId": "123",
"productName": "Test product name",
"productId": "123",
"unitPrice": 1,
"totalPrice": 3,
"imageUrl": "http://sample-image.com",
"unitPricingMeasure": {
"unitCode": "H87",
"value": "100"
},
"pricingMeasure": {
"unitCode": "H87",
"value": "100"
},
"pricingMeasurePrice": 2,
"orderUnit": "H87",
"packedCount": 1,
"canceledCount": 0,
"pickedCount": 1,
"packedAmountInPc": 1,
"totalCount": 10,
"location": [
{
"zone": "text",
"rack": "text",
"rackName": "text",
"shelf": "text",
"section": "text",
"bin": "text"
}
],
"packingGroup": "test group",
"packaging": "sample packaging",
"cutting": "sample cutting",
"customerComment": "Sample comment",
"barcodes": [
"abc123"
],
"weightDependent": false,
"basePrice": {
"effectiveAmount": "10",
"originalAmount": "5",
"priceFactor": "1",
"basePriceFactor": "2",
"measurementUnit": {
"unitCode": "H87",
"quantity": 5
}
},
"mhd": "text"
}
],
"entries": [
{
"entryId": "123",
"productName": "Test product name",
"productId": "123",
"unitPrice": 1,
"totalPrice": 3,
"imageUrl": "http://sample-image.com",
"unitPricingMeasure": {
"unitCode": "H87",
"value": "100"
},
"pricingMeasure": {
"unitCode": "H87",
"value": "100"
},
"pricingMeasurePrice": 2,
"orderUnit": "H87",
"packedCount": 1,
"canceledCount": 0,
"pickedCount": 1,
"packedAmountInPc": 1,
"totalCount": 10,
"location": [
{
"zone": "text",
"rack": "text",
"rackName": "text",
"shelf": "text",
"section": "text",
"bin": "text"
}
],
"packingGroup": "test group",
"packaging": "sample packaging",
"cutting": "sample cutting",
"customerComment": "Sample comment",
"barcodes": [
"abc123"
],
"weightDependent": false,
"basePrice": {
"effectiveAmount": "10",
"originalAmount": "5",
"priceFactor": "1",
"basePriceFactor": "2",
"measurementUnit": {
"unitCode": "H87",
"quantity": 5
}
},
"mhd": "text"
}
],
"holdingAreaNumber": 1,
"deliveryWindow": {
"deliveryCycle": "2023-10-13-11-Test",
"deliveryCycleName": "Test",
"deliveryTimeTo": "1970-01-01T17:00:00.000+0000"
}
}
]
Your Emporix tenant's name.
Note: The tenant name should always be written in lowercase.
^[a-z][a-z0-9]+$
Order's unique identifier.
GET /pick-pack/{tenant}/orders/{orderId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"id": "123",
"siteCode": "main",
"orderTotal": 10,
"valueOfGoods": 9.5,
"deposit": 0.5,
"coupons": 0,
"currency": "EUR",
"entries": [
{
"entryId": "123",
"productName": "Test product name",
"productId": "123",
"unitPrice": 1,
"totalPrice": 3,
"imageUrl": "http://sample-image.com",
"unitPricingMeasure": {
"unitCode": "H87",
"value": "100"
},
"pricingMeasure": {
"unitCode": "H87",
"value": "100"
},
"pricingMeasurePrice": 2,
"orderUnit": "H87",
"packedCount": 1,
"canceledCount": 0,
"pickedCount": 1,
"packedAmountInPc": 1,
"totalCount": 10,
"location": [
{
"zone": "text",
"rack": "text",
"rackName": "text",
"shelf": "text",
"section": "text",
"bin": "text"
}
],
"packingGroup": "test group",
"packaging": "sample packaging",
"cutting": "sample cutting",
"customerComment": "Sample comment",
"barcodes": [
"abc123"
],
"weightDependent": false,
"basePrice": {
"effectiveAmount": "10",
"originalAmount": "5",
"priceFactor": "1",
"basePriceFactor": "2",
"measurementUnit": {
"unitCode": "H87",
"quantity": 5
}
},
"mhd": "text"
}
],
"customer": {
"id": "123",
"title": "Mr",
"firstName": "John",
"lastName": "Smith",
"name": "sample name",
"companyName": "sample company name",
"email": "[email protected]",
"phoneNumber": "123123123"
},
"delivery": {
"deliveryTimeModel": {
"deliveryDate": "2019-05-16",
"deliveryTimeFrom": "12:00:00",
"deliveryTimeTo": "23:00:00",
"deliveryChargeType": "text"
},
"deliveryAddressModel": {
"title": "MRS",
"contactName": "John Smith",
"companyName": "Sample company name",
"street": "5th Avenue",
"streetNumber": "13",
"streetAppendix": "PA",
"zip": "11211",
"city": "NYC Williamsburg",
"country": "United States"
},
"deliveryCostModel": {
"amount": 3.9,
"currency": "EUR"
},
"deliveryOptionModel": {
"packaging": "Paper",
"replacement": true,
"pickup": false,
"deliveryNote": "Sample comment"
},
"deliveryWindow": {
"deliveryCycle": "2023-10-13-11-Test",
"deliveryCycleName": "Test",
"deliveryTimeTo": "1970-01-01T17:00:00.000+0000"
}
},
"payment": {
"invoiceNumber": "GCI191232",
"invoiceAddress": {
"title": "MRS",
"contactName": "John Smith",
"companyName": "Sample company",
"street": "5th Avenue",
"streetNumber": "12",
"streetAppendix": "PA",
"zip": "11211",
"city": "NYC Williamsburg",
"country": "United States"
},
"methods": [
"paymentByDebit"
]
},
"packingStatus": "INITIAL",
"assignees": [
{
"id": "123",
"siteCode": "main",
"firstName": "John",
"lastName": "Smith"
}
],
"packagingProducts": [
{
"entryId": "123",
"productName": "Test product name",
"productId": "123",
"unitPrice": 1,
"totalPrice": 3,
"imageUrl": "http://sample-image.com",
"unitPricingMeasure": {
"unitCode": "H87",
"value": "100"
},
"pricingMeasure": {
"unitCode": "H87",
"value": "100"
},
"pricingMeasurePrice": 2,
"orderUnit": "H87",
"packedCount": 1,
"canceledCount": 0,
"pickedCount": 1,
"packedAmountInPc": 1,
"totalCount": 10,
"location": [
{
"zone": "text",
"rack": "text",
"rackName": "text",
"shelf": "text",
"section": "text",
"bin": "text"
}
],
"packingGroup": "test group",
"packaging": "sample packaging",
"cutting": "sample cutting",
"customerComment": "Sample comment",
"barcodes": [
"abc123"
],
"weightDependent": false,
"basePrice": {
"effectiveAmount": "10",
"originalAmount": "5",
"priceFactor": "1",
"basePriceFactor": "2",
"measurementUnit": {
"unitCode": "H87",
"quantity": 5
}
},
"mhd": "text"
}
],
"holdingAreaNumber": 10
}
Your Emporix tenant's name.
Note: The tenant name should always be written in lowercase.
^[a-z][a-z0-9]+$
Order's unique identifier.
Token provided by the Emporix system, used to identify logged in customers. This token has an expiry date and is signed with a passphrase.
The new status of the order
INITIAL
Possible values: PATCH /pick-pack/{tenant}/orders/{orderId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
saas-token: text
Content-Type: application/json
Accept: */*
Content-Length: 31
{
"packingStatus": "IN_PROGRESS"
}
{
"message": "Success",
"code": 200
}
Your Emporix tenant's name.
Note: The tenant name should always be written in lowercase.
^[a-z][a-z0-9]+$
Order's unique identifier.
Token provided by the Emporix system, used to identify logged in customers. This token has an expiry date and is signed with a passphrase.
The id of the product that was packed
123
The amount of packed items
1
PUT /pick-pack/{tenant}/orders/{orderId}/packaging HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
saas-token: text
Content-Type: application/json
Accept: */*
Content-Length: 35
[
{
"entryId": "123",
"packedCount": 1
}
]
{
"message": "Success",
"code": 200
}
Was this helpful?