cisco commerce catalog web service · 2020-06-22 · cisco commerce catalog web services (cccws) is...

Cisco Commerce Catalog

Web Service Implementation Guidelines

Message Type: XML/JSON

09 Sep 2020

Version 16

2020 Cisco Systems, Inc. All rights reserved. Cisco Commerce Catalog WS V16 | 2

THE SPECIFICATIONS AND INFORMATION REGARDING THE PRODUCTS IN THIS MANUAL ARE SUBJECT TO CHANGE WITHOUT

NOTICE. ALL STATEMENTS, INFORMATION, AND RECOMMENDATIONS IN THIS MANUAL ARE BELIEVED TO BE ACCURATE BUT ARE

PRESENTED WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED. USERS MUST TAKE FULL RESPONSIBILITY FOR THEIR

APPLICATION OF ANY PRODUCTS.

THE SOFTWARE LICENSE AND LIMITED WARRANTY FOR THE ACCOMPANYING PRODUCT ARE SET FORTH IN THE INFORMATION

PACKET THAT IS SHIPPED WITH THE PRODUCT AND ARE INCORPORATED HEREIN BY THIS REFERENCE. IF YOU ARE UNABLE TO

LOCATE THE SOFTWARE LICENSE OR LIMITED WARRANTY, CONTACT YOUR CISCO REPRESENTATIVE FOR A COPY.

NOTWITHSTANDING ANY OTHER WARRANTY HEREIN, ALL DOCUMENT FILES AND SOFTWARE OF THESE SUPPLIERS ARE

PROVIDED “AS IS” WITH ALL FAULTS. CISCO AND THE ABOVE-NAMED SUPPLIERS DISCLAIM ALL WARRANTIES, EXPRESSED OR

IMPLIED, INCLUDING, WITHOUT LIMITATION, THOSE OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-

INFRINGEMENT OR ARISING FROM A COURSE OF DEALING, USAGE, OR TRADE PRACTICE.

IN NO EVENT SHALL CISCO OR ITS SUPPLIERS BE LIABLE FOR ANY INDIRECT, SPECIAL, CONSEQUENTIAL, OR INCIDENTAL

DAMAGES, INCLUDING, WITHOUT LIMITATION, LOST PROFITS OR LOSS OR DAMAGE TO DATA ARISING OUT OF THE USE OR

INABILITY TO USE THIS MANUAL, EVEN IF CISCO OR ITS SUPPLIERS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH

DAMAGES.

CISCO AND THE CISCO LOGO ARE TRADEMARKS OF CISCO SYSTEMS, INC. AND/OR ITS AFFILIATES IN THE U.S. AND OTHER

COUNTRIES. A LISTING OF CISCO’S TRADEMARKS CAN BE FOUND AT WWW.CISCO.COM/GO/TRADEMARKS. THIRD PARTY

TRADEMARKS MENTIONED ARE THE PROPERTY OF RESPECTIVE OWNERS. THE USE OF THE WORD PARTNER DOES NOT IMPLY A

PARTNERSHIP RELATIONSHIP BETWEEN CISCO AND ANY OTHER COMPANY. (1005R)

CISCO RESERVES THE RIGHT TO MAKE UPDATES TO THIS API AT ANY TIME. SHOULD AN UPDATE REQUIRE NEW DEVELOPMENT

OR UPDATES BY THE PARTNER, CISCO WILL PROVIDE YOU WITH 60 DAYS NOTICE. BY USING THIS SERVICE, YOU AGREE TO

COMPLY WITH SUCH A REQUEST WITHIN 60 DAYS, OR RISK LOSING CONNECTIVITY TO THIS API.

© 2020 Cisco Systems, Inc. All rights reserved.

http://www.cisco.com/GO/TRADEMARKS


RECENT CHANGES 4

LIST OF TABLES 4

LIST OF FIGURES 4

INTRODUCTION 5

1.1 Overview 6

1.2 Audience 6

1.3 Prerequisites 6

1.4 Scope 7

1.5 Guideline Annotations 7

CONNECTIVITY 8

2.1 Communication Protocol 8

2.2 Registration & Authentication 8

2.3 Standards Mapping 9

2.4 Endpoint URLs 9

2.5 HTTP Header 9

MESSAGE SPECIFICATION 10

3.1 Get Item Information API 10

3.1.1 Request Message 10

3.1.2 Response Message 12

3.2 Get Mapped Service API 15



3.3 Get Offers API 19



3.4 Get Offer Details API 21



3.5 Get Mandatory Attach API 26



ERROR MESSAGE 28

4.1 Get Item Information & Get Mapped Service APIs 28

4.2 Get Offers API 30

4.3 Get Offer Details API 31

4.4 Get Mandatory Attach API 31

APPENDIX A: LINKS & REFERENCES 32

APPENDIX B: ATTRIBUTES 34

APPENDIX C: PRICE LIST IDENTIFICATION 39

REVISION HISTORY 40

GLOSSARY 42

Conte

nts


Recent Changes

No. Date Version Description Location Revised By

1 09Sep2020 16 GetMappedService API

Request, Response

enhancement detail added.

Error message added

Attribute CCAST Date

format change detail added.

Section

3.2.1, 3.2.2

Section 4.1

Appendix B

Ankita Raj

2 08Jun2020 15

Net Price Only Flag added Section 3.4.2

Appendix A

Appendix B

Kiran Lohani

List of Tables

Table No. Title Page No.

1 Cardinality References 7

2 Mapping Cisco WS to OAGI Standard BOD 9

3 Endpoint URLs 9

4 HTTP Header 9

List of Figures

Figure No. Title Page No.

1 CCWS Process 6

2 Communication Protocol 8


Introduction

Cisco Commerce Catalog Web Services (CCCWS) is to promote the integration of business processes between trading

partners through seamless data exchange. The services allow you to request items’ detailed information for specific Cisco

hardware, software, and services. CCWS includes the following APIs:

o Get Item Information API - Enables you to use SKUs to request items’ detailed information. The list of detailed

information is listed in the Appendix B.

o Get Mapped Service API – Enables you to use SKU to search for:

• Service Programs

• Service Levels

• Service Levels Descriptions

• Service SKU

• Service SKU Descriptions

o Get Offer API - Enables you to obtain a list of all XaaS (On Premise and Billing) products along with key attributes of

a specific price list.

o Get Offer Details API - Enables you to obtain additional product attributes details of the offers received from the Get

Offers API response.

o Get Mandatory Attach API - Enables you to obtain mapping of mandatory subscription that should be sold along with

a Hardware or Software ATO received from the Get Mandatory Attach API response.


1.1 Overview The communication between your system and CCWS system is through XML/JSON requests and responses. Figure 1

illustrates the overview of the CCWS process. When you send your XML/JSON request to CCCWS APIs, Cisco’s

