Skip to content

Latest commit

 

History

History
356 lines (271 loc) · 16.9 KB

ShipmentApi.md

File metadata and controls

356 lines (271 loc) · 16.9 KB

shippingapi.Api.ShipmentApi

All URIs are relative to https://shipping-api-sandbox.pitneybowes.com/shippingservices

Method HTTP request Description
CancelShipment DELETE /v1/shipments/{shipmentId} cancelShipment
CreateShipmentLabel POST /v1/shipments This operation creates a shipment and purchases a shipment label.
ReprintShipment GET /v1/shipments/{shipmentId} reprintShipment
RetryShipment GET /v1/shipments retryShipment

CancelShipment

CancelShipment CancelShipment (string xPBTransactionId, string shipmentId, string xPBUnifiedErrorStructure = null, string xPBShipperCarrierAccountId = null, string cancelInitiator = null, Carrier? carrier = null)

cancelShipment

Example

using System.Collections.Generic;
using System.Diagnostics;
using shippingapi.Api;
using shippingapi.Client;
using shippingapi.Model;

namespace Example
{
    public class CancelShipmentExample
    {
        public static void Main()
        {
            Configuration.Default.BasePath = "https://shipping-api-sandbox.pitneybowes.com/shippingservices";
            // Configure OAuth2 access token for authorization: oAuth2ClientCredentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ShipmentApi(Configuration.Default);
            var xPBTransactionId = xPBTransactionId_example;  // string | Required. A unique identifier for the transaction, up to 25 characters.
            var shipmentId = shipmentId_example;  // string | shipmentId
            var xPBUnifiedErrorStructure = xPBUnifiedErrorStructure_example;  // string | Recommended. Set this to true to use the standard error object if an error occurs. (optional)  (default to "true")
            var xPBShipperCarrierAccountId = xPBShipperCarrierAccountId_example;  // string | UPS Only. The unique identifier returned in the shipperCarrierAccountId field by the [Register an Existing Carrier Account API.(https://shipping.pitneybowes.com/api/post-carrier-accounts-register.html) (optional) 
            var cancelInitiator = SHIPPER;  // string | Indicates that this refund request is initiated by the shipper. Set this to: SHIPPER (optional) 
            var carrier = USPS;  // Carrier? | Conditional. The carrier. This is required if the carrier is not USPS (optional) 

            try
            {
                // cancelShipment
                CancelShipment result = apiInstance.CancelShipment(xPBTransactionId, shipmentId, xPBUnifiedErrorStructure, xPBShipperCarrierAccountId, cancelInitiator, carrier);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling ShipmentApi.CancelShipment: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
xPBTransactionId string Required. A unique identifier for the transaction, up to 25 characters.
shipmentId string shipmentId
xPBUnifiedErrorStructure string Recommended. Set this to true to use the standard error object if an error occurs. [optional] [default to "true"]
xPBShipperCarrierAccountId string UPS Only. The unique identifier returned in the shipperCarrierAccountId field by the [Register an Existing Carrier Account API.(https://shipping.pitneybowes.com/api/post-carrier-accounts-register.html) [optional]
cancelInitiator string Indicates that this refund request is initiated by the shipper. Set this to: SHIPPER [optional]
carrier Carrier? Conditional. The carrier. This is required if the carrier is not USPS [optional]

Return type

CancelShipment

Authorization

oAuth2ClientCredentials

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
201 OK -
0 Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateShipmentLabel

Shipment CreateShipmentLabel (string xPBTransactionId, Shipment shipment, bool? xPBUnifiedErrorStructure = null, string xPBIntegratorCarrierId = null, string xPBShipperRatePlan = null, string xPBShipmentGroupId = null, string xPBShipperCarrierAccountId = null, string includeDeliveryCommitment = null)

This operation creates a shipment and purchases a shipment label.

The API returns the label as either a Base64 string or a link to a PDF. For more information visit Create Shipment Documents. Following are samples of different carriers - * Create a USPS (U.S. Postal Service) Label * Create a USPS PMOD Label * Create a USPS Scan-Based Return Label * Create a Pure Post Return Label * Create a Newgistics Label * Create a PB Presort Label * Create a PB Cross-Border Shipment * Create a UPS (United Parcel Service) Label

Example

using System.Collections.Generic;
using System.Diagnostics;
using shippingapi.Api;
using shippingapi.Client;
using shippingapi.Model;

namespace Example
{
    public class CreateShipmentLabelExample
    {
        public static void Main()
        {
            Configuration.Default.BasePath = "https://shipping-api-sandbox.pitneybowes.com/shippingservices";
            // Configure OAuth2 access token for authorization: oAuth2ClientCredentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ShipmentApi(Configuration.Default);
            var xPBTransactionId = uniquevalue;  // string | Required. A unique identifier for the transaction, up to 25 characters.
            var shipment = new Shipment(); // Shipment | request
            var xPBUnifiedErrorStructure = true;  // bool? | Set this to true to use the standard [error object](https://shipping.pitneybowes.com/reference/error-object.html#standard-error-object) if an error occurs. (optional)  (default to true)
            var xPBIntegratorCarrierId = xPBIntegratorCarrierId_example;  // string | USPS Only. Negotiated services rate, if applicable. (optional) 
            var xPBShipperRatePlan = xPBShipperRatePlan_example;  // string | USPS Only. Shipper rate plan, if applicable. For more information, see [this FAQ](https://shipping.pitneybowes.com/faqs/rates.html#rate-plans-faq). (optional) 
            var xPBShipmentGroupId = xPBShipmentGroupId_example;  // string |  **[Required parameter for PBPresort service](https://shipping.pitneybowes.com/api/post-shipments-presort.html)**.The job number that represents the agreement between the merchant and PB Presort. This was provided by Pitney Bowes during [merchant onboarding for PB Presort](https://shipping.pitneybowes.com/carriers/pb-presort.html). (optional) 
            var xPBShipperCarrierAccountId = xPBShipperCarrierAccountId_example;  // string | **[Required parameter for PBPresort service](https://shipping.pitneybowes.com/api/post-shipments-presort.html)**. The merchant's Mailer ID (MID), as provided by Pitney Bowes during merchant onboarding for PB Presort. (optional) 
            var includeDeliveryCommitment = includeDeliveryCommitment_example;  // string | If set to true, returns estimated transit times in days. Only for USPS Create Shipment. See also [Pitney Bowes Delivery Guarantee](https://shipping.pitneybowes.com/faqs/delivery-guarantee.html) [Do all USPS services return transit times?](https://shipping.pitneybowes.com/faqs/shipments.html#transit-times-faq) (optional) 

            try
            {
                // This operation creates a shipment and purchases a shipment label.
                Shipment result = apiInstance.CreateShipmentLabel(xPBTransactionId, shipment, xPBUnifiedErrorStructure, xPBIntegratorCarrierId, xPBShipperRatePlan, xPBShipmentGroupId, xPBShipperCarrierAccountId, includeDeliveryCommitment);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling ShipmentApi.CreateShipmentLabel: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
xPBTransactionId string Required. A unique identifier for the transaction, up to 25 characters.
shipment Shipment request
xPBUnifiedErrorStructure bool? Set this to true to use the standard error object if an error occurs. [optional] [default to true]
xPBIntegratorCarrierId string USPS Only. Negotiated services rate, if applicable. [optional]
xPBShipperRatePlan string USPS Only. Shipper rate plan, if applicable. For more information, see this FAQ. [optional]
xPBShipmentGroupId string Required parameter for PBPresort service.The job number that represents the agreement between the merchant and PB Presort. This was provided by Pitney Bowes during merchant onboarding for PB Presort. [optional]
xPBShipperCarrierAccountId string Required parameter for PBPresort service. The merchant's Mailer ID (MID), as provided by Pitney Bowes during merchant onboarding for PB Presort. [optional]
includeDeliveryCommitment string If set to true, returns estimated transit times in days. Only for USPS Create Shipment. See also Pitney Bowes Delivery Guarantee Do all USPS services return transit times? [optional]

Return type

Shipment

Authorization

oAuth2ClientCredentials

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
201 OK -
0 Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ReprintShipment

Shipment ReprintShipment (string shipmentId, bool? xPBUnifiedErrorStructure = null, Carrier? carrier = null)

reprintShipment

Example

using System.Collections.Generic;
using System.Diagnostics;
using shippingapi.Api;
using shippingapi.Client;
using shippingapi.Model;

namespace Example
{
    public class ReprintShipmentExample
    {
        public static void Main()
        {
            Configuration.Default.BasePath = "https://shipping-api-sandbox.pitneybowes.com/shippingservices";
            // Configure OAuth2 access token for authorization: oAuth2ClientCredentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ShipmentApi(Configuration.Default);
            var shipmentId = shipmentId_example;  // string | Required. The shipment ID that was issued when shipment label was generated.
            var xPBUnifiedErrorStructure = true;  // bool? | Set this to true to use the standard [error object](https://shipping.pitneybowes.com/reference/error-object.html#standard-error-object) if an error occurs. (optional)  (default to true)
            var carrier = USPS;  // Carrier? |  (optional) 

            try
            {
                // reprintShipment
                Shipment result = apiInstance.ReprintShipment(shipmentId, xPBUnifiedErrorStructure, carrier);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling ShipmentApi.ReprintShipment: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
shipmentId string Required. The shipment ID that was issued when shipment label was generated.
xPBUnifiedErrorStructure bool? Set this to true to use the standard error object if an error occurs. [optional] [default to true]
carrier Carrier? [optional]

Return type

Shipment

Authorization

oAuth2ClientCredentials

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
0 Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RetryShipment

Shipment RetryShipment (string originalTransactionId, bool? xPBUnifiedErrorStructure = null, Carrier? carrier = null)

retryShipment

Example

using System.Collections.Generic;
using System.Diagnostics;
using shippingapi.Api;
using shippingapi.Client;
using shippingapi.Model;

namespace Example
{
    public class RetryShipmentExample
    {
        public static void Main()
        {
            Configuration.Default.BasePath = "https://shipping-api-sandbox.pitneybowes.com/shippingservices";
            // Configure OAuth2 access token for authorization: oAuth2ClientCredentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ShipmentApi(Configuration.Default);
            var originalTransactionId = 12344;  // string | 
            var xPBUnifiedErrorStructure = true;  // bool? | Set this to true to use the standard [error object](https://shipping.pitneybowes.com/reference/error-object.html#standard-error-object) if an error occurs. (optional)  (default to true)
            var carrier = USPS;  // Carrier? |  (optional) 

            try
            {
                // retryShipment
                Shipment result = apiInstance.RetryShipment(originalTransactionId, xPBUnifiedErrorStructure, carrier);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling ShipmentApi.RetryShipment: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
originalTransactionId string
xPBUnifiedErrorStructure bool? Set this to true to use the standard error object if an error occurs. [optional] [default to true]
carrier Carrier? [optional]

Return type

Shipment

Authorization

oAuth2ClientCredentials

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
201 OK -
0 Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]