JumpStock XML API

Version 1.5

Overview

JumpStock API Version 1.5 has the following API functions:

Authentication

JumpStock Authentication & URL

Requests

JumpStock Provision Request
JumpStock Adjust Inventory Request
JumpStock Transfer Inventory Request
Jumpstock Create/Edit Item Request
JumpStock Send Cart Request
JumpStock Receive Order Request
JumpStock Get Purchase Orders Request
JumpStock Confirm Purchase Orders Request

Appendix A

Error codes

Element Definitions

Inventory Item
Item
Location
Kit
Lot
Order
Order Item
Vendor

Authentication

You must have an adminstrator account before you can access the API at the following URL:
https://www.myjumpstock.com/requestHandlerJumpStock

Requests

JumpStock Provision

This request returns locations, vendors, items, inventory levels, open orders, etc. based on the given user’s permissions. Administrative users receive all data without restriction. Timestamps are used to prevent duplicate transmission of data that has already been sent to the client.

Request

<?xml version='1.0' encoding='UTF-8' standalone='yes' ?>
<request type="jumpstock-provision" version="2">
	<user>
		<username>USER</username>
		<password>PASS</password>
	</user>
	<provision update="true">
		<last-updated>1969-12-31 18:00:00</last-updated>
	</provision>
</request>

Req

Element

Type

Description

1

/request

   

1

→@type

Code

jumpstock-provision: code corresponding to data provision request

1

→@version

int

current API version

1

→/user

   

1

→→/username

String

JumpStock system username

1

→→/password

String

JumpStock system password

1

→/provision

   

1

→@update

Bool

Use true to get details, false will only return summary information

1

→→/last-updated

Date

Last update time: use “1970-01-01 00:00:00” for initial provision, and date/time in response for further provision updates. In order to receive every update use initial provision time or @server-date from response to get updates after initial provision

Response

<?xml version='1.0' encoding='UTF-8' standalone='yes' ?>
<response>
	<success>full</success>
	<errors />
	<provision update="true" trxn="full" server-date="2012-11-19 16:22:14">
		<locations size="1">
			<location id="ffff23be1bcb555ffff000bffffeeee">
				<name>Storage Room</name>
				<translation-code>x34</translation-code>
			</location>
		</locations>
		<vendors size="2">
			<vendor id="ebceeeeeeeedfff00aaaaaaaae4bfd">
				<name>Big Products Ltd.</name>
			</vendor>
			<vendor id="ebffffffff7e510000000eeeeeeee2">
				<name>Acme Products</name>
			</vendor>
		</vendors>
		<items size="3">
			<item id="ebffffffffed0d0000000bbbbbbbbc">
				<sku>ABCDE</sku>
				<name>Office Product</name>
				<description>TONER CARTRIDGE</description>
				<default-uom>Pack</default-uom>
				<image-url>http://imgur.com/ABCDE.jpg</image-url>
				<translation-codes>
					<translation-code>
						<code>xyza</code>
						<type>TCT_JUMPCODE</type>
					</translation-code>
				</translation-codes>
			</item>
			<item id="ebc23ffffffff10000000beeeeeeeb">
				<sku>FGHIJ</sku>
				<name />
				<description>Retractable Gel Pens, Medium Point</description>
				<default-uom>Box</default-uom>
				<image-url />
				<translation-codes>
					<translation-code>
						<code>xyzb</code>
						<type>TCT_JUMPCODE</type>
					</translation-code>
				</translation-codes>
			</item>
			<item id="ebc23fffaaaaa10000000beeeeeeeb">
				<sku>KLMNO</sku>
				<name />
				<description>Retractable Gel Pens, Fine Point</description>
				<default-uom>Box</default-uom>
				<image-url />
				<translation-codes>
					<translation-code>
						<code>xyzc</code>
						<type>TCT_JUMPCODE</type>
					</translation-code>
				</translation-codes>
			</item>
		</items>
		<lots size="2">
			<lot id="ebc23baccd0d1c0000000bc35b2d8c">
				<name>u22</name>
				<expiration>2013-02-04 00:00:00</expiration>
				<translation-code>01</translation-code>
			</lot>
			<lot id="ebc23bacf097780000000bdea06a18">
				<name>u23</name>
				<expiration>2013-02-04 00:00:00</expiration>
				<translation-code>02</translation-code>
			</lot>
		</lots>
		<inventory-items size="2”>
			<inventory-item id="effffffff549ce0000000beeeeeee0">
				<location id="ffff23be1bcb555ffff000bffffeeee" />
				<vendor id="ebceeeeeeeedfff00aaaaaaaae4bfd" />
				<item id="ebffffffffed0d0000000bbbbbbbbc" />
				<current-inventory>1</current-inventory>
				<usage-uom>Box</usage-uom>
				<reorder-uom>Unknown</reorder-uom>
				<reorder-price>0.0</reorder-price>
			<custom-number>4568214</custom-number>
			<par-level>500</par-level>
			<reorder-type>static</reorder-type>
			<bin></bin>
			<lots />
			</inventory-item>
			<inventory-item id="eeeeeeeee549ce0000000baaaaaaa0">
				<location id="ffff23be1bcb555ffff000bffffeeee" />
				<vendor id="ebceeeeeeeedfff00aaaaaaaae4bfd" />
				<item id="ebc23fffaaaaa10000000beeeeeeeb" />
				<current-inventory>17</current-inventory>
				<usage-uom>Each</usage-uom>
				<reorder-uom>Unknown</reorder-uom>
				<reorder-price>0.0</reorder-price>
			<custom-number>123654</custom-number>
			<par-level>10</par-level>
			<reorder-type>static</reorder-type>
			<bin>2BA75</bin>
				<lots>
					<lot id="ebc23baccd0d1c0000000bc35b2d8c">
						<current-inventory>17</current-inventory>
					</lot>
				</lots>
			</inventory-item>
		</inventory-items>
		<deleted-inventory-items>
			<deleted-id>00006360e103e50000000b3b79692e</deleted-id>
		</deleted-inventory-items>
		<deleted-lots>
			<deleted-id>8192</deleted-id>
		</deleted-lots>
		<orders size="1">
			<order id="ebc23b563595ed0000000b9b3dfa01" receivable="true" >
				<location id="0000015f8d36e8db7b7f2e8dd0c68b" />
				<po-number>120823-20S6</po-number>
				<translation-code>ORD1WTA</translation-code>
				<order-date>2012-08-23 21:18:36</order-date>
				<order-items>
					<order-item>
						<inventory-item id="000001a3c39cac7302ad694199d6e8" />
						<order-uom>Hundred</order-uom>
						<quantity>11</quantity>
						<received-quantity>0</received-quantity>
					</order-item>
				</order-items>
			</order>
		</orders>
		<available-uoms>
			<available-uom>EA-Each</available-uom>
		</available-uoms>
	</provision>
