PurchaseOrders API (Add whsId as PreAdviceValue)

This document provides detailed instructions on where and how to include the whsId parameter in the Purchase Orders API request using the purchaseOrderRowPreAdviceValue JSON (Extend Commerce API).

This will allow incoming goods to be labeled with pre-printed labels, enabling the customer to use these instead of our standard labels. The purpose is to ensure smooth handling and traceability by integrating the customer’s labels into our processes for warehouse movement and confirmation similar like SmartworkCode (Pallet id).

\uD83D\uDCD8 Instructions

Add Pallet id (whsId) to PurchaseOrders API:

Now it is possible to PreAdvice the Pallet id (whsId) like all other values that could be PreAdviced for a purchase order in purchaseOrderRowPreAdviceValue array of PurchaseOrders API by using POST request.

The “whsId” field must be used to add/set the PreAdvice Pallet id/Smartworkcode via PurchaseOrders API.
The preAdviceQuantity must also be set in the purchaseOrderRowPreAdviceValue for warehouse products in the PurchaseOrders API.

Important Note:
The whsId field is optional and should be a string.

If whsId is not specified, the process will work as before.

Change in PurchaseOrders API Model:

Following is the sample JSON for the PurchaseOrders API to PreAdvice (add) the whsId (Pallet id).

POST Request:

{
"header": {
"purchaseNumber": "ExtendTest001",
"externalOrderNumber": "",
"warehouse": "HJH",
"supplier": {
"supplierNumber": "505",
"supplierAgreementNumber": 505
}
},
"rows": [
{
"productNumber": "00001_zain_warehouse",
"purchaseDataPurchaseUnit": {
"quantity": 10,
"unit": "ST"
},
"purchaseDataProductUnit": {
"quantity": 10,
"unit": "ST",
"unitPrice": 2,
"vatPercent": 25,
"currency": "DKK"
},
"expectedDeliveryDate": "2025-01-31T00:00:00+01:00",
"purchaseOrderRowPreAdviceValue": [
{
"serialNumber": null,
"batchNumber": null,
"bestBeforeDate": null,
"iMEINumber": null,
"macAddress": null,
"antiTheftID": null,
"uUID": null,
"mSPKID": null,
"wLANMAC": null,
"packageInfo": null,
"palletInfo": null,
"iMEI2": null,
"computerName": null,
"assetNumber": null,
"preAdviceQuantity": 10,
"whsId": "ExtendTest001"
}
]
}
]
}

API Response Body:

{
  "header": {
    "purchaseNumber": "ExtendTest001",
    "externalOrderNumber": "",
    "supplierOrderNumber": null,
    "status": "Ordered",
    "createDate": "2025-01-08T22:30:37.473+01:00",
    "warehouse": "HJH",
    "deliveryAddress": {
      "name1": "HJH Hansen",
      "name2": "Engroslager (afgiftsfrit)",
      "address1": "Tolderlundsvej 103 HJHWarehouse",
      "address2": "Zain HJHWarehouse Address2",
      "address3": null,
      "postalCode": "5000",
      "city": "Odense CHJHWH",
      "state": null,
      "countryCode": "DK",
      "doorCode": null
    },
    "supplier": {
      "supplierNumber": "505",
      "supplierName": "hzkazmi supplier",
      "supplierAgreementNumber": 505,
      "supplierAgreement": "hzkazmi-sa",
      "supplierAgreementAddress": {
        "name1": "hzkazmi supplier",
        "name2": null,
        "address1": "ISB",
        "address2": null,
        "address3": null,
        "postalCode": "5200",
        "city": "Odense V",
        "state": null,
        "countryCode": "DK",
        "doorCode": null
      },
      "supplierContact": {
        "name": "",
        "phone": null,
        "email": null
      },
      "paymentTerms": "30",
      "deliveryMethod": "CONS_91",
      "deliveryMethodName": "PostNordParcel-ZainAPIP",
      "transportCondition": "AVT",
      "forwarder": "PostNord",
      "forwarderCustomerNumber": ".",
      "transportConditionDescription": "24 X 12 con"
    },
    "buyerContact": {
      "name": "ZAIN KAZMI",
      "phone": "03336506505",
      "email": "shzkazmi@gmail.com"
    },
    "reference": null,
    "notes": null,
    "internalNotes": null,
    "currencyExchangeRate": null,
    "shippedDate": null,
    "requestedDeliveryDate": null,
    "autoReception": false
  },
  "rows": [
    {
      "position": 10,
      "subPosition": 0,
      "externalPosition": null,
      "externalSubPosition": null,
      "rowStatus": "Ordered",
      "statusChangeDate": "2025-01-08T22:30:37.523+01:00",
      "productNumber": "00001_zain_warehouse",
      "productName": "00001_zain_warehouse",
      "supplierProductNumber": null,
      "purchaseDataPurchaseUnit": {
        "quantity": 10,
        "unit": "ST",
        "gtiNumber": "1234567899508"
      },
      "purchaseDataProductUnit": {
        "quantity": 10,
        "unit": "ST",
        "unitPrice": 2,
        "vatPercent": 25,
        "currency": "DKK",
        "unitExplicitCost": null,
        "listPrice": null,
        "unitExplicitCurrency": null
      },
      "expectedDeliveryDate": "2025-01-31T00:00:00+01:00",
      "originalExpectedDeliveryDate": "2025-01-31T00:00:00+01:00",
      "shipDate": null,
      "requestedDeliveryDate": null,
      "notes": null,
      "purchaseCode": null,
      "purchaseCodeName": null,
      "loadingPurchaseCode": null,
      "loadingPurchaseCodeName": null,
      "unitDetails": [],
      "purchaseOrderRowPreAdviceValue": [
        {
          "serialNumber": null,
          "batchNumber": null,
          "bestBeforeDate": null,
          "iMEINumber": null,
          "macAddress": null,
          "antiTheftID": null,
          "uUID": null,
          "mSPKID": null,
          "wLANMAC": null,
          "packageInfo": null,
          "palletInfo": null,
          "iMEI2": null,
          "computerName": null,
          "assetNumber": null,
          "preAdviceQuantity": 10,
          "whsId": "ExtendTest001"
        }
      ],
      "autoReceptionStoragePlace": null
    }
  ],
  "shipments": []
}

WMS:

Summary

Use the purchaseOrderRowPreAdviceValue array to include whsId (Pallet ID) in your Purchase Orders API request.

Ensure preAdviceQuantity is set for all required items.

If whsId is not provided, the system will continue with the default process.

For further assistance, refer to the Extend Commerce API documentation or contact support.