Articles in this section

Ship Notice API

Avatar
Owen Allen
Updated

The Ship Notice API lets you create shipping notifications.

URL

URL: https://api.clickbank.com/rest/1.3/shipping2/shipnotice

Methods

This section provides details about the methods available within the Ship Notice API, including required key and roles, output types, and supported and required parameters.

The following methods are covered in this section:

GET  /1.3/shipping2/shipnotice/schema

This method returns the XML Schema for ship notice results.

Required Keys and Roles

  • None

Return Type

XML schema for Ship Notice

Supported Output Types

  • application/xml

GET  /1.3/shipping2/shipnotice/{receipt}

This method returns the shipping notifications for the specified transaction.

Required Keys and Roles

  • API Key
    • API Order Read Role

Return Type

Ship Notice

Supported Output Types

  • application/xml
  • application/json

POST  /1.3/shipping2/shipnotice/{receipt}

This method creates a shipping notification for the specified transaction.

Request Parameters

Name Required Description
carrier Yes

The shipping carrier.
date Yes

The shipping date. The date format is yyyy-mm-dd. This date cannot be earlier than the date of purchase or later than the current date.

NOTE: The date is calculated in Pacific Standard Time (PST). Thus, in order to use the current date, please ensure that it is also the current date according to PST. 
item Required if the transaction includes multiple physical items The SKU of the line item.
comments No

The comments associated with the notice.
tracking No

The tracking ID.
fillOrder True

Indicates that the receipt is part of the order being shipped altogether, for which the remaining shipping notices should be automatically generated.


Required Keys and Roles

  • Clerk Key
    • API Order Read Role
    • API Order Write Role

Return Type

Ship Notice

Supported Output Types

  • application/xml
  • application/json

Return Types

This section details the return types used by the Ship Notice API.

The following return types are covered in this section:

Ship Notice

Ship Notice returns use the following format:

<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" version="1.0">
<xs:element name="shippingNoticeData" type="shippingNoticeData"/>
<xs:complexType name="shippingNoticeData">
<xs:sequence>
<xs:element name="shipDate" type="xs:dateTime" nillable="true" minOccurs="0"/>
<xs:element name="carrier" type="xs:string" nillable="true" minOccurs="0"/>
<xs:element name="trackingId" type="xs:string" nillable="true" minOccurs="0"/>
<xs:element name="shippedTo" type="xs:string" nillable="true" minOccurs="0"/>
<xs:element name="comments" type="xs:string" nillable="true" minOccurs="0"/>
<xs:element name="receipt" type="xs:string" nillable="true" minOccurs="0"/>
<xs:element name="itemNo" type="xs:string" nillable="true" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
</xs:schema>

Usage Information

For additional information about using the Ship Notice API, see the ClickBank APIs article.

Related Articles

  • Shipping API – This article explains how to view shipping information using an API.

Related articles