</response>





Req

Element

Type

Description

1

/response

 

Root element for response

1

→/success

Code

code: full, partial, none

  • full: No errors occurred during process
  • partial: At least one non-critical error occurred and no fatal errors, check the /errors tag
  • none: A fatal error has occurred; check the /errors tag

1

→/errors

   

0+

→→/error

 

Single instance of an error

1

→→→@index

int

Zero based index of error

1

→→→/time

Date

Server time that error occurred

1

→→→/context

xml

Set of XML element to value pairs representing contextual information that the server may have about the state of an error.

1

→→→→/extended-information

 

Detailed information about the error

1

→→→/code

Code

JumpStock internal error code associated with type of error - see appendix A

1

→/provision

   

1

→@update

Bool

Value of @update received in request

1

→@trxn

Code

  • full: contains all active data
  • update: contains updates only

1

→@server-date

Date

Server time of update - use this in next provision request in order to get only changes made after this update

1

→→/locations

   

1

→→@size

int

1 based - number of locations user has access to

0+

→→→/location

 

Physical place where inventory is being tracked

1

→→→@id

GUID

Unique identifier for Location

1

→→→→/name

String

User display for Location

1

→→→→/translation-code

String

Unique short code for location barcode

1

→→→→/default

Bool

Requesting user’s default location for ordering. Only one location per user can be default.

1

→→/vendors

   

1

→→@size

int

1 based - number of vendors user has access to

0+

→→→/vendor

 

Supplier for items. Fulfills orders.

1

→→→@id

GUID

Unique identifier for Vendor

1

→→→→/name

String

User display for Vendor

1

→→→→/custom

Bool

  • True if custom vendor - user maintained vendor
  • False if direct vendor - JumpTech maintained vendor

1

→→/items

   

1

→→@size

int

1 based - number of items user has access to

0+

→→→/item

   

1

→→→@id

GUID

Unique identifier for Item

1

→→→→/sku

String

Item SKU

1

→→→→/name

String

User display field for item

1

→→→→/description

String

User description field for item

1

→→→→/default-uom

String

Default unit of measure for item

1

→→→→/image-url

URL

URL of image for item

1

→→→→/translation-codes

   

1+

→→→→→/translation-code

   

1

→→→→→→/code

String

System identifier for item; see type for rules.

1

→→→→→→/type

Code

  • TCT_JUMPCODE - Globally unique code for @code barcode
  • TCT_IMS_GENERIC - Customer unique code for @code barcode

1

→→/kits

   

1

→→@size

int

1 based - number of kits user has access to

0+

→→→/kit

 

Group of items at a specific location that are consumed together

1

→→→@id

GUID

Unique identifier for Kit

1

→→→→/kit-location

   

1

→→→→@id

GUID

Unique identifier for @location associated with Kit

1

→→→→/kit-name

String

User display for Kit

1

→→/lots

   

1

→→@size

int

1 based - number of Lots user has access to

0+

→→→/lot

 

Individual number defined by manufacturer indicating which batch the item belongs to for quality tracking. Can be very important for items which expire.

1

→→→@id

GUID

Unique identifier for Lot

1

→→→→/name

String

User display for Lot

1

→→→→/expiration

Date