system will authenticate your credentials (See Registration & Authentication) and validate your request. Upon successful

validation, Cisco’s system will response with an XML/JSON message.

Figure 1: CCWS Process

1.2 Audience The intended audience for this document is business analysts, IT engineers, and technical architects who are involved in

the integration project. Other stakeholders who wish to understand business and/or technical aspects of integration

may also use the document as a reference.

1.3 Prerequisites Before the implementation process, partners must have:

• Some familiarity with CCWS process

• Formal/informal training on utilizing Cisco API Console

• Credentials (CCO ID) must be established to access Cisco API Console and Cisco’s Web Service infrastructure

• Registered application with Cisco’s API console

• Knowledge of token creation

For more information on credential and/or token creation, please access copy of Create Token API IG at the following

URL (https://forums.cisco.com/OperationsExchange/s/article/ka2150000009PCtAAM/Commerce-API-Connectivity)

https://forums.cisco.com/OperationsExchange/s/article/ka2150000009PCtAAM/Commerce-API-Connectivity


1.4 Scope This document describes the specifications, guidelines, attribute definitions, request and response XMLs,

dependencies, and assumptions of the CCWS. Languages describes in this IG:

• The Get Item Information and Get Mapped Service APIs - XML or JSON. however, this document will only cover

the element descriptions of XML request and response messages.

• Get Offers and Get Offer Details APIs – JSON

• Get Mandatory Attach APIs - JSON

JSON and XML samples URLs are in Appendix A. Get Item Information API allow up-to 1000 SKUs per request.

1.5 Guideline Annotations Use Table 1 to reference the elements’ cardinality in Section 3.

Table 1: Cardinality References

Cardinality Value Semantics

1 Mandatory, only one instance

1…n Mandatory, one or more instances

0…1 Optional, only one instance

0…n Optional, one or more instances


Connectivity

2.1 Communication Protocol Cisco supports the CCWS through Application Programming Interface (API) build on REST Web Service framework. The

WS requests are sent by making REST request via HTTP to the API. By using REST as the means for information

exchange, it allows processes to run on disparate operating systems. A high-level view of the WS flow follows:

Figure 2: Communication Protocol

2.2 Registration & Authentication To interface with Cisco APIs, you need to register their applications with Cisco’s API console. This section describes the

registration and authentication process. See the Appendix for URLs to both Hello API and Create Token API IGs for

visual step-by-step instructions.

1. Go to https://apiconsole.cisco.com/ and login with a valid CCO ID and Password

2. Once logged in, click the “My Apps and Keys” tab

3. Find CCW Catalog. If the ‘Register’ Button appears next to this API, please skip to step#5

4. Click on ‘Request Access’. An email template should pop up, please fill out the information in the email body. A

confirmation email will be sent to you. Once access granted, repeat step#1

5. Click the ‘Register’ button

6. Give your application a name

7. Under OAuth 2.0 Credentials, select the check box next to Resource Owner Credentials. Please Note: Make sure

to select “Resource Owner Credentials”. If you select any other value, you will still be able to successfully

generate a token. However, when using that token to call the CCWS, you will receive an error

8. Select the check box next to “Refresh Token”

9. Under Select APIs, click the check boxes next to “Get Item Information API”, “Get Mapped Services API”, “Get

Offer API”, Get Offer Details API” and “Get Mandatory Attach API”

10. Under Terms of Service, click the check box next to “I agree to the Terms of Service”

11. Click the “Register” button

12. After the application registration is complete, the console window displays an “Application Registered” message.

Please note the Client ID and Client Secret, as these values will be needed to successfully generate an access

token

13. You may log out of the API Console, your application is now created

https://apiconsole.cisco.com/


2.3 Standards Mapping CCWS maps to the Open Applications Group Integration (OAGi) standards for Business Object Documents (BODs).

Please see Appendix A for embedded schema files for OAGi BOD.

Table 2: Mapping Cisco WS to OAGi Standard BOD

Services Request BOD Response BOD

Get Item Information API GetCatalog ShowCatalog

Get Mapped Service API

2.4 Endpoint URLs Endpoint URLs are the origin or destination of a session. The Production endpoint URLs for both APIs are listed in Table

3. Special connectivity such as VPN is not required.

Table 3: Endpoint URLs

Services Method URLs

Get Item Information PROD: https://api.cisco.com/commerce/CATALOG/v2/sync/getItemInformation

Get Mapped Service PROD: https://api.cisco.com/commerce/CATALOG/v2/sync/getMappedService

Get Offers Post PROD: https://api.cisco.com/commerce/CATALOG/lpcservices/v1/offers

Get Offer Details Post PROD: https://api.cisco.com/commerce/CATALOG/lpcservices/v1/offerDetails

Get Mandatory

Attach Details Post

PROD:

https://api.cisco.com/commerce/CATALOG/lpcservices/v1/mandatoryAttachM

apping/mappingDetails

2.5 HTTP Header Table 4: HTTP Header

Property Specification

Authorization

Token for authorization

Type: String

Example: Authorization: Bearer your Token

Accept

Accepted Content type

application/xml or application/json

Type: String

Example: Accept: application/xml

Content-Type

Supported Content type

application/xml or application/json

Type: String

Example: application/xml


Message Specification

The request and response tables below describe the cardinality structure and descriptions of each elements in

Commerce Catalog WS. Please refer to the reference the table in Section 1.5 (Guideline Annotations) for cardinality

values assigned to each element.

After sending your request, Cisco’s system will return with a response message. The following is different types of

response messages:

o Validated without warning message

o Validated with warning message

o Partially validated with error message for a subset of input data

o Not validated: the request includes at least one error that needs to be resolved and re-submitted

Please refer to Error Message Section for error/warning codes and messages.

3.1 Get Item Information API Get Item Information API enables you to input the SKUs in the request. Upon successful validation, the response

message will contain detailed information of the item(s). An item information contains many attributes; the list of

attributes is in Appendix B. When requesting for an item(s) information, you have a choice to request all attributes or

individual attribute (refer to element #17). Limit of 1000 SKUs per request (element # 21).

3.1.1 Request Message

No Element Cardinality Specifications

1 GetCatalog 1

2 | ApplicationArea 1

3 || Sender 1

4 ||| LogicalID 1 Business Identifier (DUNS number)

Example: <LogicalID>123456xxx</LogicalID>

5 ||| ReferenceID 1 Unique reference ID for this document

Example: <ReferenceID>RandBrownCorp-

XML</ReferenceID>

6 || Receiver 1

7 ||| LogicalID 1

8 ||| ID 1 Cisco DUNS number

Example: <LogicalID>36413xxxx7</LogicalID>



9 || CreationDateTime 1 Date timestamp of the request

Format: YYYY-MM-DD

Example: <CreationDateTime>2017-11-

28</CreationDateTime>

10 || BODID 0…1 Proprietary document ID of the request

Attribute:

schemeVersionID=”1.0”

schemeAgencyName=”Cisco”

Example: <BODID schemeVersionID=”1.0”>10.0</BODID>

11 || Extension 1…n

12 | DataArea 1

13 || Get 1

14 ||| Expression 1 Authentication Method

Example: <Expression>token</Expression>

15 || Catalog 1

16 ||| CatalogHeader 1

17 |||| Extension 1

18 ||||| ID 1…n Request attributes

This element determines your choice of information level on

the item(s) you are requesting.

You have the ability to request all or individual information.

This can be done by attribute (typeCode) values.

• All – will returns all information of an item

• attributeName – will returns individual information.

Please visit Appendix B for the list of attributes.

Example: <ID typeCode="All"/> Or

<ID typeCode="PriceListShortName">GLUS</ID>

19 ||| CatalogLine 1

20 ||||| Item 1…n

21 |||||| ID 1 SKU (Product ID) of requested item(s)

Search types:

• Single SKU,

• Multiple SKU (Max. 1000 SKU per request)

• Wild-card (*)

Minimum of three characters when using wild-card. Only use

one search type per request.

Example: <ID>A901-6CZ-FT-A</ID>


3.1.2 Response Message The elements return in the response message depends on element #17 in your request message. The following table

displays the descriptions of the returned XML elements in a response message.


1 GetCatalog 1


3 || Sender 1

4 ||| LogicalID 1

Sender ID

This field contains Cisco DUNS number

(36413xxxx)

5 ||| ReferenceID 1

Sender Reference

This field contains “Cisco”

6 || Receiver 1

7 ||| LogicalID 1

Receiver ID

This field contains receiver’s DUNS

8 ||| ID 1

Receiver ID

This field contains receiver’s CCO ID

9 || CreationDateTime 1

Date timestamp of the response message

Format: YYYY-MM-DDTHH:MM:SSZ

10 || BODID 1

11 | DataArea 1

12 || Show 1

13 ||| ResponseCriteria 1

14 |||| ChangeStatus 1 --- Message Level Error Message ---

15 ||||| Code 1

Error/Status code

See Error Codes Table

16 ||||| Description 0…1

Error/Status message


17 ||||| Reason 1

Request Status

Value: Success, Failure, Partial Success

18 || Catalog 1

19 ||| CatalogHeader 0…1

20 |||| DocumentReference 0…n

21 ||||| ID 0…1

Unique Document ID

Format: <random string> - <Application ID>

Application ID is the last block



22 |||| Extension 0…n

--- Message Header Level Error Message ---

Error Message for all line items

Attributes:

· typeCode=”Error” – issues with input/output

parameters such as invalide price list that prevents

processing for some requested data

· typeCode=”Warning” – issues with output

parameters in the response such as item attribute

with no data

23 ||||| ID 0…n Indicate the element (where the error take place)

24 ||||| ValueText 0…n

Error code and message


25 ||| CatalogLine 1…n If there are more than one item, this information will

repeat for each item

26 |||| Item 1

27 ||||| ID 1 Product ID

28 ||||| UPCID 0…1 UPC Identifier

29 ||||| Description 1 Product description

30 ||||| Classification 0…1

31 |||||| ID 0…n

Item classifications

Attributes:

· typeCode=”ProductType”

· typeCode=”ERPFamily”

· typeCode=”ProductSubGroup”

· typeCode=”ServiceIndicator”

** Please see Appendix B for more information of

these attributes

32 |||||| UNSPSCCode 0…1

UNSPSCode – United Nations Standard Product

and Service Code

Attributes: listVersionID – version ID

33 ||||| Dimensions 0…1

34 |||||| WidthMeasure 0…1

Average width

Product unit in inches

Attributes: unitCode=”in”

35 |||||| LengthMeasure 0…1

Average length



36 |||||| HeightMeasure 0…1

Average height



37 |||||| GrossWeightMeasure 0…1

Average weight

Product unit in pounds

Attributes: unitCode=”lb”

38 |||| ItemPrice 0…n



39 ||||| ID 0…n

Price list short name

Attributes: typeCode=”PriceBookShortName”

40 ||||| UnitPrice 0…1 Unit Price

41 |||||| UnitAmount 0…1

List Price

**TnC SKUs will have list prices derived as List

Price (per month)* default initial term (set up for a

particular TnC+ SKUs).

Attribute

currencyCode shows the currency it is listed in.

42 ||||| PriceBreak 0…n Only for price list request

43 |||||| DiscountPercent 0…1 Distributors’ standard discount

44 ||||| Extension 0…n

Price list dependent attributes

Repeated for these groups:

1. ServiceDiscountCategory & ListPriceViewable

2. Product Family (ProductMajorFamily &

ProductMinorFamily)

Attributes: typeCode=”ProductFamily” and

@sequenceNumber=”<count>” for each

combination of major and its minor families

An Item can belong to more than one major family,

which in turn can have several minor families.

3. Other attributes such AvailabilityOnGPLWPL for

price list request

45 |||||| ID 1…n

Attribute typeCode=

1. “ServiceDiscountCategory” for service discount

category

Values: ‘A’, ‘B’, ‘C’, ‘D’, ‘S’, ‘N/A’

2."ListPriceViewable” to indicate list price for Item

is visible in CCW UI

Values: “Yes” or “No”

3. “AvailabilityOnGPLWPL” for availability of the

item on the constituent price lists of a requested

price list

NOTE: ServiceDiscountCategory &

ListPriceViewable are not applicable to price list

For product family:

@typeCode:

1. “ProductMajorFamily” for major family of product

2. “ProductMinorFamily” for minor family of product

46 ||||| Extension 0…1

47 |||||| ID 0…n Most of the requested information in Request

Message (element# 18) is returned in this element.

Please visit Appendix B for the list of attributes

48 ||||| Extension 0…n

--- Message Line Level Error Message ---


Attributes:

· typeCode=”Error” a

· typeCode=”Warning”

If there are more than one type of message

(“Warning” or “Error”), then running count for each

type is in sequenceNumber



49 |||||| ID 0…n

Error element

Indicate where the error take place

50 |||||| ValueText 0…n

Error code and message


3.2 Get Mapped Service API Get Mapped Service API enables you to input the SKUs in the request. Upon successful validation, the response

message will contain Service Program, Service Level, Service Level Descriptions, Service SKU, and Service SKU

Descriptions.



1 GetCatalog 1 Example: <GetCatalog

xmlns="http://www.openapplications.org/oagis/10">


3 || Sender 1

4 ||| LogicalID 1 Business Identifier (DUNS number)

Example: <LogicalID>18596xxx2</LogicalID>

5 ||| ComponentID 1 Company Name

Example: <ComponentID>RandBrown</ComponentID>


7 || Receiver 1

8 ||| LogicalID 1 Cisco’s Identifier (DUNS number)

Example: <LogicalID>32xxxx937</LogicalID>

9 ||| ID 1 Company Name

Use ‘Cisco’ in this field

Example: <ID>Cisco</ID>

10 || CreateDateTime 1 Datetime stamp of request

Format: YYYY-MM-DD

Example: <CreationDateTime>2017-11-

06</CreationDateTime>



11 || BODID 0…1 Proprietary Document ID of the request

Attributes:

schemeVersionID = “1.0”

schemeAgencyName

Example: <BODID>10.0</BODID>

12 || Extension 1…n

13 | DataArea 1

14 || Get n

15 ||| Expression 1 Example: <Expression>token</Expression>

16 || Catalog 1

17 ||| CatalogHeader 1

18 |||| Extension 1

19 ||||| ID 1…n Request Services

Attributes:

- pricelistShortName

- pageNumber

- ServiceProgram

- ServiceLevel

Example:

<ID typeCode="pricelistShortName">GLEMEA</ID>

<ID typeCode="pageNumber">1</ID>

Page Number attribute is required in case of Price List

data Pull.

< <ID typeCode="ServiceProgram">All</ID>

20 ||| CatalogLine 1

21 |||| Item 1…n

22 ||||| ID 1 SKU (Product ID) of requested item(s)

Search types:

• Single SKU,

• Multiple SKU

• Wild-card (*)

Minimum of three characters when using wild-card

Only use one search type per request

Data type: String

Example: <ID>A901-6CZ-FT-A</ID>

23 |||| Extension 1 SKU (Service ID) of requested item(s)

Search types:

• Single SKU,

• Multiple SKU

Data type: String

Example: <ID typeCode="serviceSku">CON-SNT-

1</ID>


3.2.2 Response Message A response message will be sent to you once Cisco’s system successfully validated your XML/JSON request message.

The following table displays the XML elements returned in a response message. Please refer to Cardinality References

for element’s cardinality values.


1 ShowCatalog 1


3 || Sender 1

4 ||| LogicalID 1 Cisco’s Identifier (DUNS number)


6 || Receiver 1

7 ||| LogicalID 1 Requestor’s Identifier (DUNS number)

8 ||| ID 1 Requestor CCO ID

9 || CreateDateTime 1 Datetime stamp of the request

10 || BODID 0…1 Proprietary Document Identifier of the request

schemeVersionID ="1.0"

schemeAgencyName = "Cisco"

11 | DataArea 1

12 || Show n

13 ||| ResponseCriteria 1

14 |||| Change Status 0…1

15 ||||| Code 0…1 Error/Status Code (Message-level error)

Please refer to Error Message section

16 ||||| Description 1 Error/Status Message

17 ||||| Reason 0…1 Request Status

- Success, Failure, Partial Success

18 || Catalog 0…n

19 ||| CatalogHeader 0…1

20 |||| DocumentReference 0…n



21 ||||| ID 0…1 Unique Document ID

Format: <random string> - <Application ID>

Application ID is the last block

22 |||| Extension 0…n -- TotalPages>>applicable for only Pricelist request -

--

<ID typeCode="TotalPages">20</ID>

--- Message Header Level Error Message ---


Attributes:

• typeCode=”Error” – issues with input/output

parameters such as invalide price list that prevents

processing for some requested data

• typeCode=”Warning” – issues with output

parameters in the response such as item attribute

with no data

23 ||||| ID 0…n Error element

Indicate where the error take place

24 ||||| ValueText 0…n Error code and message


25 ||| CatalogLine 1…n If there are more than one item, this information will

repeat for each item

26 |||| Item 1

27 ||||| ID 1

28 ||||| Extension 0… n

29 |||||| ID 1 Service Program

Data type: String

30 |||||| ID 1 Service Level

Data type: String

31 |||||| ID 1 Service Level Description

Data type: String

32 |||||| ID 1 Service SKU

Data type: String

33 |||||| ID 1 Service SKU Description

Data type: String

34 |||||| ID Service SKU Price

Data type: String

<Amount typeCode="GLUS">3840000</Amount>


3.3 Get Offers API When sending request to Get Offer API, Partners will receive a list of all XaaS (On Premise and Billing) products along

with key attributes of a specific price list.



1 uuid 1 Message unique Identifier

Type: String

Example: “uuid”:”TEST-mvanchee-1”

2 createdBy 1 Name of the application that is making the request

Type: String (chars 50)

Example: "createdBy":"mvanchee-1”

3 pageNo 1 Page number from 1-N

Type: Number

4 createdDateTime 1 Request Time and Date

Format: YYYY-MM-DDTHH:MM:SS.mmmZ

Type: String

Example: "createdDateTime":"2017-02-22T05:30:03.176Z"

5 priceList 1 Type: Array

Minimum: 1

Maximum: 1000

6 | priceListId 1 ERP Price List ID

See Price List Identification Section for the whole list

Type: String

Example: "priceListId": "1109"

7 | codeType 1 Price List type

Type: String

Use (hard code): PriceListIdentifier

Example: "codeType": "PriceListIdentifier"


3.3.2 Response Message



Type: String





Type: String

4 status 1 Message Status

Type: String

Values: Success, Error, Warning

5 itemDetails 1 Type: Array

6 | productDescription 1 Product Description

Type: String

7 | erpFamily 1 ERP Family

Type: String

8 | subscriptionType 1 Subscription Type

Type: String

9 | chargeType 1 Charge Type

Type: String

10 | productID 1 Product ID

Type: String

11 pageNo 1 Page Number

Type: Number

12 totalPages 1 Total Number of Pages

Type: Number


3.4 Get Offer Details API This API enables you to obtain product's detail attributes.

Note:

• Maximum number of PIDs (Product IDs) in Get Offer Details API request is 1000. If this limit is exceeded, the web

service will return with error code B1003.

• Please include only one priceListId in your request, as only one price list is allowed.




Type: String







Type: String


4 priceList 1 Type: Array

Minimum: 1

Maximum: 1000


See Price List Identification Section for the whole list

Type: String



Type: String



7 | itemList 1…n Type: Array

Item Type: String

Minimum: 1

Example: "itemList": [ “A-WX-CS-TA-BCTF”, “A-WX-CS-

TA-1K”,]



8 actionCode 1 Action Code for Rate Table Price details

Optional, if this element is provided in Request then

Response would return the complete Price details for Rate

Table SKUs.

Type: String

Use (hard code): “RatePrice”

Example: "actionCode": "RatePrice"




Type: String

2 createdBy 1 Name of the application that is making the

request




Type: String


Type: String


5 itemDetails 1 Type: Array

6 | productDescription 1 Product Description

Type: String

7 | erpFamily 1 ERP Family

Type: String

8 | productType 1 Product Type

Type: String

9 | productSubGroup 1 Product Sub Group

Type: String

10 | itemCatalogCategory 1 Item Catalog Category

Type: String



11 | erpPriceListID 1 ERP Prince List ID

Type: String

13 | unitOfMeasure 1 Unit of Measurement

Type: String

14 | qtyUnitOfMeasure 1 Quantity

Type: String

15 | baseDiscountCategory 1 Base Discount Category

Type: String

16 | upfrontDiscount 1 Up Front Discount

Type: String

17 | subscriptionType 1 Subscription Type

Type: String

18 | chargeType 1 Charge Type

Type: String

19 | deliveryMethod 1 Delivery Method

Type: String

20 | smartAccount 1 Smart Account Indicator

Type: String

21 | smartLicensingEnabled 1 Smart Licensing Enabled

Type: String

22 | billingModel 1…n Billing Model

Type: Array

23 | graceWindowForRenewal 1 Renewal Grace Window

Type: String

24 | provisioningInfoRequired 1 Provisioning Info Required

Type: String

25 | changeSubscriptionEnabled 1 Change Subscription

Type: String

26 | changeOfferEnabled 1 Change Offer

Type: String

27 | decimalExpansionValue 1 Decimal Expansion Value

The number of decimal points in the price

value.

Type: String



28 | initialStandardTerm 1…n Initial Standard Term

Type: Array

29 | defaultStandardTerm Default Standard Term

30 | initialRenewalTerm 1…n Initial Renewal Term

Type: Array

31 | defaultRenewalTerm 1 Default Renewal Term

Type: String

32 | productid 1 Product ID

Type: String

33 | currencyCode 1 Currency Code

Type: String

34 | pricePoints 1…n Type: Array

35 || version 1 Rate Table Version

Type: String

36 || listPrice 1 List Price

Type: String

37 || listPriceCurrency 1 Currency

Type: String

38 || rateTableName 1 Rate Table Name

Type: String

39 || rateTable 1 Rate Table

Type: String

40 || determinants 1…n Type: Array

41 ||| determinantType 1 Determinant Type

Type: String

42 ||| from 1 Determinant Quantity From

Type: String

43 ||| to 1 Determinant Quantity To

Type: String

44 |||| Rates 1 Determinant Name

(Will appear if actionCode is provided in

Request)

Type: Array



45 ||||| From 1 Determinant Value


Request)

Type: String

46 ||||| To 1 Determinant Value


Request)

Type: String

47 | NetPriceOnly 1 Net Price Only

Type: String

48 | errorMessage 0 Type: Object

49 || messageCode 0 Error Code

Type: String

50 || messageText 0 Error Message

Type: String


3.5 Get Mandatory Attach API This API enables you to obtain mapping of mandatory subscription that should be sold along with a hardware or

Software.

Note:

• Maximum number of PIDs (Product IDs) in Get Mandatory Attach API request is 1000. If this limit is exceeded, the

web service will return with error code B1003.

• Please include only one priceListId in your request, as only one price list is allowed.




Type: String







Type: String



Identifier of Cisco's price list. See Price List Identification

Section for the whole list

Type: String



Type: String



6 | majorHWAto 1…n Type: Array

Item Type: String

Minimum: 1

Example: " majorHWAto": [ “C9300-24U-A”, “A-WX-CS-

TA-1K”]

7 | majorSWAto 1..n Type: Array

Item Type: String

Minimum: 1

Example: " majorSWAto": [ “C9200L-48T-4X-E”]





Type: String





Type: String


Type: String


5 mandatoryAttachedMappingDe

tails

1 Type: Array

6 | majorHWAto 1 Hardware ATO name

Type: String

7 | mappingDetail 1 Type: Array

8 | majorSWAto 1 Mapped Software ATO name

Type: String

9 |mandatoryAttachedSubscripti

on

1 Mapped Mandatory Attached Subscription Items list

Type: Array


Error Message

4.1 Get Item Information & Get Mapped Service APIs There are three levels of error messages in any response:

o Message-level - For overall status of the request [‘ChangeStatus’ element]

o Header-level - For input/output parameters applicable to all line items [‘CatalogHeader’ element]

o Line-level- For input/output parameters applicable to an individual line item [‘CatalogLineItem’ element]

Error severity management: The success or failure to meet a business rule validation is handled in one of the following:

o A message-level “Failure” is the failure to meet a business rule that results in rejecting the entire request. The

partner must correct the problem and submit a new message

o A message-level “Partial Success” is the failure to meet a business rule that prevents processing for some

requested data. The request is processed except for the faulting Item(s) or input parameters which are rejected

o A “Warning” either at header-level or line-level is the failure to meet a business rule that does not prevent

processing the request but requires a partner attention as some requested data may not be in the response

o An “Error” at header-level is the failure to meet a business rule for an input/output parameter applicable to all line

items

o An “Error” at line-level is the failure to meet a business rule for an input/output parameter applicable only to the

faulting line

No. Error Codes Error Message

1 CC001H Success

2 CC002H Partial Success - Service cannot provide some requested data. See header-level and

line-level details

3 CC003H Failure - Service cannot provide any requested data. See header-level and line-level

details.

4 CC004H Error – Price List in required

5 CC005H Error - CCO ID is not entitled to the Price List.

6 CC006H Error -Requested data exceeds limit of <configurable limit> PIDs. Please refine your

search and try again.

7 CC007H Error -Mandatory tag or parameter is missing from the request.

8 CC008H Error -CCO ID is invalid.

9 CC009H Error -Price List is invalid.

10 CC010H Error - Item attribute name is invalid



11 CC011H Error - Service Program does not exist.

12 CC012H Error - Service Level does not exist.

13 CC013H Error - End User country code is invalid.

14 CC014H Error - CCO ID is not set up to determine Base Discount

15 CC015H Warning - Any item attribute without value is dropped.

16 CC016H Failure - Invalid Service name

17 CC017H Failure - There are no matching items.

18 CC018H Failure - More than one search criterion found. Please correct and try again.

19 CC019H Error - Sender has no access to the business data for the CCO ID in the request. Please

check client credentials and CCO ID.

20 CC020H Error - CCO ID is not for a distributor

21 CC021H Error - CCO ID is not entitled to the requested price book.

22 CC022H Error - Request cannot be for both price book and price list

23 CC023H Error - Request must have only one price book name

24 CC024H Error - Attribute is not relevant to the requested price book.

25 CC025H Error - Only distributors can request this attribute.

26 CC026H Error - Price book is required.

27 CC027H Error - Attribute is available only for DPP price book

28 CC028H Failure - Price Book is invalid.

29 SYS01H Failure - Service cannot generate a response. Please retry after some time. If issue

persists, please contact Cisco Support for help.

30 CC001L

31 CC002L Error - Item ID or expression is invalid

32 CC003L Error - Item is unavailable for pricelist

33 CC004L Warning - Duplicate Item



34 CC005L Warning - There is no data.

35 CC006L Error - Item is not available online. Please contact customer service for other options.

36 CC007L Error - Item failed entitlement check

37 CC008L Warning - Base discount is not applicable for the requested CCO ID, price list and end

user country.

38 CC009L Error - Item is unavailable for price book

39 Error - Please refine your search by including either Products or Services in your request.

40 Error - Request must have only one price book name or search by including either

Products or Services in your request.

4.2 Get Offers API


1 B1001 Missing item in the priceList array

2 B1002 The value in priceListId is inadequate with your CCO ID

3 B1005 Invalid CCO ID

4 B1006 Invalid value for priceListId string

5 B1007 Technical issues. Request cannot be fulfilled

6 B1025 Missing a value in the codeType string

7 B1026 Product is not available in the priceList


4.3 Get Offer Details API


1 B1001 Missing item in the priceList array


3 B1003 Request data in itemList array exceeded the limit

4 B1004 The value in itemList array is missing




8 B1008 Unavailable items in priceListId array. All items cannot be processed.

9 B1017 At least one input is invalid



4.4 Get Mandatory Attach API



2 B1003 Request data in MajorHWAto array exceeded the limit




6 B1008 Unavailable items in priceListId array. All items cannot be processed.

7 B1017 At least one input is invalid



10 B1027 Item does not have Mandatory attached subscriptions


Appendix A: Links & References OAGI BODs

GetCatalog

Format: XSD

GetCatalog

Format: JSON

ShowCatalog

Format: XSD

ShowCatalog

Format: JSON

Web Application Description Language

Catalog Apix

Format: WADL

Get Item Information Samples

Request

Format: XML

Response

Format: XML

Request

Format: JSON

Response

Format: JSON

Get Mapped Service Samples

Request

Format: XML

Response

Format: XML

Request

Format: JSON

Response

Format: JSON

Get Offers

Request

Format: XML

Response

Format: XML

https://www.cisco.com/E-Learning/gbo-ccw/cdc_bulk/Cisco_Commerce_B2B_Implementation_Guides/Catalog/Commerce_Catalog_Web_Services/GetCatalog_XSD.pdf

https://www.cisco.com/E-Learning/gbo-ccw/cdc_bulk/Cisco_Commerce_B2B_Implementation_Guides/Catalog/Commerce_Catalog_Web_Services/GetCatalog_JSON.pdf

https://www.cisco.com/E-Learning/gbo-ccw/cdc_bulk/Cisco_Commerce_B2B_Implementation_Guides/Catalog/Commerce_Catalog_Web_Services/ShowCatalog_XSD.pdf

https://www.cisco.com/E-Learning/gbo-ccw/cdc_bulk/Cisco_Commerce_B2B_Implementation_Guides/Catalog/Commerce_Catalog_Web_Services/ShowCatalog_JSON.pdf

https://www.cisco.com/E-Learning/gbo-ccw/cdc_bulk/Cisco_Commerce_B2B_Implementation_Guides/Catalog/Commerce_Catalog_Web_Services/catalog_Apix.wadl

https://www.cisco.com/E-Learning/gbo-ccw/cdc_bulk/Cisco_Commerce_B2B_Implementation_Guides/Catalog/Commerce_Catalog_Web_Services/getItemInformation_Request_XML.pdf

https://www.cisco.com/E-Learning/gbo-ccw/cdc_bulk/Cisco_Commerce_B2B_Implementation_Guides/Catalog/Commerce_Catalog_Web_Services/getItemInformation_Response_XML.pdf

https://www.cisco.com/E-Learning/gbo-ccw/cdc_bulk/Cisco_Commerce_B2B_Implementation_Guides/Catalog/Commerce_Catalog_Web_Services/getItemInformation_Request_JSON.pdf

https://www.cisco.com/E-Learning/gbo-ccw/cdc_bulk/Cisco_Commerce_B2B_Implementation_Guides/Catalog/Commerce_Catalog_Web_Services/getItemInformation_Response_JSON.pdf

https://www.cisco.com/E-Learning/gbo-ccw/cdc_bulk/Cisco_Commerce_B2B_Implementation_Guides/Catalog/Commerce_Catalog_Web_Services/getMappedService_Request_XML.pdf

https://www.cisco.com/E-Learning/gbo-ccw/cdc_bulk/Cisco_Commerce_B2B_Implementation_Guides/Catalog/Commerce_Catalog_Web_Services/getMappedService_Response_XML.pdf

https://www.cisco.com/E-Learning/gbo-ccw/cdc_bulk/Cisco_Commerce_B2B_Implementation_Guides/Catalog/Commerce_Catalog_Web_Services/getMappedService_Request_JSON.pdf

https://www.cisco.com/E-Learning/gbo-ccw/cdc_bulk/Cisco_Commerce_B2B_Implementation_Guides/Catalog/Commerce_Catalog_Web_Services/getMappedService_Response_JSON.pdf

https://www.cisco.com/E-Learning/gbo-ccw/cdc_bulk/Cisco_Commerce_B2B_Implementation_Guides/Catalog/Commerce_Catalog_Web_Services/offers_API_Request_Sample.pdf

https://www.cisco.com/E-Learning/gbo-ccw/cdc_bulk/Cisco_Commerce_B2B_Implementation_Guides/Catalog/Commerce_Catalog_Web_Services/offers_API_Response_Sample.pdf


Get Offer Details

Request GII Net price

Format: XML

Response GII Net price

Format: XML

Request Offer Details

Format: XML

Response Offer Details

Format: XML

Get Mandatory Attach

Request Get Mandatory

Format: JSON

Response Get Mandatory

Format: JSON

Other Links

Generate Token – IG

Format: PDF

Cisco Hello API – IG

Format: PDF

ISO Country Code (two digits)

Format: WADL

Cisco API Console

Format: HTML

https://www.cisco.com/E-Learning/gbo-ccw/cdc_bulk/Cisco_Commerce_B2B_Implementation_Guides/Catalog/Commerce_Catalog_Web_Services/GII_NetPriceOnly_Req.pdf

https://www.cisco.com/E-Learning/gbo-ccw/cdc_bulk/Cisco_Commerce_B2B_Implementation_Guides/Catalog/Commerce_Catalog_Web_Services/GII_NetPriceOnly_Res.pdf

https://www.cisco.com/E-Learning/gbo-ccw/cdc_bulk/Cisco_Commerce_B2B_Implementation_Guides/Catalog/Commerce_Catalog_Web_Services/offerDetails_API_Request_Sample.pdf

https://www.cisco.com/E-Learning/gbo-ccw/cdc_bulk/Cisco_Commerce_B2B_Implementation_Guides/Catalog/Commerce_Catalog_Web_Services/offerDetails_API_Response_Sample.pdf

https://www.cisco.com/E-Learning/gbo-ccw/cdc_bulk/Cisco_Commerce_B2B_Implementation_Guides/Catalog/Commerce_Catalog_Web_Services/GetMandatoryAttachRequest.pdf

https://www.cisco.com/E-Learning/gbo-ccw/cdc_bulk/Cisco_Commerce_B2B_Implementation_Guides/Catalog/Commerce_Catalog_Web_Services/GetMandatoryAttachResponse.pdf

https://www.cisco.com/E-Learning/gbo-ccw/cdc_bulk/Cisco_Commerce_B2B_Implementation_Guides/Access_Authorization/Create_Token_API/CCW_API_Generate_Token_IG.pdf

https://www.cisco.com/E-Learning/gbo-ccw/cdc_bulk/Cisco_Commerce_B2B_Implementation_Guides/Access_Authorization/Hello_Cisco_API/Hello_API_Setup_Packet_IG.pdf

http://www.iso.org/iso/country_codes/iso_3166_code_lists/country_names_and_code_elements.htm

https://apiconsole.cisco.com/


Appendix B: Attributes

This table contain the attributes that you could individually request (element #18) in the Get Item Information API.

No. Information Attributes No. Information Attributes

1 MajorLineOrderable 2 Configurable

3 Serialized 4 LeadTime

5 PriceProtection 6 WebOrderable

7 DeliveryMethod - to check available means to

deliver the Item 8

EoX - for all EoL milestones

Web Service will return:

• EOLExternalAnnounceDate

• EndofSaleDate

• EndofServiceContractRenewalDate

• LastDateofSupport

• EndofSWAvailability

• EndofNewServiceAttachmentDate

• EndofSWMaintenanceReleases

EndofVulnerabilityOrSecuritySupport

9 Stockable 10 OEA - for Orderability Environment Availability

(CCW, PRE-CCW, CCW-ONLY, BOTH)

11 SWSubscription - s/w subscription attributes

such as min/max quantities, quantity band,

min/max duration etc.

Web Service will return:

• SWSubscriptionMinQty (for minimum

quantity)

• SWSubscriptionMaxQty (for minimum

quantity)

• SWSubscriptionBandUOM (for band UoM)

• SWSubscriptionMinDuration (for minimum

duration)

• SWSubscriptionMaxDuration (for

maximum duration)

• SWSubscriptionDefaultDuration (for

default duration)

• SWSubscriptionDurationUOM (for duration

measurement)

12 PQDP - Product Quantity Delivery Preference

13 FulfillmentRestriction - Fulfillment restriction

Values:

• Yes

• No

• Block

• No Stock

14 SmartAccount - indicate whether Smart Account is

required

Values:

• Mandatory

• Optional

• Blank/Not Enabled



15 BaseDiscountCategory – Base discount

category

Values:

• Core

• Market

• Compute

16 ItemType - Item type

Values:

• REFURBUSHED

• CONFIG SUB

• PRODUCT LIST>$0

• ATO MODEL

• SPARE

• CONFIG SPARE

• BUNDLE

• INSTALL

• FEATURE PACK

• MAIN

NOTE: In XML response, ‘>’ in ‘PRODUCT LIST>$0’

will be encoded as ‘>’

17 UserSpecifiedStartDate - to indicate service

end-date can be aligned with existing contract

Values:

• Yes

No

18 RelatedHardwareProduct - hardware product

mapped to Item if it is a Service SKU. To be

repeated for each mapped hardware product

19 ServiceProgram - name of the service

program

20 ServiceLevel - name of the service level

21 ServiceLevelDescription – Service level

description

22 ItemClassification - to check the type of the item

such as hardware or software

23 PBURL - Product Bulletin URL

NOTE: In XML format, the URL will be

expressed as CDATA in order to ensure

partner program reads all characters literally

24 USECCN - Export Control Classification Number for

US. Dual-use items

**Authorized user only

25 EUECCN - Export Control Classification

Number for EU. Dual-use items


26 USHSTariff - Harmonized Tariff Schedule for US, by

World Customs Organization


27 EUHSTariff - Harmonized Tariff Schedule for

EU, by World Customs Organization


28 USCCATS - Commodity Classification Automated

Tracking System, by US Bureau of Industry and

Security


29 CCATSRevisionDate – CCATS revision date.

-Date Format Changed to Y2K format.


30 ANSSI – Security certification by Agence nationale

de la sécurité des systèmes d'information


31 DangerousGoodUNCode – Hazardous

material codes by UN/IATA


32 EncryptionLength – Bit strength of the symmetric

encryption algorithms contained in item




33 EncryptionStatus – US Gov classification

• Restricted

• Unrestricted

• Mass Market


34 HoldStatus – Lead time status

35 FullCartonQty – Quantity of units in a master

carton

36 FullPalletQty – Quantity of units in a full pallet

37 MinUnitWeight

Some products are configurable, and weight

may vary. For those cases, we have an

average weight, minimum/maximum weight

(for items with quantity), and single unit

38 MaxUnitWeight

Some products are configurable, and weight may

vary. For those cases, we have an average weight,

minimum/maximum weight (for items with quantity),

and single unit

39 SmartLicensingEnabled – indicate Smart

Licensing availability

Values:

• Yes

No

40 UPCID – UPC Code

41 ProductSubGroup

**This attribute will return in element # __ of

the response message

42 ERPFamily

**This attribute will return in element #31 of the

response message

43 ProductType

**This attribute will return in element #31

of the response message

44 ServiceIndicator

Values:

• Yes

• No

**This attribute will return in element #31 of the

response message

45 UNSPSCCode – United Nations Standard

Products and Services Code

**This attribute will return in element #32 of

the response message

In the response message, the element

contains listVersionID attribute

46 ProductDimension – Average linear dimensions and

weight of a hardware product

**This attribute will return four elements in the

response message:

• WidthMeasure (element# 34)

• LengthMeasure (element# 35)

• HeightMeasure (element# 36)

GrossWeightMeasure (element# 37)

47 Weight – Average weight of a hardware

product

**This attribute will return in

GrossWeightMeasure in the response

message (element #37)

48 ListPrice

**This attribute will return in ItemPrice in the

response message (element #39)



49 PriceListShortName – Price list code

**This attribute will return in UnitAmount in

the response message (element #38)

50 ProductMinorFamily

**If the product is a product minor family, this

attribute will return in ProductFamily in the response

message (element #45)

51 ProductMajorFamily

**If the product is a product major family, this

attribute will return in ProductFamily in the

response message (element #45)

52 ListPriceViewable – indicate whether item list

price is visible in CCW UI

Values:

• Yes

• No


53 ServiceDiscountCategory – Category for Service

Discount

Values:

A, B, C, D, S, N/A


54 RecurringOfferFlag- indicates whether item is

recurring for booking & Revenue.

Values:

• Y

• N

55 InternalBusinessEntity - Organizational groupings

of Sales, Operations, Services, etc.

Sample values-

Enterprise Routing, Collaboration, Computing

Systems, Monitoring and Analytics

56 SubscriptionMandatoryAttachFlag- Flag to

indicate the mandatory subscriptions to be

sold along with the item.

Values:

• Y

• N

57 SubscriptionMandatoryAttachMapping-Mandatory

Attached subscription Items to be sold with the

Item.

Sample Value- C1AA1TCAT93001-3Y,

C1AA1TCAT93001-5Y, C1AA1TCAT93001-7Y

If the Subscription Mandatory Attach flag is Y and

the Mandatory attached subscription Items are

available then only both the tags

SubscriptionMandatoryAttachFlag,

SubscriptionMandatoryAttachMapping would

appear.

If the Subscription Mandatory Attach flag is N then

only one tag - SubscriptionMandatoryAttachFlag will

appear.

58 IBTrackable- Flag to indicate Item is Install

base or not.

Values:

• Y

• N

59 ISServiceable- Flag to indicate if Item is

Serviceable or not.

Values:

• Y

• N



60 SoftwareType- Field to indicate the type of

software, if it is On-prem etc.

Values:

• Hybrid

• On-Premise

• SaaS

System SW

61 SoftwareStack- Field to indicate from which stack

the software belongs to,ex: Infrastructure,

Application etc.

Values:

• Platform

• Application

Infrastructure

62 LicenseType- Field to indicate the License

types, ex: Term, Perpetual etc.

Values:

• Term

• Perpetual

63 Warranty- Provides the Warranty Items names.

Values:

WARR-90-DAY-SW-TS etc.

64 ServiceDuration- Field to indicate Service

Duration for which the List Price is been

displayed in Reports for Service skus.

Values:

• 2 Years

• 3 Years etc.

65 NetPriceOnly – Field indicates whether the item is

NetPrice or not.

Values

• Y

• N


Appendix C: Price List Identification

No. Price List Desc ERP Price List ID Title

1 AUST 1027 Australia Price List in AUDs Ex-Tax

2 CHINA 1220 CHINA Price List in US Dollars

3 GLASIA 1441 Global Asia-Pac Price List in US dollars

4 GLBRL 801001111 Global Brazil Price List in BRL

5 GLCA 1129 Global Canada Price List in CANADIAN Dollars

6 GLCH 999999115 Global Price List China in CNY

7 GLEMEA 1110 Global Price List EMEA Availability

8 GLEMKT 800030156 Global Price List Emerging

9 GLEURO 1341 Global EMEA Price List in Euros

10 GLGB 1131 Global United Kingdom Price List in Pounds Sterling

11 GLICON 1111 Global Price List Latin America Availability

12 GLIN 13022 Global Price List - INDIA

13 GLKW 1300 Global Korean Price List in Korean Wons

14 GLRU2 999999111 Global Russia DDP PriceList in USD

15 GLRUS 800030157 Global Price List Russia

16 GLUS 1109 Global Price List US Availability

17 JPN 1004 JAPAN Price List in US Dollars

18 NH 1007 NIHON Price List in Japanese Yen

19 NIHONUSD 1501 Nihon Price List in US Dollars

20 S4JY 1382 Summa Four Price List in Japanese Yens

21 S4US 1381 Summa Four Price List in US Dollars


Revision History


13 09Sep2020 16 GetMappedService API Request,

Response enhancement detail added.

Error message added

Attribute CCAST Date format change

detail added.

Section

3.2.1, 3.2.2

Section 4.1

Appendix B

Ankita Raj

12 08June2020 15 Net Price Only Flag added Section 3.4.2

Appendix A

Appendix B

Kiran Lohani

11 05Jun2020 14.1 Added Recent Changes table to

highlight latest changes to the document

Recent

Changes

Dinesh Tathe

10 24Mar2020 14 New Get Mandatory Attach API details

added

Added Additional tag details in GetOffer

Detail API Request and Response.

EndPoint URL

Section 1.4

Section 3.5

Section 4.4

Error Message

Appendix A

Section 3.4.1

Section 3.4.2

Ankita Raj

9 23Oct2019 13 Migrated two APIs from Mulesoft to

Mashery. Added offers and offerDetails

APIs in the IG. Pagination was also

added in the offer’s API.

EndPoint URLs

Section 3.3

Section 3.4

Error Message

Appendix A

Appendix C

Tri Nguyen

8 10Sep2018 12 Added Subscription Mandatory Attach

Mapping, IB Trackable, IS Serviceable,

Software Type, Software Stack, License

Type, Warranty.

Appendix B Ankita Raj

7 12Jul2018 11 Added Subscription Mandatory Attach

Flag


6 6Jun2018 10 Added attributes:

• Recurring Offer Flag

• Internal Business Entity

• Modified samples

getItemInformation_Response_XML.pdf

getItemInformation_Response_JSON.pdf




5 2Mar2018 9 Added TnC Plus SKUs unitAmount

derivation in GII response.

Section 3.1.2 Ankita Raj

Added Max number of SKU per request.

Section 3.1 Tri Nguyen

4

28Feb2018 8.2 Added new column (Version) in Revision

History table.

Changed References table.

Revision

History

References

Tri Nguyen

3 14Jan2018 8.1

Format change Entire IG Tri Nguyen

2 11Sep2017 8.0

Decommissioned GetBaseDiscount API Section 2 and

5

Kiran Lohani

1 30May2017

7.0

Added dimension attributes:

• Full Carton Qty

• Full Pallet Qty

• Min Unit Weight

Max Unit Weight

Section 5.3

Kiran Lohani


Glossary

API Application Program Interface

ANSSI Agence Nationale de la Sécurité des Systèmes d'Information

BOD Business Object Document: Standard message formats used by the OAGI messaging standard CCO ID Cisco Connection Online User ID (Cisco.com)

CCW Cisco Commerce

DUNS Dunn & Bradstreet Universal Numbering System

ERP Enterprise Resource Planning

EUECCN Export Control Classification Number for EU. Dual-use items

PB Product Bulletin

PQDP Product Quantity Delivery Preference

SKU Stock Keeping Unit

SO Sales Order

REST Representational State Transfer

UPC Universal Product Code

UNSPSC United Nations Standard Products and Services

USECCN United States Export Control Classification Number

WS Web Service