Note

The Fulfillment APIs are coming soon.

Resource Objects for the Fulfillment APIs

This page describes common JSON objects used by the Fulfillment APIs. For objects not listed here, see the specific API operation. For objects used by Shipping and Accounts, see click here.

This page describes the following common resource objects:

Address

Products

ASN

References

BOM

Returns

Dimensions

Shipping Details

Image

Weight

Orders

Work Orders

Address Object (Fulfillment)

Name

Data Type

Description

addressLines

Array[String]

Street address or P.O. Box. Include apartment number if applicable. You can specify up to 3 address lines.

Maximum length: 100 characters

cityTown

String

The city or town.

Maximum length: 50 characters

stateProvince

String

The state or province.

Maximum length: 50 characters

postalCode

String

The postal code or ZIP code.

Maximum length: 20 characters

countryCode

String

The ISO-2 country code.

Maximum length: 2 characters

company

String

The name of the company.

Maximum length: 50 characters

name

String

The first and last name.

Maximum length: 100 characters

phone

String

The phone number. Enter the digits with or without spaces or hyphens.

Maximum length: 25 characters

email

String

The email address.

Maximum length: 70 characters

 

ASN Object

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

inboundType

String

Required. The type of inbound shipment. Possible values:

  • PO: Purchase Order

  • ASN: Advanced Shipment Notification

clientASNId

String

Required. A unique order ID assigned by the client.

Maximum length: 35 characters

purchaseOrderNumber

String

The purchase order number.

Maximum length: 35 characters

invoiceNumber

String

Reserved for future use.

receivingNode

String

Required. The ID of the facility that will receive the incoming shipment.

vendorDetails

Object

Required. The vendor.

vendorDetails.name

String

The name of the vendor.

Maximum length: 50 characters

vendorDetails.code

String

The unique code assigned to the vendor.

receivingASNId

String

RESPONSE ONLY. The ASN ID assigned by Pitney Bowes.

status

String

RESPONSE ONLY. The status of the ASN. Possible values:

  • CREATED

  • INPROGRESS

  • UPDATED

  • ARRIVED

  • COMPLETE

  • CANCELED

shippingDetails

Shipping Details Object

The carrier details for the shipment.

orderDate

String

Required. The date and time the ASN was ordered, specified in the ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

expectedDeliveryDate

String

Required. The date and time the shipment is expected to be delivered to Pitney Bowes, specified in the ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

pbCreateDate

String

RESPONSE ONLY. The date and time the ASN 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 ASN was updated in the Pitney Bowes system, specified in the ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

pbDeliveredDate

String

RESPONSE ONLY. The date and time the ASN was delivered to Pitney Bowes, specified in the ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

totalWeight

Weight Object

The weight of the shipment.

totalWeight.weight

Number

The weight.

totalWeight.unitOfMeasurement

String

The weight’s unit of measurement. Possible value:

  • LB: Pounds

totalVolume

Object

The volume of the shipment.

totalVolume.volume

String

The volume.

totalVolume.unitOfMeasurement

String

The volume’s unit of measurement. Possible values:

  • CubicInches

  • CubicFeet

  • CubicCentimeters

  • CubicMeter

fromAddress

Address Object

The address of the shipper.

toAddress

Address Object

Required. The address of the facility where the shipment will be received. The toAddress object requires the following fields:

  • name

  • addressLines

  • cityTown

  • stateProvince

  • postalCode

  • countryCode

billingAddress

Address Object

Reserved for future use.

additionalReferences

Array[Object]

Defines customer reference information for the ASN. The objects in the array take the following two fields:

  • name: Takes a String value that defines the reference the field.

    Maximum length: 50 characters

  • value: Takes a String value that defines the reference value.

    Maximum length: 255 characters

asnLines

Array[ASN Lines Object]

The line-level details of the ASN.

 

ASN Lines Object

Name

Data Type

Description

lineId

Number

The line ID assigned by the client.

purchaseOrderNumberLineId

Number

The line ID for the purchase order, as assigned by the client.

PBlineId

Number

RESPONSE ONLY. The line ID assigned by Pitney Bowes.

sku

String

Required. The SKU from the master catalog.

alternateSKU

String

Reserved for future use.

inventoryType

String

The type of item inventory. Possible values:

  • NEW (default)

  • REFURBISHED (Reserved for future use)

originCountryCode

String

Required. The ISO-2 country code.