Date of expiration for Lot

1

→→→→/translation-code

String

Item unique short code for Lot barcode

1

→→/inventory-items

   

1

→→@size

int

1 based - number of inventory items user has access to

0+

→→→/inventory-item

 

Item at a location supplied by a vendor

1

→→→@id

GUID

Unique identifier for inventory item

1

→→→→/location

   

1

→→→→@id

GUID

Unique identifier for @location where the item is in inventory

1

→→→→/vendor

   

1

→→→→@id

GUID

Unique identifier for @vendor which supplies the item

1

→→→→/item

   

1

→→→→@id

GUID

Unique identifier for @item which this inventory item maps to

1

→→→→/current-inventory

int

Quantity on hand at usage unit of measure

1

→→→→/usage-uom

String

Usage Unit of Measure at which inventory item is consumed

1

→→→→/reorder-uom

String

Unit of Measure at which orders are placed for inventory item

1

→→→→/reorder-price

Double

Price per reorder Unit of Measure

1

→→→→/custom-number

String

User defined custom value for inventory item

1

→→→→/par-level

int

Minimum level to keep on hand. When @current-inventory drops below @par-level an order is automatically placed for this inventory item.

1

→→→→/reorder-type

String

reorder type set in JumpStock system

1

→→→→/bin

String

Bin # associated with item

1

→→→→/lots

   

0+

→→→→→/lot

   

1

→→→→→@id

GUID

Unique identifier for Lot

1

→→→→→→/current-inventory

int

Quantity of inventory in this lot at usage unit of measure

1

→→/deleted-inventory-items

 

List of Inventory Items that have been deleted since last provision update

0+

→→→/deleted-id

GUID

Unique identifier for inventory item that has been deleted

1

→→/deleted-lots

 

List of lots that have been deleted since last provision update

0+

→→→/deleted-id

GUID

Unique identifier for lot that has been deleted

1

→→/orders

   

1

→→@size

int

1 based - number of current orders user has access to in JumpStock system

0+

→→→/order

 

Set of items at a location placed to a vendor

1

→→→@id

GUID

Unique identifier for order

1

→→→@receivable

Bool

True if the order is receivable in JumpStock system

1

→→→→/location

   

1

→→→→@id

GUID

Unique identifier for @location order is placed for

1

→→→→/po-number

String

User display Purchase Order Number assigned to order

1

→→→→/translation-code

String

Global unique short code for order barcode

1

→→→→/order-date

Date

Date order was placed

1

→→→→/order-items

   

1+

→→→→→/order-item

 

List of @inventory-item on this order

1

→→→→→→/inventory-item

   

1

→→→→→→@id

GUID

Unique identifier for @inventory-item

1

→→→→→→/order-uom

String

Unit of measure for this inventory item

1

→→→→→→/quantity

int

Number of units ordered @order-uom

1

→→→→→→/received-quantity

int

Number of units already received into inventory @order-uom

1

→→/available-uoms

   

1+

→→→/available-uom

code

Code for the different Units of Measure supported. Formatted as ‘EA-Each’

JumpStock Adjust Inventory

This request allows the client to adjust inventory in three different operations:

  • dec - decrements the specified inventory by the current-inventory tag
    • Ex: putting 10 in the current-inventory tag will remove 10 from the quantity on hand
  • inc - increments the specified inventory by the current-inventory tag
    • Ex: putting 10 in the current-inventory tag will add 10 to the quantity on hand
  • set - sets the specified inventory by the current-inventory tag
    • Ex: putting 10 in the current-inventory tag will set the quantity on hand to 10

Request

<?xml version='1.0' encoding='UTF-8' standalone='yes' ?>
<request type="jumpstock-adjust-inventory" operation="dec" version="2">
	<user>
		<username>USER</username>
		<password>PASS</password>
	</user>
	<inventory-items>
		<inventory-item id="ebc23be8f646800000000b9b077e9f">
			<location id="ebc23be8e2dbb70000000bc02cca6c" />
			<vendor id="ebc23be8e632a90000000bc4c9eef2" />
			<item id="ebc23be8f6465b0000000b52a08339" />
			<consumer-code />
			<current-inventory>1</current-inventory>
			<usage-uom>Each</usage-uom>
			<reorder-uom>Bundle</reorder-uom>
			<reorder-price>16.0</reorder-price>
			<lots />
		</inventory-item>
	</inventory-items>
</request>





Req

Element

Type

Description

1

/request

   

1

→@type

Code

jumpstock-adjust-inventory: code corresponding to adjust inventory request

1

→@operation

Code

dec, inc, or set - corresponds to which inventory operation should be done on inventory

1

→@version

int

current API version

1

→/user

   

1

→→/username

String

JumpStock system username

1

→→/password

String

JumpStock system password

1

→/inventory-items

   

1+

→→/inventory-item

   

1

→→@id

GUID

Unique identifier for @inventory-item

1

→→→/location

   

1

→→→@id

GUID

Unique identifier for  @location where this inventory item should be adjusted at

1

→→→/vendor

   

1

→→→@id

