Skip to main content
POST
/
purchase-orders
/
create
Create Purchase Orders
curl --request POST \
  --url https://api-v2.production.higg.org/pic-api/v1/purchase-orders/create \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-developer-request-token: <api-key>' \
  --data '
{
  "productId": "<string>",
  "purchaseOrder": {
    "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,
        "finishedProductImpacts": 123
      },
      "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>"
}

Documentation Index

Fetch the complete documentation index at: https://developer.worldly.io/llms.txt

Use this file to discover all available pages before exploring further.

Use this endpoint to create a new purchase order and associate it with an existing product in your PIC library. Purchase orders track sourcing records and enable Scope 3 impact calculations. Purchases can optionally be linked to a Tier 1 FEM assessment by providing the assessment identifier in the purchaseOrder.assembly.femId field.

PIC - Create a Purchase Order

​
Request body params

NameTypeDescription
productIdstring[REQUIRED] The ID of the product to associate this purchase order with.
purchaseOrderobject[REQUIRED] The purchase order data.
purchaseOrder.purchaseOrderIdstringYour external purchase order identifier.
purchaseOrder.purchaseDatestringExpected purchase date in YYYY-MM-DD format; the field is a plain string in the API contract.
purchaseOrder.amountPurchasenumberThe quantity purchased.
purchaseOrder.assemblyobjectOptional FEM linking data.
purchaseOrder.assembly.femIdstringThe FEM assessment ID to link for Scope 3 calculations. Use Search Tier 1 Facilities to find available FEMs.

​
Implementation Details

  • Product association: The purchase order is added to the specified product. The product must exist and belong to your account.
  • FEM linking constraints: Products imported from the Higg Product Module cannot be linked to a FEM. This endpoint only accepts purchaseOrder.assembly.femId for FEM linking; any flags such as isDefault are derived by the server and may appear only in responses.
  • Date format: The expected format for purchaseDate is YYYY-MM-DD. The field is a plain string in the API contract.

Authorizations

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

Body

application/json
​
productId
string
required
​
purchaseOrder
object
required

Response

200 - application/json

Ok

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