Maximum length: 2 characters

expectedQuantity

Number

Required. The total quantity of the item arriving.

unitOfMeasurement

String

The unit of measure for the container. Possible values:

  • Each (default)

  • Case

estimatedDeliveryDate

String

The date and time the order is expected to be delivered, specified in the ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

costDetails

Object

Details about product price and cost.

costDetails.retailPrice

Number

Retail price of the product.

costDetails.wholeSalePrice

Number

Wholesale price of the product.

costDetails.unitCost

Number

Unit cost of the product.

costDetails.currency

String

The ISO-2 country code.

Maximum length: 2 characters

licensePlateDetails

Array[Object]

Reserved for future use.

licensePlateDetails.licensePlate

String

Reserved for future use.

licensePlateDetails.lotNumber

String

Reserved for future use.

licensePlateDetails.lotExpirationDate

String

Reserved for future use.

licensePlateDetails.expectedQuantity

Number

Reserved for future use.

 

BOM Object

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.

 

BOM Details Object

Name

Data Type

Description

childSku

String

Required. The SKU of the child product from the master catalog.

Maximum length: 30 characters

quantity

Number

Required. The quantity of the child product.

sequence

Array[String]

Reserved for future use.

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.

 

Dimensions Object (Fulfillment)

Name

Data Type

Description

length

Number, up to 4 decimal places

The parcel’s longest dimension.

height

Number, up to 4 decimal places

The parcel’s second longest dimension.

width

Number, up to 4 decimal places

The parcel’s shortest dimension.

dimensionUOM
or
unitOfMeasurement

String

The unit of measurement. Possible value:

  • IN: Inches

 

Image Object (Fulfillment)

Name

Data Type

Description

imageURL

String

The URL that links to an image of the product.

Maximum length: 300 characters

imageContent

String

The image, entered as a Base64-encoded string.

fileName

String

The filename of image.

Maximum length: 255 characters

fileFormat

String

The file format for the image. Possible values:

  • PDF

  • JPEG

  • GIF

  • PNG

 

Orders Object

Name

Data Type

Description

clientId

String

Required. The client ID assigned by Pitney Bowes.

orderId

String

RESPONSE ONLY. The order ID assigned by Pitney Bowes.

clientOrderId

String

Required. The order ID assigned by the client.

Maximum length: 50 characters

customerOrderId

String

The customer-specific order number. Typically this is the order number from the website or ERP system.

Maximum length: 50 characters

brand

String

The manufacturer’s brand name for the item.

Maximum length: 50 characters

references

Array[References Object]

Additional reference information for the order. Each object in the array is a name-value pair that defines a reference field and value.

salesChannel

Object

Reserved for future use.

shippingDetails

Shipping Details Object

Required. The carrier details for the order.

orderType

String

The type of order. Possible values:

  • eCom (default)

  • Retail

createDate

String

Required. The date and time the order was created in the client system, specified in the ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

updateDate

String

The date and time the order 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 order was created in the Pitney Bowes system, returned in the ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

pbUpdateDate

String

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

fromNode

String

The warehouse facility ID.

shipOnDate

String

The date and time by which the order is promised to be shipped, specified in the ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

fulfillmentReleaseDate

String

The date and time the order is to be released for fulfillment, specified in the ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

promisedDeliveryDate

String

The date and time the order is promised to be delivered, specified in the ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

orderHandling

String

Possible value:

  • X: Normal (default)

  • R: Rush order (Reserved for future use)

  • E: Emergency order (Reserved for future use)

orderLines

Array[Order Lines Object]

Required. The items included in the order.

orderCharges

Order Charges Object

Cost details.

toAddress

Address Object

Required. The order’s destination address.

billingAddress

Address Object

The order’s billing address.

isGift

Boolean

If true, the order is a gift.

giftMessageText

String

The gift message to be printed on the pack slip and included in the shipment.

Maximum length: 1,024 characters

valueAddedServices

Array[Object]

Reserved for future use.

paymentDetails

Array[Object]

Reserved for future use.

customsInfo

Object

Customs information for an international order.

customsInfo.customsDeclaredValue

Number

The value that is declared in customs.

customsInfo.importerCustomsReference

String

A reference number used by the importer, such as a VAT number, PO number, or insured number.

Maximum length: 100 characters

customsInfo.importerCustomsReferenceType

String

The type of reference number.

Maximum length: 50 characters

status

String