GUID

Unique identifier for @vendor which supplies the item

1

→→→/item

   

1

→→→@id

GUID

Unique identifier for @item corresponding to this inventory item

1

→→→/consumer-code

String

Consumer code to be used for reporting inventory adjustments. Leave empty tag if no code included.

1

→→→/current-inventory

int

Number used by each @operation

  • dec will decrement the item the amount in this field
  • inc will increment the item the amount in this field
  • set will set the inventory to the amount in this field. All adjustments are done at usage UOM.

1

→→→/usage-uom

String

Usage Unit of Measure for this inventory item

1

→→→/reorder-uom

String

Reorder Unit of Measure for this inventory item

1

→→→/reorder-price

double

Reorder price for this inventory item at reorder UOM

1

→→→/lots

   

0+

→→→→/lot

   

1

→→→→@id

GUID

Unique identifier for lot. Use “NEW” when creating a new lot. Each instance of lot with id “NEW” will create a new lot

0-1

→→→→→/name

 

User display for lot. Required for new lot. Must be unique per customer.

0-1

→→→→→/expiration

Date

Date of lot expiration. Required for new lot.

1

→→→→→/current-inventory

int

Number used by each @operation

  • dec will decrement the item the amount in this field
  • inc will increment the item the amount in this field
  • set will set the inventory to the amount in this field. All adjustments are done at usage UOM.

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
	<success>full</success>
	<errors />
	<inventory-items>
		<inventory-item id="ebc23be224c92e0000000b2163c0cd">
			<quantity-on-hand>4</quantity-on-hand>
		</inventory-item>
	</inventory-items>
</response>





Req

Element

Type

Description

1

/response

 

Root element for response

1

→/success

Code

code: full, partial, none

  • full: No errors occurred during process
  • partial: At least one non-fatal error occurred, check the /errors tag
  • none: A fatal error has occurred; check the /errors tag

1

→/errors

   

0+

→→/error

 

Single instance of an error

1

→→→@index

int

Zero based index of error

1

→→→/time

Date

Server time that error occurred

1

→→→/context

xml

Set of XML element to value pairs representing contextual information that the server may have about the state of an error.

1

→→→→/extended-information

 

Detailed information about the error

1

→→→/code

Code

JumpStock internal error code associated with type of error

1

→/inventory-items

   

1+

→→/inventory-item

   

1

→→@id

GUID

Unique identifier for this inventory item

0-1

→→→/quantity-on-hand

int

When the item doesn’t have lots, this is inventory for the item after the adjustment has been made.

1

→→→→/lots

   

0+

→→→→→/lot

   

1

→→→→→@id

GUID

Unique identifier for lot

1

→→→→→→/name

String

User display for lot

1

→→→→→→/expiration

Date

Expiration date for lot

1

→→→→→→/current-inventory

int

This is inventory for the lot after the adjustment has been made.

1

→→→→→→/translation-code

String

Item unique short code for Lot barcode

 

JumpStock Transfer Items

This request transfers inventory between inventory items in one location to another.

Request

<?xml version='1.0' encoding='UTF-8' standalone='yes' ?>
<request type="jumpstock-mobile-transfer" version="2">
	<user>
		<username>USER</username>
		<password>PASS</password>
	</user>
	<to-location>ebc23b581be5080000000be30a4377</to-location>
	<copy-par>yes</copy-par>
	<inventory-items is-kit="false">
		<inventory-item is-kit="false" par-id="ebc23b6a5117df0000000b458982bd">
			<adjust-quantity>1</adjust-quantity>
		</inventory-item>
	</inventory-items>
</request>





Req

Element

Type

Description

1

/request

   

1

→@type

Code

jumpstock-mobile-transfer: code corresponding to request for transferring items between locations

1

→@version

int

current API version

1

→/user

   

1

→→/username

String

JumpStock system username

1

→→/password

String

JumpStock system password

1

→/to-location

GUID

ID for the location item is being transferred to

1

→/copy-par

String

YES|NO - if the item doesn’t exist in the to-location this flag will determine if the settings from the existing item will be copied

1

→/inventory-items

   

1

→@is-kit

Boolean

true if the item is a kit otherwise false

1+

→→/inventory-item

   

1

→→@par-id

GUID

Unique identifier for @inventory-item

1

→→→/adjust-quantity

int

Quantity being transferred

 

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<success>full</success>
<errors />
<result>success</result>
</response>





Req

Element

Type

Description

1

/response

 

Root element for response

1

→/success

Code

code: full, partial, none

  • full: No errors occurred during process
  • partial: At least one non-fatal error occurred, check the /errors tag
  • none: A fatal error has occurred; check the /errors tag

1

→/errors

   

0+

→→/error

 

Single instance of an error

1

→→→@index

int

Zero based index of error

1

→→→/time

Date

Server time that error occurred

1

→→→/context

xml

Set of XML element to value pairs representing contextual information that the server may have about the state of an error.

1

→→→→/extended-information

 

Detailed information about the error

1

→→→/code

Code - possible codes defined below

JumpStock internal error code associated with type of error

