Global References

This section covers the global references, objects, enumerator definitions used across the PIM API.

Response Wrapper Model

This is the response wrapper object which wraps all the data responses returned by the API. The endpoint specific data is populated in result property of the object.

Response Model

Response

{
    "statusCode": 200,
    "status": "OK",
    "error": null,
    "errorId": null,
    "message": null,
    "messageCode": "OK",
    "result": [
      { 
        //API endpoint specific object 
      }
    ]
}

Name	Type	Description
statusCode	int	Holds the http status codes, typically 200 for success and 500 for error.
status	string	Holds the status name related to the status code.
error	string	Error message in case of any error.
errorId	string	Unique Error Id generated for the specific error, used for reference while creating a support ticket.
message	string	Message to display on front end if any in case of errors. Typically left blank in case of successful operation.
messageCode	string	Message code related to the response.
result	object	Contains the API endpoint specific data object.

Product Types

ProductType	value
Product	1
Service	2
GiftCard	4
Bundle	7
DynamicBundle	8
Addon	10
GiftWrap	11
GiftBox	189
GiftBoxLine	202

RelationType	Description
GWP	Gifts with Purchase
UPGRADE	Upgrade option
ALSOLIKE	you may also like
ALSONEED	you may also need
BASKETGROUP	displayed in basket when items are added
ADDONS	Add on for the product
ALTERNATIVE	Alternative for the product
WORKSWITH	works with the product

System Status

Status	Value
None	0
Draft	1
Active	2
Archived	3
Discontinued	4

Action

Actions	Value
Create	1
Update	2
Delete	3

Task Status

TaskStatus	Value
Open	1
InProgress	2
Completed	3

SupplierTypes

SupplierTypes	Value
Individual	1
Company	2

SupplierPOCreateTypes

SupplierPOCreateTypes	Value
None	0
OnePOAgainstEachSO	1
ConsolidatePOForMultipleSO	2

PurchasabilityTypes

PurchasabilityType	Value
OnlineStore	1
PreOrder	2
ForwardOrder	3

MessageCodes

MessageCodes	Value
CreatedSuccessfully	2000
AddedSuccessfully	2001
SavedSuccessfully	2002
UpdatedSuccessfully	2003
DeletedSuccessfully	2004
ErrorOccurred	2005

SearchFor

SearchFor	value
Both	0
Master	1
Variant	2

Media Types

MediaTypes	Value
Image	0
Video	1
Pdf	2

Field Update Types

FieldUpdateType	Value
Both	0
Master	1
Variant	2

Input Types

InputType	Value
Text	1
Select	2
LongText	3
Date	4
Radio	5
Multi-select	6
Datetime	12
Multi-level-select	13
Number	14