RESPONSE ONLY. Status of the order. Possible values are:

  • BACKORDER

  • CANCELED

  • HOLD

  • INPROGRESS

  • ONHOLD

  • RECEIVED

  • RETURNED

  • SHIPPED

isOnHold

Boolean

RESPONSE ONLY. If true, the order is on hold.

holdReason

Array[String]

RESPONSE ONLY. Reason codes for the hold.

internalNotes

String

Any notes associated with the order for internal reference.

Maximum length: 255 characters

 

Order Lines Object

Name

Data Type

Description

lineId

Number

The line ID assigned to the item by the client.

sku

String

Required. The SKU used to track the item in the warehouse.

Maximum length: 60 characters

originCountryCode

String

The two-character ISO country code of the item’s manufacturing country. Use ISO alpha-2 code

Maximum length: 2 characters

originStateProvince

String

The state or province where the item was manufactured.

Maximum length: 50 characters

unitPrice

Number

The price of single unit of the item.

orderedQuantity

Number

Required. The number of items ordered.

lineTotal

Number

The total price for the line, excluding shipping and taxes.

hSTariffCode

String

The destination country’s tariff-classification number for the commodity. Most countries use the six-digit Harmonized System (HS) as the basis for their tariff classifications and add additional digits for more detail. The maximum length is 14 characters.

hSTariffCodeCountry

String

The two-character ISO Country Code for the destination country.

inventoryType

String

The type of item inventory. Possible values:

  • NEW (default)

  • REFURBISHED (Reserved for future use)

additionalDetails

Additional Details Object

Reserved for future use.

 

Additional Details Object

Note

This object is reserved for future use.

Name

Data Type

Description

alternateSKU

String

The SKU of an alternate item to be used if the specific item is not available.

Maximum length: 30 characters

lotNumber

String

The lot number from which to ship the item.

Maximum length: 20 characters

releaseAfterDate

String

The date and time the order is to be released for fulfillment, specified in the ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

promisedShipDate

String

The date and time the order is to be shipped, specified in the ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

promisedDeliveryDate

String

The date and time the order should be delivered, specified in the ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

additionalReferences

Array[Object]

Defines custom references. The objects in the array take the following two fields:

  • name: Takes a String that defines the type of service from a set of predefined codes.

  • value: Takes a String that provides details on the service.

valueAddedServices

Array[Object]

Defines value-added services. The objects in the array take the following two fields:

  • type: Takes a String that defines the type of service from a set of predefined codes.

  • details: Takes a String that provides details on the service.

 

Order Charges Object

Name

Data Type

Description

orderCurrency

String

The type of currency used for the order. Use three uppercase letters, per ISO 4217. For example, USD for US Dollars, CAD for Canadian Dollars, or EUR for Euros. For all currency codes, see https://www.iso.org/iso-4217-currency-codes.html.

shippingAmount

Number

The shipping cost.

totalItemAmount

Number

The total cost before discounts, taxes, and shipping of all the items ordered. This must be greater than zero.

dutyDetails

Array[Price Object]

The details of the duties applied to the order.

totalTaxAmount

Number

The total taxes applied to the order.

taxDetails

Price Object

The details of the taxes applied to the order.

totalDiscountAmount

Number

The total discounts applied to the order.

discountDetails

Price Object

The details of the discounts applied to the order.

cashOnDeliveryAmount

Number

Reserved for future use.

otherChargeDetails

Price Object

The details of all other charges for the order aside from duties and taxes.

totalOrderAmount

Number

The sum of all charges on the order. This must be greater than zero.

 

Price Object

Name

Data Type

Description

name

String

The type of charge.

fee

Number

The amount of the fee.

currency

String

The ISO currency code. For example: USD, CAD, EUR

percentage

Number

Percentage amount. Applicable to duty and tax only.

 

Products Object

Name

Data Type

Description

clientId

String

Required. The client ID assigned by Pitney Bowes.

vendorDetails

Object

vendorDetails.name

String

Name of the vendor.

Maximum length: 50 characters

vendorDetails.number

String

The vendor identifier.

Maximum length: 30 characters

productType

String

Required. Identifies the product as one of the following:

  • ITEM

  • KIT

sku

String

Required. The SKU used to track the product in the warehouse.

Maximum length: 30 characters

createDate

String

The date the product was created in the client system, specified in the ISO 8601 format:

YYYY-MM-DDThh:mm:ss.sss±hhmm