1

→→/result

   

 

JumpStock Create/Edit Item

This request creates an item in the JumpStock system

Request

<?xml version='1.0' encoding='UTF-8' standalone='yes' ?>
<request type="jumpstock-mobile-inventory-edit" version="2">
	<user>
		<username>USER</username>
		<password>PASS</password>
	</user>
	<inventory-item>
		<par-inventory-id/>
		<product-no>232-12</product-no>
		<location>ebc23b6a50e6c60000000becc98ba2</location>
		<description>1232</description>
		<extended-description>description</extended-description>
		<par-level>0</par-level>
		<price>0.0</price>
		<usage-uom>EA-Each</usage-uom>
		<reorder-uom>EA-Each</reorder-uom>
		<order-type />
		<vendor>ebc23bc764b4310000000b04025817</vendor>
		<pack-count>1</pack-count>
		<addl-order-qty>0</addl-order-qty>
		<upc />
		<auto-order>true</auto-order>
		<custom-product-no />
		<gl-no />
		<bin-no />
		<custom-1 />
		<custom-2 />
		<custom-3 />
		<img-url />
		<alt-scan-codes />
	</inventory-item>
</request>





Req

Element

Type

Description

1

/request

   

1

→@type

Code

jumpstock-mobile-inventory-edit: code corresponding to request for creating or items

1

→@version

int

current API version

1

→/user

   

1

→→/username

String

JumpStock system username

1

→→/password

String

JumpStock system password

1

→/inventory-item

   

1

→→/par-inventory-id

GUID

Inventory Item ID for item being edited/Leave blank for creating new item

1

→→/product-no

String

SKU or product number for item

1

→→/location

GUID

location ID for item

1

→→/description

String

Product description - displays as the ‘Name’ field in JumpStock product

1

→→/extended-description

String

Product extended description

1

→→/par-level

int

Minimum level to keep on hand. When @current-inventory drops below @par-level an order is automatically placed for this inventory item.

1

→→/price

long

Price of item at reorder-UOM

1

→→/usage-uom

Code

Unit of measure at which the item is consumed. Use one of the codes from the available-uoms list in provision.

1

→→/reorder-uom

Code

Unit of measure at which the item is ordered. Use one of the codes from the available-uoms list in provision.

1

→→/order-type

Code

Static|Dynamic|Kanban

1

→→/vendor

GUID

Unique identifier for vendor which supplies this item

1

→→/pack-count

int

Number of items at usage UOM which are contained in one pack at order UOM

1

→→/addl-order-qty

int

Additional quantity to add when an order is triggered

1

→→/upc

String

UPC barcode string for item

1

→→/auto-order

Boolean

true|false

1

→→/custom-product-no

String

Custom Product Number for item

1

→→/gl-no

String

Item GL Accounting code

1

→→/bin-no

String

Bin number for item - required for Kanban order type

1

→→/custom-1

String

Custom 1 Field for item

1

→→/custom-2

String

Custom 2 Field for item

1

→→/custom-3

String

Custom 3 Field for item

1

→→/image-url

String

Image URL for item

1

→→/alt-scan-codes

   

0+

→→→/alt-scan-code

String

Alternate scan codes/barcodes associated with item

 

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<success>full</success>
<errors />
<result>
<inventory-item id="0000592fcb5bc30000000bcbeda258" />
</result>
</response>





Req

Element

Type

Description

1

/response

 

Root element for response

1

→/success

Code

code: full, partial, none

  • full: No errors occurred during process
  • partial: At least one non-fatal error occurred, check the /errors tag
  • none: A fatal error has occurred; check the /errors tag

1

→/errors

   

0+

→→/error

 

Single instance of an error

1

→→→@index

int

Zero based index of error

1

→→→/time

Date

Server time that error occurred

1

→→→/context

xml

Set of XML element to value pairs representing contextual information that the server may have about the state of an error.

1

→→→→/extended-information

 

Detailed information about the error

1

→→→/code

Code - possible codes defined below

JumpStock internal error code associated with type of error

1

→→/result

   

1

→→→/inventory-item

   

1

→→→/@id

GUID

UNique identifier for newly created/edited Inventory Item

 

JumpStock Send Cart

This request places an order in the JumpStock system.

Request

<?xml version="1.0" encoding="UTF-8"?>
<request type="jumpstock-send-cart" version="2">
	<user>
		<username>USER</username>
		<password>PASS</password>
	</user>
	<cart>
		<inventory-items>
			<inventory-item id="ebc23bd1565b640000000ba2b76527">
				<location id="ebc23b842ae6260000000b13acc4d2" />
				<vendor id="0000015f7e0132d9d3481adc9812a5" />
				<item id="000001bc78b3597b521a3203a4e996" />
				<consumer-code />
				<current-inventory>1</current-inventory>
				<usage-uom>Each</usage-uom>
				<reorder-uom>Each</reorder-uom>
				<reorder-price>25.000000</reorder-price>
			</inventory-item>
		</inventory-items>
	</cart>
</request>





Req

Element

Type

