Custom Gateway - Customer Support


Welcome to the Custom Gateway Support Portal

Here you can raise support tickets and read articles on common queries using the topic sections and search below

Custom Product Platform (CPP) Product Management API

Follow

Functionality

● Export new products from the CPP - added since a date

● Export updates to existing products from the CPP = updated since a date

● Export products from certain CPP product categories.

● Export product categories from CPP

● The available product categories are determined by a user login.

 

User Authentication

User authentication is required so that the list of available product categories (and therefore available products) can be restricted on a per store basis.

The CPP API exposes a simple JSON based interface for user authentication.

Example Request:

POST https://my.gateway3d.com/acp/api/p/1/auth

Content-Type: application/json

{ username: “bob”, password: “foobar” }

Example Response Body:

Content-Type: application/json

Set-Cookie: PHPSESSID=xxxxxxxxxxxxxxxxxxxxxxxxxxx; path=/; HttpOnly

{ user_id: 219 }

Note that the response will include a Set-Cookie directive. The cookie name and value should be retransmitted as part of of any future requests to the server.

The cookie will expire after 3600 seconds, any requests after this time period will need to be reauthenticated.

Please do not assume that the name of the cookie will always be PHPSESSID.

If user authentication fails or the session has expired then the server will return either a 4xx or a 5xx HTTP status code along with a JSON encoded object representing the error.

 

Retrieving a List of Categories

Retrieves a list of all the categories your login has access to.

Example Request:

GET https://my.gateway3d.com/acp/api/auto-import/1/categories

Cookie: PHPSESSID=xxxxxxxxxxxxxxxxxxxxxxxxxx

Example Response:

Content-Type: application/json

{

categories: [

{

id:

ref: “abcdefgi0123”,

name: “Mugs”

image_url:

parent_id:

left:

right:

},

{

id:

ref: “hijklmop456”,

name: “TShirts”

image_url:

parent_id:

left:

right:

}

]

}

 

Retrieving a List of Products

Example Request:

GET https://my.gateway3d.com/acp/api/auto-import/1/products/?

lastModifiedSince=2014-06-20T12:00:00+00:00&category=abcdef

Cookie: PHPSESSID=xxxxxxxxxxxxxxxxxxxxxxxxxx

Example Response:

Content-Type: application/json

{

/* only if there’s another page */

nextPage: “https://my.gateway3d.com/...../...?..&page=1&category=abcdef”,

/* otherwise */

nextPage: false,

/* sorted by last modified */

products: [

{

ref: “...”, /* Unique G3D product ref */

sku: “...”,

name: “...”,

supplier: “...”,

description: “...”,

lead_time: “...”,

weight: “...”,

supplier_sku: “...”,

min_sale_qty: “...”,

price: 0.00,

tiers: [

{ quantity: 0, price: 0.00 },

{ quantity: 0, price: 0.00 },

},

“image_url”: “...”, /* please hotlink */

“thumbnail_url: “...”, /* please hotlink */

/* Personalise-iT module iframe attributes */

personaliseit_gl_iframe_url: “...”,

personaliseit_fl_iframe_url: “...”,

personaliseit_m_iframe_url: “...”,

personaliseit_iframe_url: “...”,

easypromo3d_url: “...”,

personaliseit_company_ref_id: “”, /* for future use */

category_refs: [], /* list of numeric IDs */

/* possibly other fields - will confirm */

}

]

}

Was this article helpful?
0 out of 0 found this helpful

Comments