updateDate

String

The date the product was modified in the client system, specified in the ISO 8601 format:

YYYY-MM-DDThh:mm:ss.sss±hhmm

pbCreateDate

String “readOnly”: true

RESPONSE ONLY. The date the product was created in the Pitney Bowes system, specified in the ISO 8601 format:

YYYY-MM-DDThh:mm:ss.sss±hhmm

pbUpdateDate

String

RESPONSE ONLY. The date the order was created in the Pitney Bowes system, specified in the ISO 8601 format:

YYYY-MM-DDThh:mm:ss.sss±hhmm

fulfillmentRegion

String

Where the product is sent for fulfillment. Possible values:

  • PB_ONLY (default)

  • THIRD_PARTY (Reserved for future use)

  • ALL (Reserved for future use)

details

Product Details Object

Required.

options

Array[Object]

Defines available options for the product.

options.name

String

A product option. Possible values:

  • COLOR

  • MODEL

  • SIZE

  • STYLE

options.code

String

A selectable code for the specified option, such as a style code or color code.

Maximum length: 8 characters

options.description

String

A description of the option.

Maximum length: 35 characters

active

Boolean

The status of the product. If true, the product is active. If false, the product is inactive.

status

String

Possible values:

  • PUBLISHED (default)

  • UNPUBLISHED

shippingAttributes

Object

shippingAttributes.shipsAlone

Boolean

The product is a ship alone.

Default value: false

shippingAttributes.dropShip

Boolean

The product is fulfilled by drop shipper.

Default value: false

shippingAttributes.safetyFactor

Number

Reserved for future use.

returnParameters

returnParameters.returnable

Boolean

Indicates whether the product can be returned.

Default value: true

returnParameters.returnWindow

Number, up to 1 decimal place

The number of days allowed for returns. To indicate no limit, enter 0.

prePackagedBoxQuantity

Number

The number of units in a prepackaged box.

physicalUnitDetails

Object

The product’s weight and dimensions.

physicalUnitDetails.weight

Number, up to 4 decimal places

Weight.

physicalUnitDetails.weightUOM

String

The unit of measurement for the product’s weight. Possible value:

  • LB: Pounds

physicalUnitDetails.dimensions

Dimensions Object

The product’s dimensions.

physicalCaseDetails

Object

physicalCaseDetails.caseWeight

Number, up to 4 decimal places

The weight of one item of this type of commodity.

physicalCaseDetails.unitOfMeasurement

String

The unit of measurement for the commodity’s weight. Possible value:

  • LB: Pounds

physicalCaseDetails.caseDimension

Dimensions Object

The case dimensions.

physicalCaseDetails.standardQuantity

Number, up to 1 decimal place

Standard case quantity for this SKU, must be greater than 0.

inventoryParameters

Inventory Parameters Object

additionalLanguageSupport

Array[Object]

additionalLanguageSupport.reference

String

The locale for additional language support on the packing slip. For example: FR_CA, ES_MX, DE_DE, etc.

Maximum length: 10 characters

additionalLanguageSupport.value

String

The description of the product for the specified locale.

Maximum length: 255 characters

 

Product Details Object

Name

Data Type

Description

brand

String

The manufacturer’s brand name for the item.

Maximum length: 50 characters

category

String

Associated category.

Maximum length: 50 characters

description

String

Short description of the product.

Maximum length: 100 characters

eccn

String

Reserved for future use.

hazmatClassification

Array[Ojbect]

hazmatClassification.dotHazmatCode

String

The U.S. Department of Transportation (DOT) hazardous materials code for the dangerous good.

Maximum length: 10 characters

hazmatClassification.unHazmatCode

String

The United Nations (UN) hazardous materials code for the dangerous good.

Maximum length: 10 characters

hazmatClassification.hazmatDescription

String

The UN hazardous materials description for the dangerous good.

Maximum length: 100 characters

hsClassification

Array[Object]

The product’s HS code (Harmonized System code).

hsClassification.hsTariffCode

String

The tariff code for the product, as provided by destination country. Most countries use the six-digit Harmonized System (HS) as the basis for their tariff codes.

Maximum length: 30 characters

hsClassification.countryCode

String

The two-character ISO country code for the country supplying the tariff code used in hsTariffCode.

identifiers

Array[Object]

Additional identifiers for the item. Each object in the array defines a type of identifier and its value.

identifiers.number

String