Description

1

/request

   

1

→@type

Code

jumpstock-send-cart: code corresponding to request for placing an order

1

→@version

int

current API version

1

→/user

   

1

→→/username

String

JumpStock system username

1

→→/password

String

JumpStock system password

1

→/inventory-items

   

1+

→→/inventory-item

   

1

→→@id

GUID

Unique identifier for @inventory-item

1

→→→/location

   

1

→→→@id

GUID

Unique identifier for @location for this inventory item

1

→→→/vendor

   

1

→→→@id

GUID

Unique identifier for @vendor which supplies this item

1

→→→/item

   

1

→→→@id

GUID

Unique identifier for  @item

1

→→→/consumer-code

String

Optional - Consumer code to be used for reporting ordering. Leave blank when not including a code.

1

→→→/current-inventory

int

Quantity to be ordered @reorder-uom for this inventory item

1

→→→/usage-uom

String

Usage Unit of Measure for this inventory item

1

→→→/reorder-uom

String

Reorder Unit of Measure for this inventory item

1

→→→/reorder-price

double

Reorder price for this inventory item at reorder UOM

 

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
	<success>full</success>
	<errors />	
	<results />
</response>





Req

Element

Type

Description

1

/response

 

Root element for response

1

→/success

Code

code: full, partial, none

  • full: No errors occurred during process
  • partial: At least one non-fatal error occurred, check the /errors tag
  • none: A fatal error has occurred; check the /errors tag

1

→/errors

   

0+

→→/error

 

Single instance of an error

1

→→→@index

int

Zero based index of error

1

→→→/time

Date

Server time that error occurred

1

→→→/context

xml

Set of XML element to value pairs representing contextual information that the server may have about the state of an error.

1

→→→→/extended-information

 

Detailed information about the error

1

→→→/code

Code - possible codes defined below

JumpStock internal error code associated with type of error

1

→→/results

   

 

JumpStock Receive Order

This request receives inventory against an order, updates inventory accordingly and closes the order.

Request

<?xml version="1.0" encoding="UTF-8"?>
<request type="jumpstock-receive-order" version="2">
	<user>
		<username>username</username>
		<password>password</password>
	</user>
	<orders>
		<order id="ebc23b70444b7a0000000b775b3dc1">
			<po-number>120828-20ZJ</po-number>
			<order-date>2012-08-28 22:44:47</order-date>
			<location id="0000015f8d36e8db7b7f2e8dd0c68b" />
			<translation-code>ORD1WYP</translation-code>
			<order-items>
				<order-item>
					<inventory-item id="000001a3c39cac7302ad694199d6e8" />
					<order-uom>Hundred</order-uom>
					<quantity>11</quantity>
					<received-quantity>11</received-quantity>
				</order-item>
				<order-item>
					<inventory-item id="000001a3c39cbb7302ad87fc41fb0c" />
					<order-uom>Each</order-uom>
					<quantity>10</quantity>
					<received-quantity>10</received-quantity>
				</order-item>
			</order-items>
		</order>
	</orders>
</request>





Req

Element

Type

Description

1

/request

   

1

→@type

Code

jumpstock-receive-order: code corresponding to request for receiving an order

1

→@version

int

current API version

1

→/user

   

1

→→/username

String

JumpStock system username

1

→→/password

String

JumpStock system password

1

→/orders

   

1+

→→/order

   

1

→→@id

GUID

Unique identifier for order

1

→→→/po-number

String

User display Purchase Order Number assigned to order

1

→→→/order-date

Date

Date order submitted

1

→→→/location

   

1

→→→@id

GUID

Unique identifier for @location order was placed for

1

→→→/translation-code

String

Unique short code for location barcode

1

→→→/order-items

   

1+

→→→→/order-item

   

1

→→→→→/inventory-item

   

1

→→→→→@id

GUID

Unique identifier for @inventory-item

1

→→→→→/order-uom

String

Unit of measure for inventory item on order

1

→→→→→/quantity

int

Quantity of this inventory item ordered at order unit of measure

1

→→→→→/received-quantity

int

Quantity of this inventory item being received into inventory at order unit of measure

 

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
	<success>full</success>
	<errors />
	<orders>
		<order id="ebc23b70444b7a0000000b775b3dc1">
			<order-items>
				<order-item>
					<order-uom>Hundred</order-uom>
					<received-quantity>11</received-quantity>
					<inventory-item id="000001a3c39cac7302ad694199d6e8">
						<quantity-on-hand>550</quantity-on-hand>
					</inventory-item>
				</order-item>
				<order-item>
					<order-uom>Each</order-uom>
					<received-quantity>10</received-quantity>
					<inventory-item id="000001a3c39cbb7302ad87fc41fb0c">
						<quantity-on-hand>10</quantity-on-hand>
					</inventory-item>
				</order-item>
			</order-items>
			<fully-received>true</fully-received>
		</order>
	</orders>
</response>





Req

Element

Type

Description

1

/response

 

Root element for response

1

→/success

Code

