Orkiv tutorials > Inventory > REST API

  • Array of Inventory groups within the current account Unexpected error This API call produces the following media types according to therequest header; the media type will be conveyed by theresponse header.Array of Inventory groups within the current accountUnexpected error Error

    If no ID is specified a new category will be created!

  • Url to resource Unexpected error This API call consumes the following media types via therequest header:This API call produces the following media types according to therequest header; the media type will be conveyed by theresponse header.Url to resource String Unexpected error Error

    This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

  • Array of items found within the current criteria Unexpected error This API call produces the following media types according to therequest header; the media type will be conveyed by theresponse header.Array of items found within the current criteriaUnexpected error Error

    — ID of the service to update This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

  • If successfull the key result will be ‘true’ Unexpected error This API call produces the following media types according to therequest header; the media type will be conveyed by theresponse header.If successfull the key result will be ‘true’ Response Unexpected error Error

    — ID of the service to update This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

  • If successfull the key result will be ‘true’ Unexpected error This API call produces the following media types according to therequest header; the media type will be conveyed by theresponse header.If successfull the key result will be ‘true’ Response Unexpected error Error

Designed to help retailers achieve 30% more sales using geolocation to find and connect with new customers around their local stores.

@Orkiv: #eCommerce site #failing..This #api ensures success #java #python #golang #go #js #nodejs…

Orkiv tutorials > Inventory > REST API

Back

Endpoint paths

get /all/

delete /categories/

post /categories/

put /categories/

post /item/add/

post /item/addbulk/

delete /item/

get /item/

delete /item-media/

post /item-media/

put /item/

post /items/count/

post /items/

post /orders/

post /orders/services/

post /query/

delete /services/

get /services/

get /services/open/

post /services/

put /services/

delete /variation/

get /variation/

post /variation/

put /variation/

delete /write/

post /write/

Data models

Category

Error

EventRequest

InventoryGroup

Item

ItemRequest

Order

OrderRequest

Response

Service

ServiceRequest

Variation

&copy 2016 Orkiv LLC

InventoryAPI

Orkiv Inventory API client

More information: https://www.orkiv.com/inventory/inventory.html

Contact Info: [email protected]

Version: 1.0.0

BasePath:/i/api

All rights reserved

http://apache.org/licenses/LICENSE-2.0.html

Access

APIKey KeyParamName:APIKey KeyInQuery:false KeyInHeader:true

APIKey KeyParamName:accountid KeyInQuery:false KeyInHeader:true

Methods

[ Jump to Models ] Table of Contents

get /all/

delete /categories/

post /categories/

put /categories/

post /item/add/

post /item/addbulk/

delete /item/

get /item/

delete /item-media/

post /item-media/

put /item/

post /items/count/

post /items/

post /orders/

post /orders/services/

post /query/

delete /services/

get /services/

get /services/open/

post /services/

put /services/

delete /variation/

get /variation/

post /variation/

put /variation/

delete /write/

post /write/

Up get /all/

(allGet)

Return type

array[InventoryGroup]

Example data

Content-Type: application/json

