Create an ASN

HTTP Request

POST /v1/receiving-asn

Summary

This operation creates an Advanced Shipment Notification (ASN).

Request URLs

Sandbox: https://shipping-api-sandbox.pitneybowes.com/shippingservices/fulfillment/v1/receiving-asn
Production: https://shipping-api.pitneybowes.com/shippingservices/fulfillment/v1/receiving-asn

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

Required fields are marked Required. All other fields are optional.

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	The type of inbound shipment. Possible values: PO: Purchase Order (Default) ASN: Advanced Shipment Notification
clientASNId	String	A unique order ID assigned by the client. **Required when Inbound Type=ASN ** Maximum length: 35 characters
purchaseOrderNumber	String	The purchase order number. Required when Inbound Type=PO 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	The vendor. This object is optional. If you include this object, you must include the object’s name and code fields.
vendorDetails.name	String	The name of the vendor. This is required in the vendorDetails object. Maximum length: 50 characters
vendorDetails.code	String	The unique code assigned to the vendor. This is required in the vendorDetails object.
shippingDetails	Object	The carrier details for the shipment.
shippingDetails.carrier	String	Required. The name of the carrier. Maximum length: 30 characters
shippingDetails.serviceId	String	The ID of the carrier service. Maximum length: 30 characters
shippingDetails.serviceName	String	Reserved for future use - The name of the carrier service. Max: 30 characters
shippingDetails.trackingNumber	String	Reserved for future use - The assigned tracking number. Max: 40 characters
createDate	String	The date and time the ASN was ordered, specified in the ISO 8601 format: YYYY-MM-DDThh:mm:ssZ
updateDate	String	The date and time the ASN was updated, specified in the ISO 8601 format: YYYY-MM-DDThh:mm:ssZ
estimatedDeliveryDate	String	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
totalWeight	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.
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.
name	String	The name of the ASN. Maximum length: 100 characters
pallets	Integer	The number of pallets.
cartons	Integer	The number of cartons.

Response Elements

Name	Data Type	Description
clientId	String	The client ID assigned by Pitney Bowes.
brand	String	The manufacturer’s brand name for the item, up to 30 characters.
inboundType	String	The type of inbound shipment. Possible values: PO: Purchase Order ASN: Advanced Shipment Notification
clientASNId	String	A unique order ID assigned by the client, up to 35 characters.
purchaseOrderNumber	String	The purchase order number, up to 35 characters.
invoiceNumber	String	Reserved for future use.
receivingNode	String	The ID of the facility that will receive the incoming shipment.
vendorDetails	Object	The vendor.
vendorDetails.name	String	The name of the vendor, up to 50 characters.
vendorDetails.code	String	The unique code assigned to the vendor.
receivingASNId	String	The ASN ID assigned by Pitney Bowes.
status	String	The status of the ASN. Possible values: CREATED INPROGRESS UPDATED ARRIVED COMPLETE CANCELED
shippingDetails	Object	The carrier details for the shipment.
shippingDetails.carrier	String	The name of the carrier, up to 30 characters.
shippingDetails.serviceId	String	The ID of the carrier service, up to 30 characters.
shippingDetails.serviceName	String	Reserved for future use - The name of the carrier service, up to 30 characters.
shippingDetails.trackingNumber	String	Reserved for future use - The assigned tracking number, up to 40 characters.
createDate	String	The date and time the ASN was ordered, specified in the ISO 8601 format: YYYY-MM-DDThh:mm:ssZ
updateDate	String	The date and time the ASN was updated, specified in the ISO 8601 format: YYYY-MM-DDThh:mm:ssZ
estimatedDeliveryDate	String	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
receivedDate	String	The date and time the ASN was received, specified in the ISO 8601 format: YYYY-MM-DDThh:mm:ssZ
pbCreateDate	String	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	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	The date and time the ASN was delivered to Pitney Bowes, specified in the ISO 8601 format: YYYY-MM-DDThh:mm:ssZ
totalWeight	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	The address of the facility where the shipment will be received.
billingAddress	Address Object	Reserved for future use.
additionalReferences	Array[Object]	Defines customer reference information for the ASN. Each object in the array is a name-value pair with the following fields: name: A String value that defines the reference the field, up to 50 characters. value: A String value that defines the reference value, up to 255 characters.
asnLines	Array[ASN Lines Object]	The line-level details of the ASN.
name	String	The name of the ASN, up to 100 characters.
pallets	Integer	The number of pallets.
cartons	Integer	The number of cartons.