code: full, partial, none

  • full: No errors occurred during process
  • partial: At least one non-fatal error occurred, check the /errors tag
  • none: A fatal error has occurred; check the /errors tag

1

→/errors

   

0+

→→/error

 

Single instance of an error

1

→→→@index

int

Zero based index of error

1

→→→/time

Date

Server time that error occurred

1

→→→/context

xml

Set of XML element to value pairs representing contextual information that the server may have about the state of an error.

1

→→→→/extended-information

 

Detailed information about the error

1

→→→/code

Code

JumpStock internal error code associated with type of error

1

→/orders

   

1+

→→/order

   

1

→→@id

GUID

Unique identifier for order

1

→→→/order-items

   

1+

→→→→/order-item

   

1

→→→→→/order-uom

String

Unit of measure item was ordered at

1

→→→→→/received-qty

int

Total quantity received into inventory on this item

1

→→→→→/inventory-item

   

1

→→→→→@id

GUID

Unique identifier for inventory item

1

→→→→→→/quantity-on-hand

int

Current total quantity on hand for inventory item

1

→→→/fully-received

bool

true if all items have been fully received on this order, otherwise false

 

JumpStock Get Purchase Orders

This request returns all open purchase orders to be received into an accounting system.

Request

<?xml version="1.0" encoding="UTF-8"?>
<request type="get-purchase-orders">
	<client>
		<name>API Connector Name</name>
		<version>0.0.0.0</version>
		<language>en-us</language>
	</client>
	<user>
		<username>username</username>
		<password>password</password>
	</user>
</request>





Req

Element

Type

Description

1

/request

   

1

→@type

Code

get-purchase-orders: code corresponding to request for getting purchase orders in JumpStock system

1

→/client

   

1

→→/name

String

Name of client software or backend interface

1

→→/version

String

Software version of client

1

→→/language

String

Language of client. Only “en-us” supported at this time

1

→/user

   

1

→→/username

String

JumpStock system username

1

→→/password

String

JumpStock system password

 

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
	<status>success</status>
	<results>
		<purchase-orders>
			<order>
				<order-no>090331-XXXX</order-no>
				<po-no />
				<vendor-id />
				<vendor-name>Vendor Name</vendor-name>
				<order-date>03/31/12 10:13:49</order-date>
				<order-items>
					<order-item>
						<item-id>123456</item-id>
						<item-code>1122</item-code>
						<quantity>2</quantity>
						<received-quantity>2</received-quantity>
						<sku>ABCD</sku>
						<description>Coffee Filter</description>
						<unit-of-measure>BX</unit-of-measure>
						<unit-price>0.00</unit-price>
						<notes />
					</order-item>
					<order-item>
						<item-id>789012</item-id>
						<item-code>1122</item-code>
						<quantity>1</quantity>
						<received-quantity>1</received-quantity>
						<sku>FGHI</sku>
						<description>Coffee Grinder</description>
						<unit-of-measure>EA</unit-of-measure>
						<unit-price>0.0</unit-price>
						<notes />
					</order-item>
				</order-items>
				<order-status>SUBMIT OK</order-status>
				<gl-account-code>Abacoa</gl-account-code>
				<last-updated />
			</order>
		</purchase-orders>
	</results>
</response>





Req

Element

Type

Description

1

/response

 

Root element for response

1

→/success

Code

code: full, partial, none

  • full: No errors occurred during process
  • partial: At least one non-fatal error occurred, check the /errors tag
  • none: A fatal error has occurred; check the /errors tag

1

→/results

   

1

→→/purchase-orders

   

0+

→→→/order

   

0-1

→→→→/order-no

String

Unique per customer Order Number. Depending on account setup you will get back @order-no or @po-no.

0-1

→→→→/po-no

String

Unique per customer Purchase Order Number. Depending on account setup you will get back @order-no or @po-no.

1

→→→→/vendor-id

 

Unique identifier for @vendor this order was placed for

1

→→→→/vendor-name

String

Name of @vendor

1

→→→→/order-date

Date

Date Order placed to vendor

1

→→→→/order-items

   

1+

→→→→→/order-item

   

1

→→→→→→/item-id

GUID

Unique identifier for item

1

→→→→→→/item-code

String

Item External Code/General Ledger number used for reporting

1

→→→→→→/quantity

int

Quantity ordered at order unit of measure for this order item

1

→→→→→→/received-quantity

int

Quantity received into inventory at order unit of measure for this order item

1

→→→→→→/sku

String

SKU for item

1

→→→→→→/description

String

Description for item

1

→→→→→→/unit-of-measure

Code

2 Character code for unit of measure item was ordered at

1

→→→→→→/unit-price

double

Price per order unit of measure

1

→→→→→→/notes

String

Notes for this line item

1

→→→→/order-status

Code

SUBMIT OK for all purchase orders

1

→→→→/gl-account-code

String

General Ledger Account Code for location, used for reporting

1

→→→→/last-updated

Date

Time of last update made to order - blank if no updates have been made

 

JumpStock Confirm Purchase Orders

This request closes or voids open purchase orders once an accounting system has received them.

Request

