Create or Update Multiple Products¶

HTTP Request¶

POST /v1/products/bulk

Summary¶

This operation creates and updates multiple products at once in the master catalog.

Request URLs¶

Sandbox: https://shipping-api-sandbox.pitneybowes.com/shippingservices/fulfillment/v1/products/bulk
Production: https://shipping-api.pitneybowes.com/shippingservices/fulfillment/v1/products/bulk

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 Elements¶

Name	Data Type	Description
products	Array[Object]	The products. Each object in the array is a separate product.
products.clientId	String	Required. The client ID assigned by Pitney Bowes.
products.productType	String	Required. Identifies the product as one of the following: `ITEM` `KIT`
products.sku	String	Required. The SKU used to track the product in the warehouse. Maximum length: 30 characters
products.details	Product Details Object	Required.
products.operation	String	Specifies whether to create or update a product. Enter one of the following: `CREATE` `UPDATE`

Response Elements¶

Name	Data Type	Description
products	Array[Object]	The products. Each object in the array is a separate product.
products.clientId	String	The client identifier assigned by Pitney Bowes.
products.sku	String	The SKU used to track the product in the warehouse.
products.status	String	This is either `PUBLISHED` or `UNPUBLISHED`.

Sample Request¶

curl -X POST ".../v1/products/bulk" \
-H "Authorization: Bearer <oauth_token>" \
-H "X-PB-TransactionId: <unique_identifier>" \
-d '
{
    "products": [ {
        "clientId": "1234",
        "productType": "KIT",
        "sku": "1642789877_1",
        "details": {
            "description": "sweater dress"
        },
        "operation": "CREATE"
    }, {
        "clientId": "1234",
        "productType": "KIT",
        "sku": "1642789877_2",
        "details": {
            "description": "patterned dress"
        },
        "operation": "CREATE"
        }
    }, {
        "clientId": "1234",
        "productType": "KIT",
        "sku": "1642789877_3",
        "details": {
            "description": "tunic dress"
        },
        "operation": "CREATE"
        }
    } ]
}'

Sample Response¶

{
    "products": [ {
        "clientId": "1234",
        "sku": "1642789877_1",
        "status": "PUBLISHED"
    },{
        "clientId": "1234",
        "sku": "1642789877_2",
        "status": "PUBLISHED"
    },{
        "clientId": "1234",
        "sku": "1642789877_3",
        "status": "PUBLISHED"
    } ]
}

Error Codes¶

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