The value of the identifier.

Maximum length: 100 characters

identifiers.source

String

The type of identifier, such as MPN, SKU, UPC, ISBN, or ISSN.

Maximum length: 10 characters

image

Image Object

manufacturer

String

The manufacturer of the item.

Maximum length: 255 characters

originCountryCode

String

The country code of the product’s manufacturing country. Use ISO 3166-1 alpha-2 standard values.

Maximum length: 2 characters

originStateProvince

String

The origin state or province.

Maximum length: 50 characters

unitPrice

Number, up to 4 decimal places

The client’s cost for one unit of this item. This is used to calculate the inventory valuation report in the Fulfillment Client Portal.

retailPrice

Number, up to 4 decimal places

The selling price to customers for one unit of this product.

priceCurrency

String

Currency Code. This must be set to USD. (The APIs will allow other currency codes in the future.)

url

String

The commodity’s URL on the merchant’s site.

Maximum length: 1000 characters

 

Inventory Parameters Object

Name

Data Type

Description

lotTracked

Boolean

If true, the product requires lot/batch tracking in the fulfillment center.

Default value: false

expiryDateTracked

Boolean

If true, the product requires expiration date tracking in the fulfillment center.

Default value: false

expiryWindow

Number, up to 1 decimal place

The window where an item is past its fulfillment date, based on the expiration date. To indicate an infinite window, set this to 0.

Default value: 0

serialTracked

Boolean

If true, the item requires the serial number to be captured at outbound.

Default value: false

fragile

Boolean

If true, the item is fragile and requires the fragile SOP.

Default value: false

temperatureControlled

Boolean

If true, the item requires climate-controlled storage.

Default value: false

highValue

Boolean

If true, the item requires secured storage.

Default value: false

requiresQuarantine

Boolean

If true, the item requires a quarantine process at inbound.

Default value: false

additionalQualityControls

Array[String]

Reserved for future use.

 

References Object (Fulfillment)

Name

Data Type

Description

name

String

The reference field.

Maximum length: 50 characters

values

String

The value.

Maximum length: 255 characters

 

Returns Object (Fulfillment Return Orders)

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

orderId

String

The Pitney Bowes ID for the original order.

returnClientOrderId

String

The client ID for the fulfillment return order.

Maximum length: 50 characters

originalClientOrderId

String

The client ID for the original order.

returnOrderId

String

RESPONSE ONLY. The Pitney Bowes ID for the fulfillment return order.

rmaNumber

String

The client’s RMA number for the return. The RMA number (Return Merchandise Authorization number) is used as a tracking number for parcel being returned to the fulfillment center.

Maximum length: 35 characters

references

Array[References Object]

Additional reference information for the order. Each object in the array is a name-value pair that defines a reference field and value.

createDate

String

Reserved for future use.

updateDate

String

Reserved for future use.

pbCreateDate

String

RESPONSE ONLY. The date and time Pitney Bowes receives information about the fulfillment return order, specified in the ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

pbUpdateDate

String

RESPONSE ONLY. The date and time Pitney Bowes receives updated information about the fulfillment return order, specified in the ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

node

String

The Pitney Bowes Fulfillment Center where the return is expected to be processed.

fromAddress

Address Object

The address of the consumer who is sending back the package.

shippingDetails

Shipping Details Object

The carrier details for the fulfillment return order.

returnOrderCurrency

String

The default currency for the item-level costs.

returnOrderLines

Array[Return Order Lines Object]

The items included in the return order. Each item is a different object in the array.

returnReason

Array[String]

The reasons for the return order.

operation

String

Specifies whether to create or update a given return order in a Bulk Return Orders operation. This field applies only to Bulk Return Orders. If this field is not specified for a return order, the system will search for the order and, if it is found, the system will update the order. If the order is not found, the system will create the order. This field takes the following values:

  • CREATE

  • UPDATE

 

Return Order Lines Object

Name

Data Type

Description

orderLineId

Number

The original order line number.

itemDetail

Object

The item information.

itemDetail.sku

String

The SKU used to track the item in the warehouse.

Maximum length: 30 characters

itemDetail.unitPrice

Number

The price of one item of this type of commodity.

itemDetail.description

String

The item description.

Maximum length: 100 characters

lineTotal

Number

The total price for the line, excluding shipping and taxes.

returnReason

Array[String]

The reasons for the return order.

quantity

Number

The number of items returned.

 