<?xml version="1.0" encoding="UTF-8"?>
<request type="confirm-purchase-orders">
	<user>
		<username>username</username>
		<password>password</password>
	</user>
	<purchase-orders>
		<order>
			<update-accepted>true</update-accepted>
			<order-no>090331-XXXX</order-no>
			<po-no>PO123</po-no>
		</order>
	</purchase-orders>
	<void-pos>
		<order-no>PO126</order-no>
		<order-no>PO127</order-no>
	</void-pos>
</request>





Req

Element

Type

Description

1

/request

   

1

→@type

Code

jumpstock-receive-order: code corresponding to request for receiving an order in JumpStock system

1

→/user

   

1

→→/username

String

JumpStock system username

1

→→/password

String

JumpStock system password

1

→/purchase-orders

   

1+

→→/order

   

1

→→→/update-accepted

bool

True if update accepted

1

→→→/order-no

String

User display Order Number for order

1

→→→/po-no

String

User display Purchase Order Number for order

1

→/void-pos

 

List of orders to be voided

0+

→→/order-no

String

Order Number to be voided

 

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
	<status>success</status>
</response>





Req

Element

Type

Description

1

/response

 

Root element for response

1

→/success

Code

code: full, partial, none

  • full: No errors occurred during process
  • partial: At least one non-fatal error occurred, check the /errors tag
  • none: A fatal error has occurred; check the /errors tag

 

Appendix A

Error Codes:

R0001 - Generic Error

R0002 - Request Unavailable

R0003 - Error parsing request

R0004 - Authentication Failed

R0005 - Unsupported Compression Algorithm

R0006 - Interface Format Unsupported

R0007 - Configuration or license management issue

R0008 - Required element missing or reference not found

 

Element Definitions

Inventory Item

Inventory item is an instance of item for a customer and holds customer specific information about that item in inventory.




inventory-item_id

Key

Unique identifier for inventory item

location_id

Foreign Key

Unique identifier for location where the item is in inventory

vendor_id

Foreign Key

Unique identifier for vendor which supplies the item

item_id

Foreign Key

Unique identifier for item which this inventory item maps to

current-inventory

int

  • jumpstock-provision Request: Quantity on hand at usage unit of measure
  • jumpstock-adjust-inventory Request: Used to set, increment, or decrement inventory based on the value in the current-inventory element.
  • jumpstock-send-cart Request: Used to place an order for the quantity in the current-inventory element.

usage-uom

String

Usage Unit of Measure at which inventory item is consumed

reorder-uom

String

Unit of Measure at which orders are placed for inventory item

reorder-price

Double

Price per reorder Unit of Measure

custom-number

String

User defined custom value for inventory item

par-level

int

Minimum level to keep on hand. When current-inventory drops below par-level an order is automatically placed for this inventory item.

lot_id

Foreign Key

Unique identifier for Lot

current-inventory

int

Quantity of inventory in this lot at usage unit of measure

 

Item

Item tag holds data describing an item.




item_id

Key

Unique identifier for Item

sku

String

Item SKU

name

String

User display field for item

description

String

User description field for item

default-uom

String

Default unit of measure for item

image-url

URL

URL of image for item

translation-code_code

String

System identifier for item; see type for rules.

translation-code_type

Code

  • TCT_JUMPCODE - Globally unique code for code barcode
  • TCT_IMS_GENERIC - Customer unique code for code barcode

 

Kit

Kits are a group of items at a specific location that are consumed together




kit_id

Key

Unique identifier for Kit

kit-location_id

Foreign Key

Unique identifier for location associated with Kit

kit-name

String

User display for Kit

 

Location

Locations are used to define an area where inventory is being tracked.




location_id

Key

Unique identifier for Location

name

String

User display for Location

translation-code

String

Unique short code for location barcode

default

Bool

Requesting user’s default location for ordering. Only one location per user can be default.

 

Lot

Individual number defined by manufacturer indicating which batch the item belongs to for quality tracking. Can be very important for items which expire.




lot_id

Key

Unique identifier for Lot

name

String

User display for Lot

expiration

Date

Date of expiration for Lot

translation-code

String

Item unique short code for Lot barcode

 

Order

Order consists of following fields plus one or more order-item




order_id

Key

Unique identifier for order

order_receivable

Bool

True if the order is receivable in JumpStock system

location_id

Foreign Key

Unique identifier for location order is placed for

po-number

String

User display Purchase Order Number assigned to order

translation-code

String

Global unique short code for order barcode

order-date

Date

Date order was placed

 

Order Item

List of inventory item on an order




order-item_id

Key

Unique identifier for inventory-item

order-uom

String

Unit of measure for this inventory item

quantity

int

Number of units ordered order-uom

received-quantity

int

  • jumpstock-provision Request: Number of units already received into inventory order-uom
  • get-purchase-orders Request: Number of units already received into inventory order-uom
  • jumpstock-receive-order Request: quantity being received into inventory. This amount will be added to the quantity on hand for the corresponding inventory-item

 

Vendor

Vendors supply items and fulfill orders.