Skip to main content
POST
/
purchase-orders
/
update
Update Purchase Orders
curl --request POST \
  --url https://api-v2.production.higg.org/pic-api/v1/purchase-orders/update \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-developer-request-token: <api-key>' \
  --data '
{
  "productId": "<string>",
  "purchaseOrder": {
    "_id": "<string>",
    "purchaseOrderId": "<string>",
    "purchaseDate": "<string>",
    "amountPurchase": 123,
    "assembly": {
      "femId": "<string>"
    }
  }
}
'
{
  "productId": "<string>",
  "purchaseOrder": [
    {
      "_id": "<string>",
      "assembly": {
        "isDefault": true,
        "femId": "<string>",
        "facilityName": "<string>",
        "finalAssemblyRawText": "<string>",
        "surveyVersion": "<string>",
        "finalAssemblyImpacts": 123,
        "printingProductDyeingImpacts": 123,
        "totalNormalizedImpacts": 123,
        "sipfacilitytype": [
          "<string>"
        ],
        "annualProd": "<string>",
        "country": "<string>",
        "femDescriptor": "<string>",
        "year": 123,
        "assessmentStatus": "NS"
      },
      "purchaseOrderId": "<string>",
      "purchaseDate": 123,
      "impactPerUnit": 123,
      "totalImpactPerUnit": 123,
      "pmVersion": "<string>",
      "msiVersion": "<string>",
      "version": "<string>",
      "amountPurchase": 123,
      "isOutdated": true,
      "impactsPerUnitMultiPack": {
        "materialImpact": 123,
        "tier1Impact": 123,
        "packagingImpact": 123,
        "logisticsImpactsUpstreamTD": 123,
        "logisticsImpactsDTImpact": 123,
        "logisticsImpactsDCImpact": 123,
        "logisticsImpactsRetailImpact": 123,
        "productCareImpacts": 123,
        "endOfUseImpact": 123,
        "totalProductImpacts": 123,
        "componentImpact": 123
      },
      "totalImpactsMultiPack": {
        "materialImpact": 123,
        "tier1Impact": 123,
        "packagingImpact": 123,
        "logisticsImpactsUpstreamTD": 123,
        "logisticsImpactsDTImpact": 123,
        "logisticsImpactsDCImpact": 123,
        "logisticsImpactsRetailImpact": 123,
        "productCareImpacts": 123,
        "endOfUseImpact": 123,
        "totalProductImpacts": 123,
        "componentImpact": 123
      },
      "impactsPerUnit": {
        "materialImpact": 123,
        "tier1Impact": 123,
        "packagingImpact": 123,
        "logisticsImpactsUpstreamTD": 123,
        "logisticsImpactsDTImpact": 123,
        "logisticsImpactsDCImpact": 123,
        "logisticsImpactsRetailImpact": 123,
        "productCareImpacts": 123,
        "endOfUseImpact": 123,
        "totalProductImpacts": 123,
        "componentImpact": 123
      },
      "totalImpacts": {
        "materialImpact": 123,
        "tier1Impact": 123,
        "packagingImpact": 123,
        "logisticsImpactsUpstreamTD": 123,
        "logisticsImpactsDTImpact": 123,
        "logisticsImpactsDCImpact": 123,
        "logisticsImpactsRetailImpact": 123,
        "productCareImpacts": 123,
        "endOfUseImpact": 123,
        "totalProductImpacts": 123,
        "componentImpact": 123
      }
    }
  ],
  "createdOn": "<string>"
}
Use this endpoint to update an existing purchase order. You can modify the purchase order details and FEM assembly linking.

​
Request body params

Field NameData TypeDescription
productIdstring[REQUIRED] The ID of the product the purchase order belongs to.
purchaseOrderobject[REQUIRED] The updated purchase order data.
purchaseOrder._idstring[REQUIRED] The internal ID of the purchase order to update.
purchaseOrder.purchaseOrderIdstringUpdated external purchase order identifier.
purchaseOrder.purchaseDatestringUpdated purchase date. Expected format is YYYY-MM-DD; the field is a plain string in the API contract.
purchaseOrder.amountPurchasenumberUpdated quantity purchased.
purchaseOrder.assemblyobjectUpdated FEM linking data.
purchaseOrder.assembly.femIdstringThe FEM assessment ID to link. Use Search Tier 1 Facilities to find available FEMs.

​
Implementation Details

  • Partial updates: Only the fields you provide will be updated. Omitted fields retain their existing values.
  • FEM linking constraints: Same rules as create — products imported from the Higg Product Module cannot link to a FEM.
  • Recalculation: After updating a purchase order, you may need to recalculate to refresh its impact data.

Authorizations

​
x-api-key
string
header
required
​
x-developer-request-token
string
header
required

Body

application/json

API corp rep products

​
productId
string
required
​
purchaseOrder
object
required

Response

200 - application/json

Ok

​
productId
string
required
​
purchaseOrder
object[]
required
​
createdOn
string
required