Available APIs
Authentication - OAuth2.0
Inventory
Items
Inbound Shipments
Labels
Receipt
Location
Tracking
Document
Get Item
The Items API provides the capability of getting product information within the FedEx® Fulfillment platform.
Swagger
swagger: '2.0'
info:
x-ibm-name: items
title: Items
version: 1.0.0
schemes:
- https
host: $(catalog.host)
basePath: /v1
consumes:
- application/json
produces:
- application/json
securityDefinitions:
oauth2:
type: oauth2
description: ''
flow: accessCode
authorizationUrl: 'https://<.....................>/fsc/oauth2/authorize'
scopes:
Fulfillment_Returns: ''
tokenUrl: 'https://<.....................>/fsc/oauth2/token'
Client_Secret:
type: apiKey
description: Enter Client Secret
in: header
name: X-IBM-Client-Secret
Client_Id:
type: apiKey
in: header
name: X-IBM-Client-Id
description: Enter Client ID
security:
- Client_Id: []
Client_Secret: []
oauth2:
- Fulfillment_Returns
x-ibm-configuration:
testable: true
enforced: true
phase: realized
paths:
get:
responses:
200:
description: 200 OK
parameters:
- name: Accesstoken
type: string
required: false
in: header
description: Enter AccessToken, it is mandatory.
- name: query_parameter
type: string
required: false
in: query
description: 'Enter all the query parameters. Sample: attributeType=Size&responseFilter=DETAIL&nextTimestamp=1461329357153&pageLimit=1'
tags: []
consumes:
- application/json
- text/plain
produces:
- application/json
Sample Request
• Retrieve all item details using itemId
https://<........>/api/v1/items?itemId=41452&responseFilter=DETAIL
• Retrieve only Summary item details of item created on or after the timestamp provided
https://<........>/api/v1/items?responseFilter=SUMMARY&nextTimestamp=1461329357153&attributeType=Size
Sample Response
Success Response
{
"requestIdentifier": "d457d916-29bd-11e7-bb57-0ac4432900",
"transactionDate": "2017-04-25T09:48:14-04:00",
"success": true,
"items": [ {
"itemId": 40404,
"dimentions": {
"height": 2,
"length": 2,
"width": 2
},
"weight": 6,
"lowStockThreshold": 100,
"sku": "005-010-0001",
"upc": "3243242134",
"itemCost": 100,
"retailPrice": 10,
"name": "Inventory testing",
"returnItemInfo": {
"serialNumber": false,
"countryOfOriginRequired": false,
"returnable": true,
"destination": "RET",
"requireRepCapture": false
},
"battery": false,
"fragile": false,
"hazardMaterial": false,
"liquid": false,
"perishable": false,
"productCategory": 1,
"barCodeMarked": false,
"variants": [
{
"attributeKey": "Size",
"attributeValue": "S"
},
{
"attributeKey": "Color",
"attributeValue": "Black"
}
],
"serializationRequired": false,
"batchLotRequired": false,
"polyBagRequired": false,
"shipAlone": false,
"internationalShipping": false,
"caseDetails": []
}],
"paging": {
"previous": "https://<..........>/api/v1/items?attributeType=Size&pageLimit=1&prevTimestamp=1461517674216",,
"next": "https://<..........>/api/v1/items?attributeType=Size&pageLimit=1&nextTimestamp=1461517674216""
}
}
OAuth 2.0
| HTTP Headers | Description |
|---|---|
| Authorization | You must always provide the access token for authorization to access the API. HTTP-Header Value Authorization Bearer accessToken |
| Origin | Origin URL. HTTP-Header Value Origin domain.com |
Custom authentication
| HTTP Headers | Description |
|---|---|
| X-IBM-Client-Id | You must always provide in the HTTP header your API portal application's client ID (X-IBM-Client-Id) to access the API. HTTP-Header Value X-IBM-Client-Id ************ |
| X-IBM-Client-Secret | You must always provide in the HTTP header your API portal application's client secret (X-IBM-Client-Secret) to access the API. HTTP-Header Value X-IBM-Client-Secret ************ |
| AccessToken | Application Access Token |
| Origin | Origin URL. HTTP-Header Value Origin domain.com |
Query Parameters
| Parameter | Data type | Description | Multiple values allowed | Required |
|---|---|---|---|---|
| responseFilter | String | SUMMARY or DETAIL | N | N |
| itemId | String | FedEx® item ID generated by the system. | N | N (At least one search field is required) |
| sku | String | The item code or SKU. | N | N (At least one search field is required) |
| upc | String | Universal product code for the item. | N | N (At least one search field is required) |
| categoryId | String | Category ID for this item. Valid Values:See the dropdown list for Category ID. ID NAME 1 Apparel & Accessories 2 Automotive 3 Books 4 Chemicals & Cleaners 5 Electronics 6 Food & Beverage 7 Health & Beauty 8 High Value 9 Hobbies 10 Houseware 11 Movies & Music 12 Nutraceuticals 13 Sports & Fitness 14 Toys 15 Others |
N | N (At least one search field is required) |
| attributeType | String | Variant label to specify an attribute for the item, e.g., size or color. | N | N (At least one search field is required) |
| attributeValue | String | Variant value given to the respective attribute type. | N | N (At least one search field is required) |
| statusCode | Boolean | Indicates whether the item is Active. Valid Values: True or False |
N | N (At least one search field is required) |
| pageLimit | Number | Number of records to be retrieved on each page. Allowed Values: 1 to 100. Default is 50. |
N | N |
| prevTimestamp | String | Timestamp to retrieve the previous page. Not applicable for initial request | N | N |
| nextTimestamp | String | Timestamp to retrieve the next page. Not applicable for initial request | N | N |
Response Summary
| Parameter | Data type | Description |
|---|---|---|
| requestIdentifier | String | Request identifier |
| transactionDate | String | Transaction date/time |
| success | boolean | Status of the transaction Valid Values: true false |
| itemId | String | FedEx item ID generated by the system. |
| sku | String | Item code or SKU. |
| name | String | Short description for the catalog item. |
| upc | String | Universal product code for the item, if it is marked with a bar code. |
| productCategory | String | Category description for this item. |
| statusCode | Boolean | Indicates whether the item is active. Valid Values:True or False |
| attributeType | String | Indicates the variant attributes for the product e.g., size or color. |
| attributeValue | String | Indicates the value given to the attributeType. |
| paging | ||
| previous | String | Link to retrieve the previous page, if applicable. |
| next | String | Link to retrieve the next page, if applicable. |
| errors[] | ||
| code | String | Code associated with the error. |
| description | String | Description of the error. |
Response Details
| Parameter | Data type | Description | |
|---|---|---|---|
| requestIdentifier | String | Request identifier | |
| transactionDate | String | Transaction date/time | |
| success | boolean | Status of the transaction Valid Values: true false |
|
| itemID | String | FedEx item ID generated by the system. | |
| weight | Number | Weight of an individual item, in pounds, to the nearest hundredth of a pound. | |
| lowStockThreshold | Number | Low stock threshold for the item.Number of units that will trigger an alert when the inventory goes below the value entered. | |
| sku | String | Item code or SKU.This code is unique to the item and is used for stock-keeping purposes. | |
| name | String | Short description for the catalog item, e.g., Rosemary Hand Balm. | |
| upc | String | Universal product code for the item, if it is marked with a bar code. | |
| itemCost | String | Cost of the item for your business. This information is used with reports. |
|
| retailPrice | String | Retail price for the item. This information is used with reports and is printed on commercial invoices. |
|
| battery | Boolean | Indicates whether the item contains a battery. If you enter “true”, you also need to provide an entry for battery type. |
|
| longDescription | String | Detailed description for the item. | |
| fragile | Boolean | Indicates whether the item is fragile. If you enter “true”, additional fees may apply to handling this item. |
|
| hazardMaterial | Boolean | Indicates whether the item is hazardous. If the item is hazardous, speak to a customer success specialist before sending the item to the fulfillment center. |
|
| liquid | Boolean | Indicates whether the item contains liquid. | |
| perishable | Boolean | Indicate whether the item is prone to spoilage or decay. If you enter “true”, you also must provide an entry for shelf life. |
|
| productCategory | String | Category description for this item. | |
| barCodeMarked | Boolean | Indicates whether the item is marked with a bar code. If the item is not marked with a bar code, additional processing fees may apply. |
|
| shelfLife | Boolean | Number of days prior to the product expiration date. Perishable products are not shipped if they are at their shelf life limit. |
|
| batteryType | String | Type of battery the item contains. This information is used to determine what methods of shipment are possible within regulations for hazardous materials. |
|
| serializationRequired | Boolean | Indicates whether the fulfillment center needs to track individual items by serial numbers on the item. If you enter “true”, additional fees may apply to handling this item. |
|
| batchLotRequired | Boolean | Indicates whether the item requires additional tracking of the product by batch or lot number. If you enter “true”, additional fees may apply to handling this item. |
|
| polyBagRequired | Boolean | Indicates whether the item can ship in a polyurethane bag with no additional packaging. | |
| shipAlone | Boolean | Indicates whether the item can ship in its own packaging. | |
| internationalShipping | Boolean | Indicates whether the item can ship internationally. | |
| countryCode | String | Two-character country code. This entry is required if the item may be shipped internationally. Valid Values: See the dropdown list for |
|
| brand | String | Brand of the item, e.g.,Apple, DELL. | |
| model | String | Model of the item. | |
| subCategory | String | A subgroup of a category. Example: If Category = Electronics, a Subcategory = Laptop. |
|
| productClass | String | An identifier indicating how the specific product differs from the normal products, such as high dollar, special handling, etc. | |
| hsCode | String | 6 -digit Harmonized System code Example: 1040.60 |
|
| size | String | Size of the product. Example – Medium. |
N |
| color | String | Color of the product. Example – Red. |
N |
| style | String | Style of the product. Example – Skinny. |
N |
| Dimensions | |||
| height | Number | Height of the product in inches. | |
| length | Number | Length of the product in inches. | |
| width | Number | Width of the product in inches. | |
| returnItemInfo | |||
| serialNumber | String | Indicates whether the item requires a serial number during the return process. | |
| shippingService | String | Indicates whether special shipping is needed for returning the item. Valid Values: EX (FedEx® Express),GR (FedEx® Ground) If you leave this null, FedEx calculates it for you. |
|
| countryOfOriginRequired | Boolean | Indicates whether the country of origin is needed during the return process. | |
| returnable | Boolean | Indicates whether the item can be returned after a sale. | |
| returnDaysLimit | Number | Number of days from original order date when the item is eligible for return. | |
| destination | String | Indicates how the return item should be handled e.g., Destroy, Salvage, Vendor Return. | |
| requireRepCapture | Boolean | Indicates whether the item requires authorization during the return process. | |
| casPackingSku[] Limit 3 | |||
| packingSku | String | The packing sku used for the item being returned. This is an array value. You can add up to three values within the array. The first will be marked as the primary SKU. |
|
| Variants[] - Indicates the variant attributes for the product Limit 3 | |||
| attributeKey | String | Indicates the variant attributes key for the product, e.g., size or color. | |
| attributeValue | String | Indicates the variant attributes value for the product, e.g., Medium or Black. | |
| caseDetails[] - Indicates the item is packaged in multiple case levels Limit 3 – 1 per valid case type |
|||
| id | Number | ||
| caseType | String | Valid Values for case types:innerCase, masterCase, palletCase | |
| barCode | String | Barcode for the case | |
| height | Number | Height dimension for the case | |
| length | Number | Length dimension for the case | |
| width | Number | Width dimension for the case | |
| weight | Number | Weight of the case | |
| numberOfUnits | Number | Number of units in the case | |
| paging | |||
| previous | String | Link to retrieve the previous page, if applicable. | |
| next | String | Link to retrieve the next page, if applicable. | |
| errors[] | |||
| code | String | Code associated with the error | |
| description | String | Description of the error |
HTTP Status Code
| Code | Description |
|---|---|
| 200 | OK - HTTP Response for successfully processed requests |
| 400 | Bad Request. |
| 403 | Forbidden |
| 404 | Not Found - Server couldn’t find anything matching request URI |
| 500 | Internal Server Error – Unable to process the request |
Error Code
| Code | Description |
|---|---|
| ERR-SYS-0001 | Your request cannot be processed due to a system error. |
| ERR-CMR-0001 | Input data validation failed. |
| ERR-CMR-0002 | Authentication Failed. Invalid Access Token. |
| ERR-CMR-0003 | Missing mandatory fields. |
| ERR-PDT-0001 | Product <item_sku> Required fields missing |
| ERR-PDT-0002 | Product <item_sku> already exist in the platform |
| ERR-PDT-0003 | Product <item_sku> battery type is needed when Contains Battery equals yes |
| ERR-PDT-0004 | Product <item_sku> Shelf Life Days is needed when Perishible equals yes |
| ERR-PDT-0005 | Product <item_sku> Attribute Type Value is needed |
| ERR-PDT-0006 | Product <item_sku> Attribute Value Type is needed |
| ERR-PDT-0007 | Product <item_sku> Inner Case Number Of Units is needed |
| ERR-PDT-0008 | Product <item_sku> Master Case Number Of Units is needed |
| ERR-PDT-0009 | Product <item_sku> Pallet Number Of Units is needed |
| ERR-PDT-0010 | Product <item_sku> Category value is not a match to the values available |
| ERR-PDT-0011 | Product <item_sku> Low Stock Threshold value does not match the values available |
| ERR-PDT-0012 | Product <item_sku> Type of Battery does not match the values available |
| ERR-PDT-0013 | Product <item_sku> Country of Origin value does not match the values available |
| ERR-PDT-0014 | Product <item_sku> Invalid <case_type> Number Of Units |
| ERR-PDT-0015 | Product <item_sku> Number Of Units cannot be updated when inventory is available. |
| ERR-PDT-0016 | Product <item_sku> Return Condition Disposition code does not match the values available |
| ERR-PDT-0017 | Product <item_sku> second quality SKU is missing |
| ERR-PDT-0018 | Product <item_sku> second quality SKU does not exist |
| ERR-PDT-0019 | Product <item_sku> Return Disposition Return to Vendor location is needed |
| ERR-PDT-0020 | Product <item_sku> Return to Vendor location does not match the values available |
| ERR-PDT-0021 | Product <item_sku> Field exceeds character limit |
| ERR-PDT-0026 | Product <item_sku> Country of origin is needed when International Shipping equals yes |
| ERR-PDT-0027 | Product <item_sku> HS code is needed when International Shipping equals yes |
| ERR-PDT-0028 | Product <item_sku> HS code is not in the required format |
| ERR-PDT-0029 | Connection is inactive |
| ERR-PDT-0030 | Required fields missing for bundles |
| ERR-PDT-0031 | Invalid product category code |
| ERR-PDT-0032 | Item quantity in the bundle is less than 2 |
| ERR-PDT-0033 | Invalid product selected |
| ERR-PDT-0034 | Product <item_sku> Shelf life days is not integer |
| ERR-PDT-0035 | Product <item_sku> Length is not greater than 0 |
| ERR-PDT-0036 | Product <item_sku> Width is not greater than 0 |
| ERR-PDT-0037 | Product <item_sku> Height is not greater than 0 |
| ERR-PDT-0038 | Product <item_sku> Weight is not greater than 0 |
| ERR-PDT-0039 | Product <item_sku> Invalid <case_type> Length |
| ERR-PDT-0040 | Product <item_sku> Invalid <case_type> Width |
| ERR-PDT-0041 | Product <item_sku> Invalid <case_type> Height |
| ERR-PDT-0042 | Product <item_sku> Invalid <case_type> Weight |