Create a Bill of Materials

HTTP Request

POST /v1/bill-of-materials

Summary

This operation creates a bill of materials.

Request URLs

Sandbox: https://shipping-api-sandbox.pitneybowes.com/shippingservices/fulfillment/v1/bill-of-materials
Production: https://shipping-api.pitneybowes.com/shippingservices/fulfillment/v1/bill-of-materials

Request Headers

Name


Description

Authorization

Required. OAuth token generated using the Generate an OAuth Token API.

X-PB-TransactionId

Required. A unique identifier for the request, up to 25 characters. The following characters are allowed: letters, numbers, hyphens (-), and underscores (_).

Important: Ensure this is a unique ID.

Request / Response Elements

This POST operation sends and receives the BOM object, described in the table below. Fields required in the request are marked Required. All other fields are optional, except fields marked RESPONSE ONLY, which appear only in the response.

Name

Data Type

Description

clientId

String

Required. The client ID assigned by Pitney Bowes.

brand

String

The manufacturer’s brand name for the item.

Maximum length: 30 characters

description

String

Required. Description of the bill of materials.

Maximum length: 30 characters

node

String

The ID for the Pitney Bowes Fulfillment Center where the kitting takes place.

active

Boolean

If true, the product is active.

Default: true

createDate

String

The date and time the bill of materials was created in the client system, specified in the ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

updateDate

String

The date and time the bill of materials was updated in the client system, specified in the ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

pbCreateDate

String

RESPONSE ONLY. The date and time the bill of materials was created in the Pitney Bowes system, specified in the ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

pbUpdateDate

String

RESPONSE ONLY. The date and time the bill of materials was updated in the Pitney Bowes system, specified in the ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

billofMaterialId

String

RESPONSE ONLY. The ID assigned to the bill of materials by Pitney Bowes.

sku

String

Required. The SKU for the produced kit. The kit must be part of the master catalog.

Maximum length: 30 characters

billOfMaterialDetails

Array[BOM Details Object]

Required. The bill of materials. Each object in the array is a different bill of materials.

notes

Array[String]

Notes associated with the bill of materials.

Maximum length: 50 characters

instructions

Array[Object]

Reserved for future use.

instructions.instruction

String

Reserved for future use.

instructions.active

Boolean

Reserved for future use.

instructions.image

Image Object

Reserved for future use.

Sample Request

curl -X POST ".../v1/bill-of-materials" \
-H "Authorization: Bearer <oauth_token>" \
-H "X-PB-TransactionId: <unique_identifier>" \
-d '
{
    "clientId": "1234",
    "description": "Welcome Kit",
    "node": "160",
    "active": true,
    "createDate": "2022-04-05T14:35:55Z",
    "sku": "12345678",
    "billOfMaterialDetails": [ {
        "childSku": "12345abcd",
        "quantity": 2,
        "sequence": [],
        "instructions": []
    },
    ...
    ]
}'

Sample Response

{
    "clientId": "1234",
    "description": "Welcome Kit",
    "node": "160",
    "active": true,
    "createDate": "2022-04-05T14:35:55Z",
    "pbCreateDate": "2022-04-05T14:35:55Z",
    "billOfMaterialId": "BM123456781234567812345678US",
    "sku": "12345678",
    "billOfMaterialDetails": [ {
        "childSku": "12345abcd",
        "quantity": 2,
    },
    ...
    ]
}

Error Codes

For lists of error codes returned by the Fulfillment APIs, please see 80-Prefix Error Codes (Fulfillment APIs).