Cancel an ASN

HTTP Request

PUT /v1/receiving-asn/{receivingASNId}/cancel?clientId={clientId}

Summary

This operation cancels the complete ASN (Advanced Shipment Notification). You cannot cancel only part of an ASN.

Request URLs

Sandbox: https://shipping-api-sandbox.pitneybowes.com/shippingservices/fulfillment/v1/receiving-asn/{receivingASNId}/cancel?clientId={clientId}
Production: https://shipping-api.pitneybowes.com/shippingservices/fulfillment/v1/receiving-asn/{receivingASNId}/cancel?clientId={clientId}

Path Parameter

Name

Description

receivingASNId


Required. The ASN ID assigned by Pitney Bowes, as returned in the receivingASNId field in the ASN Object.

Query Parameters

Name

Description

clientId

Required. The client ID assigned by Pitney Bowes.

brand

The manufacturer’s brand name for the item.

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

Send an empty request body.

Response Elements

This PUT operation returns the ASN object, described in the table below. (The table describes the ASN object for all operations that use it. Some fields in the table are labeled Required, meaning they are required when the object is sent in a request.)

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

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

RESPONSE ONLY. The date and time the ASN was received, 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.

Sample Request

curl -X PUT ".../v1/receiving-asn/ASN156A0029204893659052712/cancel?clientId=1234" \
-H "Authorization: Bearer <oauth_token>" \
-H "X-PB-TransactionId: <unique_identifier>" \
-d ''

Sample Response

{
    "clientId": "1234",
    "inboundType": "ASN",
    "clientASNId": "ORASN123-2112-11232",
    "purchaseOrderNumber": "PO#11121888211",
    "receivingASNId": "ASN156A0029204893659052712",
    "status": "CANCELLED",
    "receivingNode": "160",
    "vendorDetails": {
        "name": "Vendor ABC",
        "code": "VENDOR-121"
    },
    "shippingDetails": {
        "carrier": "UPS",
        "serviceId": "UPSG"
    },
    "orderDate": "<date>",
    "estimatedDeliveryDate": "<date>",
    "pbCreateDate": "<date>",
    "pbUpdateDate": null,
    "pbDeliveredDate": null,
    "toAddress": {
        "name": "Pitney Bowes Facility",
        "company": "Pitney Bowes",
        "phone": "1234567890",
        "email": "user@example.com",
        "addressLines": [
            "1200 WORLDWIDE BLVD"
        ],
        "cityTown": "Hebron",
        "stateProvince": "KY",
        "postalCode": "41048",
        "countryCode": "US"
    },
    "notes": "Notes 1",
    "additionaReferences": [ {
        "name": "REFERENCE-1",
        "value": "Ref1"
    } ],
    "asnLines": [ {
        "lineId": 100,
        "purchaseOrderNumberLineId": 100,
        "PBlineId": 1,
        "sku": "PRODUCT-SKU-001",
        "inventoryType": "NEW",
        "originCountryCode": "US",
        "expectedQuantity": 100,
        "unitOfMeasurement": "EACH",
        "estimatedDeliveryDate": "<date>",
        "costDetails": {
            "retailPrice": 15,
            "wholeSalePrice": 10,
            "unitCost": 15,
            "currency": "USD"
        }
    },
    ...
    ]
}

Error Codes

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