[ { “name” : “aeiou”, “items” : [ { “quantity” : “aeiou”, “ordprice” : 1.3579000000000001069366817318950779736042022705078125, “price” : “aeiou”, “variations” : [ { “priceChange” : 1.3579000000000001069366817318950779736042022705078125, “name” : “aeiou”, “id” : “aeiou” } ], “buy” : “aeiou”, “name” : “aeiou”, “id” : “aeiou”, “media” : [ “aeiou” ], “category” : “aeiou”, “desc” : “aeiou” } ] } ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header. application/json

Responses

200

Array of Inventory groups within the current account 0

Unexpected error Error

Up delete /categories/

(categoriesDelete)

Query parameters

id (required)

Query Parameter — Id of category to remove

Return type

Response

Example data

Content-Type: application/json

{ “approved” : 1.3579000000000001069366817318950779736042022705078125 }

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header. application/json

Responses

200

If successfull the key result will be ‘true’ Response 0

Unexpected error Error

Up post /categories/

(categoriesPost)

Request body

query (optional)

Body Parameter — Category to query against system

Return type

array[Category]

Example data

Content-Type: application/json

[ { “parent” : “aeiou”, “name” : “aeiou”, “id” : “aeiou” } ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header. application/json

Responses

200

Array of categories within the current account 0

Unexpected error Error

Up put /categories/

(categoriesPut)

If no ID is specified a new category will be created!

Request body

category (required)

Body Parameter — New category information.

Query parameters

id (required)

Query Parameter — category id to update.

Return type

Category

Example data

Content-Type: application/json

{ “parent” : “aeiou”, “name” : “aeiou”, “id” : “aeiou” }

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header. application/json

Responses

200

Created category Category 0

Unexpected error Error

Up post /item/add/

(itemAddPost)

Request body

item (required)

Body Parameter — Item to create.

Return type

Item

Example data

Content-Type: application/json

{ “quantity” : “aeiou”, “ordprice” : 1.3579000000000001069366817318950779736042022705078125, “price” : “aeiou”, “variations” : [ { “priceChange” : 1.3579000000000001069366817318950779736042022705078125, “name” : “aeiou”, “id” : “aeiou” } ], “buy” : “aeiou”, “name” : “aeiou”, “id” : “aeiou”, “media” : [ “aeiou” ], “category” : “aeiou”, “desc” : “aeiou” }

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header. application/json

Responses

200

Created item. Item 0

Unexpected error Error

Up post /item/addbulk/

(itemAddbulkPost)

Request body

items (required)

Body Parameter — Items to create.

Return type

Response

Example data

Content-Type: application/json

{ “approved” : 1.3579000000000001069366817318950779736042022705078125 }

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header. application/json

Responses

200

If successfull the key result will be ‘true’ Response 0

Unexpected error Error

Up delete /item/

(itemDelete)

Query parameters

id (required)

Query Parameter — item id to remove

Return type

Response

Example data

Content-Type: application/json

{ “approved” : 1.3579000000000001069366817318950779736042022705078125 }

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header. application/json

Responses

200

If successfull the key result will be ‘true’ Response 0

Unexpected error Error

Up get /item/

(itemGet)

Query parameters

id (required)

Query Parameter — Item ID to open.

Return type

Item

Example data

Content-Type: application/json

{ “quantity” : “aeiou”, “ordprice” : 1.3579000000000001069366817318950779736042022705078125, “price” : “aeiou”, “variations” : [ { “priceChange” : 1.3579000000000001069366817318950779736042022705078125, “name” : “aeiou”, “id” : “aeiou” } ], “buy” : “aeiou”, “name” : “aeiou”, “id” : “aeiou”, “media” : [ “aeiou” ], “category” : “aeiou”, “desc” : “aeiou” }

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header. application/json

Responses

200

Item. Item 0

Unexpected error Error

Up delete /item-media/

(itemMediaDelete)

Query parameters

imageurl (required)

Query Parameter — URL of image to remove

Return type

Response

Example data

Content-Type: application/json

{ “approved” : 1.3579000000000001069366817318950779736042022705078125 }

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header. application/json

Responses

200

If successfull the key result will be ‘true’ Response 0

Unexpected error Error

Up post /item-media/

(itemMediaPost)

This endpoint is currently in testing.

Consumes

This API call consumes the following media types via the Content-Type request header: multipart/form-data

application/x-www-form-urlencoded

Query parameters

id (required)

Query Parameter — Valid item id to bind image to.

Form parameters

image (required)

Form Parameter — Image.

Return type

String

Example data

Content-Type: application/json

“aeiou”

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header. application/json

Responses

200

Url to resource String 0

Unexpected error Error

Up put /item/

(itemPut)

Request body

item (required)

Body Parameter — New item information.

Query parameters

id (required)

Query Parameter — item id to update.

Return type

Response

Example data

Content-Type: application/json

{ “approved” : 1.3579000000000001069366817318950779736042022705078125 }

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header. application/json

Responses

200

If successfull the key result will be ‘true’ Response 0

Unexpected error Error

Up post /items/count/

(itemsCountPost)

Request body

query (optional)

Body Parameter — Item to query against system.

Query parameters

minprice (optional)

Query Parameter — Min price of items to find format: integer

maxprice (optional)

Query Parameter — Max price of items to find format: integer

Return type

BigDecimal

Example data

Content-Type: application/json

1.3579000000000001069366817318950779736042022705078125

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header. application/json

Responses

200

Counts the total number of items that match the supplied criteria. BigDecimal 0

Unexpected error Error

Up post /items/

(itemsPost)

Request body

query (optional)

Body Parameter — Item to query against system.

Query parameters

minprice (optional)

Query Parameter — Min price of items to find format: integer

maxprice (optional)

Query Parameter — Max price of items to find format: integer

Return type

array[Item]

Example data

Content-Type: application/json

[ { “quantity” : “aeiou”, “ordprice” : 1.3579000000000001069366817318950779736042022705078125, “price” : “aeiou”, “variations” : [ { “priceChange” : 1.3579000000000001069366817318950779736042022705078125, “name” : “aeiou”, “id” : “aeiou” } ], “buy” : “aeiou”, “name” : “aeiou”, “id” : “aeiou”, “media” : [ “aeiou” ], “category” : “aeiou”, “desc” : “aeiou” } ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header. application/json

Responses

200

Array of items within the current account 0

Unexpected error Error

Up post /orders/

(ordersPost)

Request body

query (optional)

Body Parameter — Order to query against item invoices.

Return type

array[Order]

Example data

Content-Type: application/json

[ { “tax_amount” : 1.3579000000000001069366817318950779736042022705078125, “info_first” : “aeiou”, “info_last” : “aeiou”, “shipset” : true, “itemIDs” : [ “aeiou” ], “amount_total” : 1.3579000000000001069366817318950779736042022705078125, “info_scty” : “aeiou”, “info_zip” : “aeiou”, “shipping_amount” : 1.3579000000000001069366817318950779736042022705078125, “info_adr1” : “aeiou”, “info_adr2” : “aeiou”, “info_sadr2” : “aeiou”, “phone” : “aeiou”, “info_sadr1” : “aeiou”, “info_szip” : “aeiou”, “sstate” : “aeiou”, “info_cty” : “aeiou”, “info_email” : “aeiou”, “state” : “aeiou”, “order_id” : “aeiou” } ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header. application/json

Responses

200

Array of found orders within the current account 0

Unexpected error Error

Up post /orders/services/

(ordersServicesPost)

Request body

query (optional)

Body Parameter — Order to query against service invoices.

Return type

array[Order]

Example data

Content-Type: application/json

[ { “tax_amount” : 1.3579000000000001069366817318950779736042022705078125, “info_first” : “aeiou”, “info_last” : “aeiou”, “shipset” : true, “itemIDs” : [ “aeiou” ], “amount_total” : 1.3579000000000001069366817318950779736042022705078125, “info_scty” : “aeiou”, “info_zip” : “aeiou”, “shipping_amount” : 1.3579000000000001069366817318950779736042022705078125, “info_adr1” : “aeiou”, “info_adr2” : “aeiou”, “info_sadr2” : “aeiou”, “phone” : “aeiou”, “info_sadr1” : “aeiou”, “info_szip” : “aeiou”, “sstate” : “aeiou”, “info_cty” : “aeiou”, “info_email” : “aeiou”, “state” : “aeiou”, “order_id” : “aeiou” } ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header. application/json

Responses

200

Array of found service orders within the current account 0

Unexpected error Error

Up post /query/

(queryPost)

Request body

query (optional)

Body Parameter — Custom parameters to query against system.

Query parameters

page (optional)

Query Parameter — Current page index. format: integer

categoryid (optional)

Query Parameter — Get items under specified category id.

sort (optional)

Query Parameter — Comma delimited Sort string. ie ; +ordprice. Please use number based fields only

search (optional)

Query Parameter — Performs a regex pattern match against the items within your account

minprice (optional)

Query Parameter — Min price in hundreds (cents). format: integer

maxprice (optional)

Query Parameter — Max price in hundreds (cents). format: integer

Return type

array[Item]

Example data

Content-Type: application/json

[ { “quantity” : “aeiou”, “ordprice” : 1.3579000000000001069366817318950779736042022705078125, “price” : “aeiou”, “variations” : [ { “priceChange” : 1.3579000000000001069366817318950779736042022705078125, “name” : “aeiou”, “id” : “aeiou” } ], “buy” : “aeiou”, “name” : “aeiou”, “id” : “aeiou”, “media” : [ “aeiou” ], “category” : “aeiou”, “desc” : “aeiou” } ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header. application/json

Responses

200

Array of items found within the current criteria 0

Unexpected error Error

Up delete /services/

(servicesDelete)

Query parameters

id (required)

Query Parameter — ID of the service to update

Return type

Response

Example data

Content-Type: application/json

{ “approved” : 1.3579000000000001069366817318950779736042022705078125 }

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header. application/json

Responses

200

If successfull the key result will be ‘true’ Response 0

Unexpected error Error

Up get /services/

(servicesGet)

Return type

array[Service]

Example data

Content-Type: application/json

[ { “recurpric” : “aeiou”, “price” : “aeiou”, “name” : “aeiou”, “event” : { “postbody” : “aeiou”, “serviceid” : “aeiou”, “url” : “aeiou” }, “desc” : “aeiou” } ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header. application/json

Responses

200

Array of services within the current account 0

Unexpected error Error

Up get /services/open/

(servicesOpenGet)

Query parameters

id (required)

Query Parameter — ID of service to open

Return type

Service

Example data

Content-Type: application/json

{ “recurpric” : “aeiou”, “price” : “aeiou”, “name” : “aeiou”, “event” : { “postbody” : “aeiou”, “serviceid” : “aeiou”, “url” : “aeiou” }, “desc” : “aeiou” }

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header. application/json

Responses

200

Service of specified ID Service 0

Unexpected error Error

Up post /services/

(servicesPost)

Request body

Service (required)

Body Parameter — Service to create.

Return type

Service

Example data

Content-Type: application/json

{ “recurpric” : “aeiou”, “price” : “aeiou”, “name” : “aeiou”, “event” : { “postbody” : “aeiou”, “serviceid” : “aeiou”, “url” : “aeiou” }, “desc” : “aeiou” }

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header. application/json

Responses

200

Created service. Service 0

Unexpected error Error

Up put /services/

(servicesPut)

Request body

Service (required)

Body Parameter — New service data to set.

Query parameters

id (required)

Query Parameter — ID of the service to update

Return type

Response

Example data

Content-Type: application/json

{ “approved” : 1.3579000000000001069366817318950779736042022705078125 }

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header. application/json

Responses

200

If successfull the key result will be ‘true’ Response 0

Unexpected error Error

Up delete /variation/

(variationDelete)

Query parameters

id (required)

Query Parameter — variation id to remove

Return type

Response

Example data

Content-Type: application/json

{ “approved” : 1.3579000000000001069366817318950779736042022705078125 }

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header. application/json

Responses

200

If successfull the key result will be ‘true’ Response 0

Unexpected error Error

Up get /variation/

(variationGet)

Query parameters

id (required)

Query Parameter — Variation ID to open.

Return type

Variation

Example data

Content-Type: application/json

{ “priceChange” : 1.3579000000000001069366817318950779736042022705078125, “name” : “aeiou”, “id” : “aeiou” }

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header. application/json

Responses

200

Variation. Variation 0

Unexpected error Error

Up post /variation/

(variationPost)

Request body

item (required)

Body Parameter — Variation information.

Query parameters

id (required)

Query Parameter — Valid item id to bind variation to.

Return type

Response

Example data

Content-Type: application/json

{ “approved” : 1.3579000000000001069366817318950779736042022705078125 }

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header. application/json

Responses

200

If successfull the key result will be ‘true’ Response 0

Unexpected error Error

Up put /variation/

(variationPut)

Request body

item (required)

Body Parameter — New variation information.

Query parameters

id (required)

Query Parameter — variation id to update.

Return type

Response

Example data

Content-Type: application/json

{ “approved” : 1.3579000000000001069366817318950779736042022705078125 }

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header. application/json

Responses

200

If successfull the key result will be ‘true’ Response 0

Unexpected error Error

Up delete /write/

(writeDelete)

Query parameters

id (optional)

Query Parameter — Will delete event attached to this serviceid

Return type

Response

Example data

Content-Type: application/json

{ “approved” : 1.3579000000000001069366817318950779736042022705078125 }

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header. application/json

Responses

200

If successfull the key result will be ‘true’ Response 0

Unexpected error Error

Up post /write/

(writePost)

Will ovveride the current event of the specified service.

Request body

EventRequest (required)

Body Parameter — Event to upload

Return type

Response

Example data

Content-Type: application/json

{ “approved” : 1.3579000000000001069366817318950779736042022705078125 }

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header. application/json

Responses

200

If successfull the key result will be ‘true’ Response 0

Unexpected error Error

Up

Models

[ Jump to Methods ] Table of Contents

Category

Error

EventRequest

InventoryGroup

Item

ItemRequest

Order

OrderRequest

Response

Service

ServiceRequest

Variation

Category Up

name (optional)

String Name of category

id (optional)

String ID of category

parent (optional)

String ID of parent element. Top level categories are set to root.

Error Up

Error (optional)

String Error message

EventRequest Up

url (optional)

String URL for the server to request on successful subscription to specified service

serviceid (optional)

String ServiceID to bind event to.

postbody (optional)

String Valid JSON of Key-value parameters to post to url

InventoryGroup Up

name (optional)

String name of category group

items (optional)

array[Item]

Item Up

id (optional)

String ID of item

category (optional)

String Category ID of item

desc (optional)

String Rich text description of item

name (optional)

String Name of item

ordprice (optional)

BigDecimal Integer value of price format: integer

price (optional)

String String value of price

variations (optional)

array[Variation]

quantity (optional)

String Inventory quantity

media (optional)

array[String] Array of item media

buy (optional)

String Link to checkout page of item

tags (optional)

array[String] Item keywords

ItemRequest Up

id (optional)

String ID of item

category (optional)

String Category ID of item

desc (optional)

String Rich text description of item

name (optional)

String Name of item

ordprice (optional)

BigDecimal Integer value of price format: integer

price (optional)

String String value of price

quantity (optional)

String Inventory quantity

Order Up

order_id (optional)

String Order ID

info_email (optional)

String Customer email

info_first (optional)

String Customer first name

info_last (optional)

String Customer last name

phone (optional)

String Customer phone number

shipset (optional)

Boolean Customer billing address matches shipping address

info_adr1 (optional)

String Customer billing address line ‘1’

info_adr2 (optional)

String Customer billing address line ‘2’

info_cty (optional)

String Customer billing city

info_zip (optional)

String Customer billing zip code

state (optional)

String Customer billing state

info_sadr1 (optional)

String Customer shipping address line ‘1’

info_sadr2 (optional)

String Customer shipping address line ‘2’

info_scty (optional)

String Customer shipping city

info_szip (optional)

String Customer shipping zip code

sstate (optional)

String Customer shipping state

tax_amount (optional)

Float Tax amount in hundreds. Must divide by ‘100’ for USD value format: float

shipping_amount (optional)

Float Shipping total in USD format: float

amount_total (optional)

Float Checkout total in USD format: float

itemIDs (optional)

array[String] Array of items purchased at checkout

OrderRequest Up

order_id (optional)

String Order ID

info_email (optional)

String Customer email

info_first (optional)

String Customer first name

info_last (optional)

String Customer last name

phone (optional)

String Customer phone number

shipset (optional)

Boolean Customer billing address matches shipping address

info_adr1 (optional)

String Customer billing address line ‘1’

info_adr2 (optional)

String Customer billing address line ‘2’

info_cty (optional)

String Customer billing city

info_zip (optional)

String Customer billing zip code

state (optional)

String Customer billing state

info_sadr1 (optional)

String Customer shipping address line ‘1’

info_sadr2 (optional)

String Customer shipping address line ‘2’

info_scty (optional)

String Customer shipping city

info_szip (optional)

String Customer shipping zip code

sstate (optional)

String Customer shipping state

tax_amount (optional)

Float Tax amount in hundreds. Must divide by ‘100’ for USD value format: float

shipping_amount (optional)

Float Shipping total in USD format: float

amount_total (optional)

Float Checkout total in USD format: float

Response Up

approved (optional)

BigDecimal Timestamp of API request was processed format: integer

Service Up

name (optional)

String Name of service

desc (optional)

String Richtext description of item

price (optional)

String Upfront cost of service in hundreds

event (optional)

EventRequest

recurpric (optional)

String Recurring monthly cost of subscription

ServiceRequest Up

name (optional)

String Name of service

desc (optional)

String Richtext description of item

price (optional)

String Upfront cost of service in hundreds

recurpric (optional)

String Recurring monthly cost of subscription

Variation Up

name (optional)

String Variation name

priceChange (optional)

BigDecimal New price to set if variation is set (in hundreds) format: integer

id (optional)

String System ID of variation

Orkiv tutorials > Inventory > REST API

You might also like More from author

Comments are closed, but trackbacks and pingbacks are open.