Sample Request

curl -X POST ".../v1/receiving-asn" \
-H "Authorization: Bearer <oauth_token>" \
-H "X-PB-TransactionId: <unique_identifier>" \
-d '
{
    "clientId": "1234",
    "inboundType": "ASN",
    "clientASNId": "NEW-ASN-50500",
    "purchaseOrderNumber": "PO#1112188821122222",
    "receivingNode": "160",
    "vendorDetails": {
        "name": "Vendor",
        "code": "VENDOR"
    },
    "shippingDetails": {
        "carrier": "UPS",
        "serviceId": "UPSG"
    },
    "createDate": "2022-02-18T20:01:39Z",
    "estimatedDeliveryDate": "2022-02-22T00:00:00Z",
    "additionalReferences": [],
    "asnLines": [ {
        "lineId": 100,
        "purchaseOrderNumberLineId": 100,
        "sku": "1642787722",
        "inventoryType": "NEW",
        "originCountryCode": "US",
        "expectedQuantity":  1,
        "unitOfMeasurement": "EACH",
        "estimatedDeliveryDate": "2022-02-22T20:01:39Z",
        "costDetails": {
            "retailPrice": 15,
            "wholeSalePrice": 10,
            "unitCost": 15,
            "currency": "USD"
        }
    } ],
    "name": "<manifest-name>",
    "carton": 2,
    "pallets": 3
}'

Sample Response

{
    "clientId": "1234",
    "inboundType": "ASN",
    "clientASNId": "NEW-ASN-50500",
    "purchaseOrderNumber": "PO#1112188821122222",
    "receivingNode": "160",
    "vendorDetails": {
        "name": "Vendor",
        "code": "VENDOR"
    },
    "receivingASNId": "ASA0008164697501077504US",
    "status": "CREATED",
    "shippingDetails": {
        "carrier": "UPS",
        "serviceId": "UPSG"
    },
    "createDate": "2022-02-18T13:01:39Z",
    "estimatedDeliveryDate": "2022-02-21T17:00:00Z",
    "pbCreateDate": "2022-02-04T13:21:38Z",
    "toAddress": {
        "name": "Pitney Bowes Facility",
        "company": "Pitney Bowes Inc",
        "phone": "800-000-0000",
        "email": "pb@example.com",
        "addressLines": [
            "1200 WORLDWIDE BLVD",
            "HEBRON KY",
            "41048"
        ],
        "cityTown": "Hebron",
        "stateProvince": "KY",
        "postalCode": "41048",
        "countryCode": "US"
    },
    "additionalReferences": [],
    "asnLines": [ {
        "lineId": 100,
        "purchaseOrderNumberLineId": 100,
        "PBlineId": 1,
        "sku": "1642787722",
        "inventoryType": "NEW",
        "originCountryCode": "US",
        "expectedQuantity": 1,
        "unitOfMeasurement": "EACH",
        "estimatedDeliveryDate": "2022-02-22T13:01:39Z",
        "costDetails": {
            "retailPrice": 15.0,
            "wholeSalePrice": 10.0,
            "unitCost": 15.0,
            "currency": "USD"
        }
    } ],
    "name": "<manifest-name>",
    "carton": 2,
    "pallets": 3
}

Error Codes

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

 
 
 
 

• next
• previous |

© Copyright 2024 Pitney Bowes Inc. All rights reserved.