Orders

Manage pick-pack orders

Finishing an order

post

Finishes a specified order by:

Recalculating the current state
Changing the order status to packed
Deleting all assignees
Sending an order confirmation email

Required scopes

This endpoint requires the following scopes:

: Needed to manage resources in the service.

Authorizations

OAuth2clientCredentialsRequired

Token URL:

Path parameters

tenantstring · min: 3 · max: 16Required

Your Emporix tenant name.

Note: The tenant name should always be written in lowercase.

Pattern: ^[a-z][a-z0-9]+$

orderIdstringRequired

Order's unique identifier.

Header parameters

saas-tokenstringRequired

Token provided by the Emporix system, used to identify logged in customers. This token has an expiry date and is signed with a passphrase.

Responses

200

Event creation response

application/json

messagestringOptional

codeintegerOptional

400

Request was syntactically incorrect. Details will be provided in the response payload.

application/json

401

Given request is unauthorized - the authorization token is invalid or has expired. Details will be provided in the response payload.

application/json

403

Given authorization scopes are not sufficient and do not match scopes required by the endpoint.

application/json

500

Internal Service Error occurred.

application/json

post

/pick-pack/{tenant}/orders/{orderId}/finish

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
}

Retrieving a packlist

get

Retrieves a packlist for the specified delivery date.

Note: If an order has the packingStatus set to CANCELLED, it will not be retrieved.

Required scopes

This endpoint requires the following scopes:

: Needed to retrieve information about resources in the service.

Authorizations

OAuth2clientCredentialsRequired

Token URL:

Path parameters

tenantstring · min: 3 · max: 16Required

Your Emporix tenant name.

Note: The tenant name should always be written in lowercase.

Pattern: ^[a-z][a-z0-9]+$

Query parameters

siteCodestring · min: 3 · max: 16Required

site code for the tenant

Pattern: [a-zA-Z0-9_-]+

deliveryDatestringRequired

Date after which we want to filter the orders.

Pattern: YYYY-MM-DD

Responses

200

Order list

application/json

orderIdstringOptional

The id of the order

Example: 01LIWJ40

customerNamestringOptional

The name of the customer

Example: John Smith

packingStatusstring · enumOptional

The current status of the order

Example: INITIALPossible values:

productsTotalintegerOptionalExample: 3000

productsPackedintegerOptionalExample: 2266

productsCanceledintegerOptionalExample: 734

holdingAreaNumberintegerOptional

The serial number of the location where the packed order awaits transportation

Example: 1

401

Given request is unauthorized - the authorization token is invalid or has expired. Details will be provided in the response payload.

application/json

403

Given authorization scopes are not sufficient and do not match scopes required by the endpoint.

application/json

500

Internal Service Error occurred.

application/json

get

/pick-pack/{tenant}/orders

GET /pick-pack/{tenant}/orders?siteCode=text&deliveryDate=text 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"
    }
  }
]

Retrieving an order

get

Retrieves a specified order's details.

Required scopes

This endpoint requires the following scopes:

: Needed to retrieve information about resources in the service.

Authorizations

OAuth2clientCredentialsRequired

Token URL:

Path parameters

tenantstring · min: 3 · max: 16Required

Your Emporix tenant name.

Note: The tenant name should always be written in lowercase.

Pattern: ^[a-z][a-z0-9]+$

orderIdstringRequired

Order's unique identifier.

Responses

200

Order

application/json

idstringOptional

The id of the packed order

Example: 123

siteCodestringOptional

The site code of the packed order

Example: main

orderTotalnumber · doubleOptional

The order total amount

Example: 10

valueOfGoodsnumber · doubleOptional

The order subtotal

Example: 9.5

depositnumber · doubleOptional

The order deposit amount

Example: 0.5

couponsnumber · doubleOptional

The order coupons amount

Example: 0

currencystringOptional

The order currency

Example: EUR

packingStatusstring · enumOptional

The current packing status of the order

Example: INITIALPossible values:

holdingAreaNumberintegerOptional

The order holding area number

Example: 10

401

Given request is unauthorized - the authorization token is invalid or has expired. Details will be provided in the response payload.

application/json

403

Given authorization scopes are not sufficient and do not match scopes required by the endpoint.

application/json

404

Resource has not been found.

application/json

500

Internal Service Error occurred.

application/json

get

/pick-pack/{tenant}/orders/{orderId}

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
}

Updating an order

patch

Updates a specified order's status.

Note: If the order has the packingStatus set to CANCELLED, it is not possible to do any further operations on that order.

Required scopes

This endpoint requires the following scopes:

: Needed to manage resources in the service.

Authorizations

OAuth2clientCredentialsRequired

Token URL:

Path parameters

tenantstring · min: 3 · max: 16Required

Your Emporix tenant name.

Note: The tenant name should always be written in lowercase.

Pattern: ^[a-z][a-z0-9]+$

orderIdstringRequired

Order's unique identifier.

Header parameters

saas-tokenstringRequired

Token provided by the Emporix system, used to identify logged in customers. This token has an expiry date and is signed with a passphrase.

Body

packingStatusstring · enumRequired

The new status of the order

Example: INITIALPossible values:

Responses

200

Event creation response

application/json

messagestringOptional

codeintegerOptional

400

Request was syntactically incorrect. Details will be provided in the response payload.

application/json

401

Given request is unauthorized - the authorization token is invalid or has expired. Details will be provided in the response payload.

application/json

403

Given authorization scopes are not sufficient and do not match scopes required by the endpoint.

application/json

404

Resource has not been found.

application/json

500

Internal Service Error occurred.

application/json

patch

/pick-pack/{tenant}/orders/{orderId}

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
}

Updating packaging products for an order

put

Updates packaging products for a specified order.

Required scopes

This endpoint requires the following scopes:

: Needed to manage resources in the service.

Authorizations

OAuth2clientCredentialsRequired

Token URL:

Path parameters

tenantstring · min: 3 · max: 16Required

Your Emporix tenant name.

Note: The tenant name should always be written in lowercase.

Pattern: ^[a-z][a-z0-9]+$

orderIdstringRequired

Order's unique identifier.

Header parameters

saas-tokenstringRequired

Token provided by the Emporix system, used to identify logged in customers. This token has an expiry date and is signed with a passphrase.

Bodyobject[]

entryIdstringRequired

The id of the product that was packed

Example: 123

packedCountintegerRequired

The amount of packed items

Example: 1

Responses

200

Event creation response

application/json

messagestringOptional

codeintegerOptional

400

Request was syntactically incorrect. Details will be provided in the response payload.

application/json

401

Given request is unauthorized - the authorization token is invalid or has expired. Details will be provided in the response payload.

application/json

403

Given authorization scopes are not sufficient and do not match scopes required by the endpoint.

application/json

404

Resource has not been found.

application/json

500

Internal Service Error occurred.

application/json

put

/pick-pack/{tenant}/orders/{orderId}/packaging

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
}

PreviousPick Pack NextOrder cycles

Last updated 1 month ago

Was this helpful?

Good night

hashtagFinishing an order

hashtagRetrieving a packlist

hashtagRetrieving an order

hashtagUpdating an order

hashtagUpdating packaging products for an order

Finishing an order

Retrieving a packlist

Retrieving an order

Updating an order

Updating packaging products for an order