{"info":{"_postman_id":"61c14f3d-9a74-4f05-9c13-bf56a3054701","name":"Vendors API (deprecated)","description":"

Public CorporateGift.com API

\n

Receive, process, and manage Corporategift.com orders through our Order Management API.

\n

Corporategift.com authenticates your API requests using your account’s API token. If you do not include your key when making an API request, or use one that is incorrect or outdated, API returns an error.

\n

Every account is provided a token that can be obtained from the vendor rep.

\n

General API urls:

\n

Production:
https://api.corporategift.com/api/

\n

Test:
https://api.staging.corporategift.com/api/

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Public CorporateGift.com API","slug":"public-corporategiftcom-api"}],"owner":"7014849","collectionId":"61c14f3d-9a74-4f05-9c13-bf56a3054701","publishedId":"TzCV1ijF","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2022-08-16T08:47:06.000Z"},"item":[{"name":"Orders","item":[{"name":"Get Order By ID","id":"f7ac83b4-fe02-49aa-9a56-04aaab92f95d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{api_base_url}}/api/shared/orders/100153957","description":"

This request allows the vendor to get specific order details (with the products assigned to the vendor) using the order ID parameter.

\n

Example

\n

https://api.corporategift.com/api/shared/orders/ID

\n\n

curl --location --request GET 'https://api.staging.corporategift.com/api/shared/orders/100044084' \\

\n\n

--header 'Content-Type: application/json' \\

\n\n

--header 'Accept: application/json' \\

\n\n

--header 'Authorization: Bearer 7042|UyGBRKexqiLvYqSuoMdm9WIsZQEWo8CDLIiTSSju' \\

\n\n

--header 'Cookie: frontend=b75n6aptv651d9c8rbf35ed9r5; google_csrf=b338fcf2f89045ec5e59ada3af155583'

\n\n

We will Return:

\n

Field

Description

Type

data

Main response container.

object

data.id

Current order ID.

int

data.name

Order name.

string

data.created_at

Order creation date.

string

data.shipping_method

Method of shipping. If different shipment methods were chosen, returns \"Vendor Shipping\" and each order item gets its own shipping_method parameter.

string

data.shipping_arrival_date

Date of shipment arrival.

string

data.is_paid

Payment status indicator.

boolean

data.is_fully_shipped

Shipment status indicator. Returns true if every order product was sent.

boolean

data.is_partially_shipped

Shipment status indicator. Returns true if at least one order product was sent and no everything was sent.

boolean

data.gift_message

Gift message.

string

data.address

Address data container.

object

data.address.firstname

Recipient first name.

string

data.address.lastname

Recipient last name.

string

data.address.country

Recipient country code.

string

data.address.postcode

Recipient postcode.

string

data.address.city

Recipient city.

string

data.address.street

Recipient street.

string

data.items

Product items container.

object

data.items.sku

Product SKU code.

string

data.items.name

Product name.

string

data.items.qty

Ordered product quantity.

int

data.items.gift_message

Gift message.

string

data.items.options

Product options container.

array

data.items.options.label

Option label.

string

data.items.options.value

Option value.

string

","urlObject":{"path":["api","shared","orders","100153957"],"host":["{{api_base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f7ac83b4-fe02-49aa-9a56-04aaab92f95d"},{"name":"Get Orders List","id":"ff5b36a2-f7e6-47df-a723-5c9b55a8026f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[]},"url":"{{api_base_url}}/api/shared/orders?visibility=all&page=1&per_page=15","description":"

This request allows the vendor to get a detailed list of orders containing the vendor’s products.

\n

Example

\n

https://api.corporategift.com/api/shared/orders?date_from=2021-03-01&date_to=2021-04-09&page=1

\n

url --location --request GET 'https://api.staging.corporategift.com/api/shared/orders?date_from=2016-10-16&date_to=2016-10-18&page=1'
--header 'Accept: application/json'
--header 'Authorization: Bearer 7042|UyGBRKexqiLvYqSuoMdm9WIsZQEWo8CDLIiTSSju'
--header 'Cookie: frontend=b75n6aptv651d9c8rbf35ed9r5; google_csrf=b338fcf2f89045ec5e59ada3af155583'

\n

Search query parameters in url

\n\n\n\n

We Will Return:

\n

Field

Description

Type

data

Main response container.

array

data[].id

Current order ID.

int

data[].name

Order name.

string

data[].created_at

Order creation date.

string

data[].shipping_method

Method of shipping. If different shipment methods were chosen, returns \"Vendor Shipping\" and each order item gets its own shipping_method parameter.

string

data[].shipping_arrival_date

Date of shipment arrival.

string

data[].is_paid

Payment status indicator.

boolean

data[].is_fully_shipped

Shipment status indicator. Returns true if every order product was sent.

boolean

data[].is_partially_shipped

Shipment status indicator. Returns true if at least one order product was sent and no everything was sent.

boolean

data[].gift_message

Gift message.

string

data[].address

Address data container.

object

data[].address.firstname

Recipient first name.

string

data[].address.lastname

Recipient last name.

string

data[].address.country

Recipient country code.

string

data[].address.postcode

Recipient postcode.

string

data[].address.city

Recipient city.

string

data[].address.street

Recipient street.

string

data[].items

Product items container.

object

data[].items.sku

Product SKU code.

string

data[].items.name

Product name.

string

data[].items.qty

Ordered product quantity.

int

data[].items.gift_message

Gift message.

string

data[].items.options

Product options container.

array

data[].items.options.label

Option label.

string

data[].items.options.value

Option value.

string

links

Pagination links container.

object

links.first

First results page.

string

links.last

Last results page.

string

links.prev

Previous results page.

string

links.next

Next results page.

string

meta

Metadata container.

object

meta.current_page

Current page number.

int

meta.from

First page number.

int

meta.last_page

Last page number.

int

meta.path

Base url.

int

meta.per_page

Orders per page.

int

meta.to

int

meta.total

Total orders count.

int

meta.links

Pages links container.

array

meta.links[].url

Page url.

string

meta.links[].label

Page link label.

string

meta.links[].active

Link status indicator.

boolean

","urlObject":{"path":["api","shared","orders"],"host":["{{api_base_url}}"],"query":[{"disabled":true,"key":"date_from","value":"2021-08-01"},{"disabled":true,"key":"date_to","value":"2021-08-30"},{"description":{"content":"

default is unshipped

\n","type":"text/plain"},"key":"visibility","value":"all"},{"key":"page","value":"1"},{"key":"per_page","value":"15"},{"disabled":true,"key":"order_number","value":"100093409"},{"disabled":true,"description":{"content":"","type":"text/plain"},"key":"cg_sku","value":""}],"variable":[]}},"response":[],"_postman_id":"ff5b36a2-f7e6-47df-a723-5c9b55a8026f"},{"name":"Start Handling Order","id":"57eed5b5-7d1e-40ed-a957-6b13233b344f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": \"12345\"\n}","options":{"raw":{"language":"json"}}},"url":"{{api_url}}/shared/orders/100004378/start-handling","description":"

This request should be sent when the vendor starts processing a specific order.

\n

Example:

\n

https://api.corporategift.com/api/shared/orders/ID/start-handling\ncurl --location --request POST 'http:///api.corporategift.com/api/shared/orders/OrderID/start-handling'
--header 'Accept: application/json'
--header 'Authorization: Bearer 23500|Uea1DlXJLHnVmzxhezflE1fmMEnPqWtSkOD2W0gT'
--header 'Content-Type: application/json'
--data-raw '{\n \"id\": \"12345\"\n}'

\n

Parameters in url

\n\n\n

Data in request body

\n\n\n

We will return:
\n{success: true | false}

\n","urlObject":{"path":["shared","orders","100004378","start-handling"],"host":["{{api_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"57eed5b5-7d1e-40ed-a957-6b13233b344f"},{"name":"Create Shipment","id":"1d62dc97-c1cf-41c7-a1dc-f11ae2a9c123","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"order_id\": \"100093409\",\n \"track_number\": \"123456\",\n \"title\": \"ground\",\n \"carrier_code\": \"fedex\"\n}","options":{"raw":{"language":"json"}}},"url":"{{api_base_url}}/api/shared/orders/create-shipment","description":"

With this request a vendor can create a new shipment for an order.

\n

Example:

\n

https://api.corporategift.com/api/shared/orders/create-shipment\ncurl --location --request POST 'http://api.corporategift.com/api/shared/orders/create-shipment'
--header 'Accept: application/json'
--header 'Content-Type: application/json'
--header 'Authorization: Bearer 23500|Uea1DlXJLHnVmzxhezflE1fmMEnPqWtSkOD2W0gT'
--data-raw '{\n \"order_id\": \"100000819\",\n \"track_number\": \"123456789\",\n \"title\": \"\",\n \"carrier_code\": \"Fedex\"\n}'

\n

Data in request body

\n
  • order_id - Our Order ID.
  • track_number - Tracking number of the created shipment.
  • title - Title of the shipment.
  • carrier_code - Name of the shipping carrier.
\n\n

We Will Return:
\n{success: true | false}

\n","urlObject":{"path":["api","shared","orders","create-shipment"],"host":["{{api_base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"1d62dc97-c1cf-41c7-a1dc-f11ae2a9c123"},{"name":"Reject","id":"ce3fe494-f109-4fe9-9824-bd5ebe479fa4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"PATCH","header":[],"body":{"mode":"formdata","formdata":[]},"url":"{{api_url}}/shared/orders/100145851/reject","urlObject":{"path":["shared","orders","100145851","reject"],"host":["{{api_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ce3fe494-f109-4fe9-9824-bd5ebe479fa4"}],"id":"3d5c1931-ab19-4d6c-a3bf-899eb8195b25","description":"

ORDERS API

\n

Get - Get Order By ID
\nGet - List Orders
\nPost - Start Handling Order
\nPost - Create Shipment for Orders
\nPatch - Reject an Order

\n","_postman_id":"3d5c1931-ab19-4d6c-a3bf-899eb8195b25","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"61c14f3d-9a74-4f05-9c13-bf56a3054701","id":"61c14f3d-9a74-4f05-9c13-bf56a3054701","name":"Vendors API (deprecated)","type":"collection"}}},{"name":"Inventory","item":[{"name":"Update Stock","id":"db588cc7-979c-4129-8638-f6617ad672be","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"products\": [\n {\n \"sku\": \"86-J3B5-PRT0\",\n \"qty\": 900\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{api_url}}/shared/products/update-stock-level","description":"

Send a JSON request with parameters of your internal sku and the qty.\nIf set to 0 or negative it will go out of stock and will not be available on Corporategift.com

\n","urlObject":{"path":["shared","products","update-stock-level"],"host":["{{api_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"db588cc7-979c-4129-8638-f6617ad672be"}],"id":"6ae0fb10-d561-44aa-8932-dd721d44d87c","description":"

Update inventory levels on Corporategift.com

\n","_postman_id":"6ae0fb10-d561-44aa-8932-dd721d44d87c","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"61c14f3d-9a74-4f05-9c13-bf56a3054701","id":"61c14f3d-9a74-4f05-9c13-bf56a3054701","name":"Vendors API (deprecated)","type":"collection"}}}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]}},"event":[{"listen":"prerequest","script":{"id":"94237025-d5ef-439e-9cbb-afb0dc96c1a9","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"13151c76-e866-42f1-b608-1a1a10a5aed4","type":"text/javascript","exec":[""]}}]}