Shipping Details Object (Fulfilled Orders)

Name

Data Type

Description

carrier

String

Required. The name of the carrier.

Maximum length: 30 characters

serviceId

String

Required. The ID of the carrier service.

Maximum length: 30 characters

serviceName

String

Reserved for future use - The name of the carrier service.

Maximum length: 30 characters

trackingNumber

String

Reserved for future use - The assigned tracking number.

Maximum length: 40 characters

 

Weight Object (Fulfillment)

Name

Data Type

Description

weight

Number

The weight.

unitOfMeasurement

String

The unit of measurement for the specified weight. Possible value:

  • LB: Pounds

 

Work Orders Object

Name


Data Type

Description

clientId

String

Required. The client ID assigned by Pitney Bowes.

clientWorkOrderId

String

Required. The work order ID assigned in the client system.

Maximum length: 35 characters

workOrderId

String

The work order ID assigned by Pitney Bowes.

workOrderName

String

Required. The name of the work order in the client system.

Maximum length: 30 characters

description

String

The work order description

Maximum length: 250 characters

type

String

Required. The type of work order. Possible value:

  • KIT

  • REFURBISHED (Reserved for future use.)

  • OTHER (Reserved for future use.)

status

String

RESPONSE ONLY. The order status. Possible values:

  • CREATED

  • INPROGRESS

  • CANCELED

  • CLOSED

  • COMPLETE

node

String

Required. The ID for the Pitney Bowes Fulfillment Center where work order is to be produced.

createDate

String

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

This field is not returned for Status Search.

updateDate

String

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

This field is not returned for Status Search.

pbCreateDate

String

RESPONSE ONLY. The date and time the work order was created in the Pitney Bowes system, returned in the ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

This field is not returned for Status Search.

pbCreateDate

String

RESPONSE ONLY. The date and time the work order was updated in the Pitney Bowes system, returned in the ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

This field is not returned for Status Search.

sku

String

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

Maximum length: 30 characters

brand

String

The seller’s brand name for the item.

Maximum length: 50 characters

workOrderQuantity

Number

Required. The number of kits ordered.

priority

String

The priority of the work order. Possible values:

  • PRIORITY

  • STANDARD

This field is not returned for Status Search.

requestedStartDate

String

The date and time by which the work order should be started. Specify this in the ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

This field is not returned for Status Search.

requestedCompletionDate

String

The date and time by which the work order should be completed. Specify this in the ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

This field is not returned for Status Search.

The fields below do not apply to the Create or Update operations.

startDate

String

RESPONSE ONLY. Date the work order was started.

completionDate

String

RESPONSE ONLY. Date the work order was completed.

startQuantity

Number

RESPONSE ONLY. Start quantity of the work order.

completedQuantity

Number

RESPONSE ONLY. Quantity produced for the work order.

lotNumbers

Array[String]

RESPONSE ONLY. Completed Lot numbers for the produced product.

This field is not returned for Status Search.

serialNumbers

Array[String]

RESPONSE ONLY. Reserved for future use.

rejectedQuantity

Number

RESPONSE ONLY. Rejected quantity for the product.

This field is not returned for Status Search.

scrappedQuantity

Number

RESPONSE ONLY. Scrapped quantity for the product.

This field is not returned for Status Search.

workOrderLines

Array[Object]

RESPONSE ONLY. The child items.

This field is not returned for Status Search.

workOrderLines.childSKU

String

RESPONSE ONLY. The SKU of the child item. The item must be part of the master catalog.

workOrderLines.lotNumbers

Array[String]

RESPONSE ONLY. The completed lot numbers for the produced product.

workOrderLines.serialNumbers

Array[String]

RESPONSE ONLY. Reserved for future use.

workOrderLines.issuedQuantity

Number

RESPONSE ONLY. The issued quantity of the child product.

cancelDate

String

RESPONSE ONLY. If the work order was cancelled, the date the client cancelled the work order.

pbCancelDate

string

RESPONSE ONLY. The date the work order is cancelled in the Pitney Bowes system.

This field is not returned for Status Search.

cancelReason

string

RESPONSE ONLY. If the work order was cancelled, this gives the reason for cancellation.

This field is not returned for Status Search.

references

Array[Object]

RESPONSE ONLY. Reserved for future use.

references.name

String

RESPONSE ONLY. Reserved for future use.

references.value

String

RESPONSE ONLY. Reserved for future use.