mos-execution-apis v0.0.0

MOS Execution APIs

Browser and node module for making API requests against MOS Execution APIs.

Please note: This module uses Popsicle to make API requests. Promises must be supported or polyfilled on all target environments.

Installation

npm install mos-execution-apis --save
bower install mos-execution-apis --save

Usage

Node

var MosExecutionApis = require('mos-execution-apis');

var client = new MosExecutionApis();

Browsers

<script src="mos-execution-apis/index.js">

<script>
  var client = new window.MosExecutionApis();
</script>

Options

You can set options when you initialize a client or at any time with the options property. You may also override options for a single request by passing an object as the second argument of any request method. For example:

var client = new MosExecutionApis({ ... });

client.options = { ... };

client.resource('/').get(null, {
  baseUri: 'http://example.com',
  headers: {
    'Content-Type': 'application/json'
  }
});

Base URI

You can override the base URI by setting the baseUri property, or initializing a client with a base URI. For example:

new MosExecutionApis({
  baseUri: 'https://example.com'
});

Base URI Parameters

If the base URI has parameters inline, you can set them by updating the baseUriParameters property. For example:

client.options.baseUriParameters.version = 'v1';

Resources

All methods return a HTTP request instance of Popsicle, which allows the use of promises (and streaming in node).

resources.ping

Ping the system.

var resource = client.resources.ping;

GET

Ping the MOS system to check availability and build details.

resource.get().then(function (res) { ... });

resources.thing

Create a thing.

var resource = client.resources.thing;

POST

Create a new serialized production unit on the given Process.

If no Process Flow, Flow version, or Flow Step are given, the default configuration is used for the given part number (and option codes, if applicable).

BODY PARAMETERS

Input parameters are passed in the raw post body as JSON fields.

resource.post().then(function (res) { ... });

Body

application/json

resources.thing.thingname(thingname)

• thingname string

Get details for a thing.

var resource = client.resources.thing.thingname(thingname);

GET

Get details for the given thing.

You can search for existing things using the endpoints below:

• /thing/search - search for things with a search term
• /thing/step/{stepname} - get all things in a step
• /part/{partnumber}/things - get things by part number

resource.get().then(function (res) { ... });

resources.thing.search

Search for things.

var resource = client.resources.thing.search;

GET

Search for things using a search term.

QUERY PARAMETERS

Query parameters are passed as a query string in the URL (e.g., /search?term=battery).

resource.get().then(function (res) { ... });

resources.thing.sequencedwipparents

Retrieves the sequenced WIP parents

var resource = client.resources.thing.sequencedwipparents;

GET

Retrieves the sequenced WIP parents.

QUERY PARAMETERS

Query parameters are passed as a query string in the URL (e.g. /sequencedwipparents?parent=1MN2:1065600-00-B&child=1FS1:1103547-00-A&optiongroups=DRIVE_MODE).

resource.get().then(function (res) { ... });

resources.thing.sequencedconsumedchildren

Retrieves the sequenced consumed children

var resource = client.resources.thing.sequencedconsumedchildren;

GET

Retrieves the sequenced Consumed Children.

QUERY PARAMETERS

Query parameters are passed as a query string in the URL (e.g. /sequencedconsumedchildren?parent=1MN2:1065600-00-B&child=1FS1:1103547-00-A&optiongroups=DRIVE_MODE).

resource.get().then(function (res) { ... });

resources.thing.sequencedwipchildren

Retrieves the sequenced WIP children

var resource = client.resources.thing.sequencedwipchildren;

GET

Retrieves the sequenced WIP Children.

QUERY PARAMETERS

Query parameters are passed as a query string in the URL (e.g. /sequencedwipchildren?parent=1MN2:1065600-00-B&child=1FS1:1103547-00-A&optiongroups=DRIVE_MODE).

resource.get().then(function (res) { ... });

resources.thing.partoptiontask

Get tasks by part number and option codes.

var resource = client.resources.thing.partoptiontask;

GET

Fetch the applicable tasks configured for the given part number and option-code rules (if applicable). This API endpoint returns tasks that are defined outside of a Process - instead, they are defined within a Task Collection.

Once you get a task, you can start it and complete it with the endpoints /thing/{thingname}/starttask and /thing/{thingname}/completetask, respectively.

QUERY PARAMETERS

Query parameters are passed as a query string in the URL (e.g., /tasks?processname=BMX).

resource.get().then(function (res) { ... });

resources.thing.step.stepname(stepname)

• stepname string

Get all things at a step.

var resource = client.resources.thing.step.stepname(stepname);

GET

Returns all things at the given Step.

QUERY PARAMETERS

Query parameters are passed as a query string in the URL (e.g., ?slim=true&partnumber=foo).

resource.get().then(function (res) { ... });

resources.thing.thingoptioncode

Bulk updates option codes for things.

var resource = client.resources.thing.thingoptioncode;

PUT

Updates one or more option codes for one or more things.

resource.put().then(function (res) { ... });

Body

application/json

resources.process.processname(processname).work

Get or start available work for a process.

var resource = client.resources.process.processname(processname).work;

GET

Gets available work for this process - i.e., check to see which products need to be made next. This is "card job" oriented - the response returns a list of card jobs that are available for work. Each card job is for a particular part number and available quantity.

The returned card jobs should be ordered by the required in-process time or manually adjusted priority. Automated equipment can safely pick the first card job in the array if only one can be processed.

If the part to be made is a kit part, the element "kitparts" in the response will detail the component parts and quantities that go into making each kit.

URL PARAMETERS

Start work: To start work on one of the returned card jobs, you can call to endpoint POST /process/{processname}/work to accept work and generate new production things.

resource.get().then(function (res) { ... });

POST

Start work on a process for a given card job and part number. You can start work on one or many things with this request using the quantity field. This call will create new production things and respond with a list of new thing names on which to work. This will also move that card quantity of work from "available" to "inprocess" in the given card job.

Getting available work: You can fetch available card job work for a process with the GET /process/{processname}/work.

Finishing work: Work for a thing is finished when the PUT /thing/{thingname}/finishthing is called at the end of its production, which moves it into MMS inventory.

BODY PARAMETERS

Input parameters are passed in the raw post body as JSON fields.

resource.post().then(function (res) { ... });

Body

application/json

resources.part.partnumber(partnumber).things

Get things by part number.

var resource = client.resources.part.partnumber(partnumber).things;

GET

Get a list of things in MOS by part number. This list must be limited to a specific date/time range given by the query parameters listed below. The thing list can be filtered further with optional query parameters.

To find which part numbers are made on a particular process, you can use the GET /process/{id}/part endpoint.

QUERY PARAMETERS

Query parameters are passed as a query string in the URL (e.g., /things?state=WIP).

resource.get().then(function (res) { ... });

Query Parameters

resource.get({ ... });

• search string

with valid searchable fields: createdfrom, createdto, state

resources.nonconformance

Create a nonconformance for a thing.

var resource = client.resources.nonconformance;

POST

Create a nonconformance for a given thing (production unit) on a specified Step. If no Step is given, the current Step is assigned.

BODY PARAMETERS

Input parameters are passed in the raw post body as JSON fields.

resource.post().then(function (res) { ... });

Body

application/json

resources.nonconformance.ncname(ncname)

• ncname string

Fetch/modify an existing nonconformance.

var resource = client.resources.nonconformance.ncname(ncname);

GET

Get the nonconformance details for the specified NC.

resource.get().then(function (res) { ... });

PUT

Update the given nonconformance, i.e., to add or edit an NC action.

BODY PARAMETERS

Input parameters are passed in the raw post body as JSON fields.

resource.put().then(function (res) { ... });

Body

application/json

resources.nonconformance.search

Search for nonconformances.

var resource = client.resources.nonconformance.search;

GET

Search for nonconformances for a given thing, using the query parameters below to filter results.

QUERY PARAMETERS

Query parameters are passed as a query string in the URL (e.g., /search?thingname=TFR1709300000G&state=OPEN).

resource.get().then(function (res) { ... });

Query Parameters

resource.get({ ... });

• search string

with valid searchable fields: thingname, ncstate, stepstate and stepname

resources.picklist

Get manual pick items for a route.

var resource = client.resources.picklist;

GET

Returns manual pick items for a route and actor. Items are auto-accepted by this request and any CardJobs and Cards are set to InProcess/PickScheduled.

If "max to pick" is set for the route step:

• Only that many items will be returned by the call
• Items will be assigned to the actor so that work can be allocated to different operators

QUERY PARAMETERS

Query parameters are passed as a query string in the URL.

resource.get().then(function (res) { ... });

resources.picklist.ship

Indicate manual picking is completed for a route.

var resource = client.resources.picklist.ship;

POST

For manual pick items, indicates the operator has finished picking for this route and is in transit; returns the shipped pick items. Any accepted pick items that were not picked are returned to Released status.

BODY PARAMETERS

Input parameters are passed in the raw post body as JSON fields.

resource.post().then(function (res) { ... });

Body

application/json

resources.picklist.delivery

Get manual items to be delivered for a route.

var resource = client.resources.picklist.delivery;

GET

Return manual pick items for a route and actor that are In Transit.

QUERY PARAMETERS

Query parameters are passed as a query string in the URL.

resource.get().then(function (res) { ... });

resources.picklist.deliverforpallet.containertag.containertag(containertag)

• containertag string

Gets all the child pickitems for the pallet container.

var resource = client.resources.picklist.deliverforpallet.containertag.containertag(containertag);

GET

Returns manual child pick items for a pallet container having routestep deliverfrompallet.

QUERY PARAMETERS

Query parameters are passed as a query string in the URL.

resource.get().then(function (res) { ... });

resources.pickitem.pickitemid(pickitemid)

• pickitemid string

Get information about a pickitem/set its status.

var resource = client.resources.pickitem.pickitemid(pickitemid);

GET

Return information about an existing pick item by ID.

Pick item response entity details:

resource.get().then(function (res) { ... });

POST

Update the status of an existing pick item.

The post body indicates which status to which the pick item should be set and includes additional information needed for that status.

Problem Reasons

The following reasons are valid strings in the reason field:

• PartMissing - when the part could not be found
• ContainerDamaged - when the container specified was damaged
• NotReachable - the container could not physically be picked
• WrongRevision - (needs definition)

BODY PARAMETERS

Input parameters are passed in the raw post body as JSON fields.

resource.post().then(function (res) { ... });

Body

application/json

resources.pickitem.sequence

delivers a sequenced pick item or items

var resource = client.resources.pickitem.sequence;

PUT

delivers sequenced pick items for the following scenarios: 1) Container with more than one serial --> Fascia 2) Container with one serial --> IP 3) No container --> Battery pack

resource.put().then(function (res) { ... });

Body

application/json

resources.pickitem.bycontainerorstack.containertag(containertag)

• containertag string

Update pick item status by container or stack.

var resource = client.resources.pickitem.bycontainerorstack.containertag(containertag);

POST

Update the status of an existing pick item by container tag.

The post body indicates which status to which the pick item should be set and includes additional information needed for that status.

Problem Reasons

The following reasons are valid strings in the reason field:

• PartMissing - when the part could not be found
• ContainerDamaged - when the container specified was damaged
• NotReachable - the container could not physically be picked
• WrongRevision - (needs definition)

BODY PARAMETERS

Input parameters are passed in the raw post body as JSON fields.

resource.post().then(function (res) { ... });

Body

application/json

resources.mrb.scrap

Scrap thing. If the location name is sent as a query parameter (?locationname=XXYYX) then a loop will be created if not found for the configured MRB location.

var resource = client.resources.mrb.scrap;

POST

Scrap can be done either by card ID, thing name, or container tag. To scrap, at least one (card ID, thing name, container tag) should be provided with a nonconformance object.

BODY PARAMETERS

Input parameters are passed in the raw post body as JSON fields.

resource.post().then(function (res) { ... });

Body

application/json

resources.loop.consume

Consume material from a replenishment loop location.

var resource = client.resources.loop.consume;

POST

Consume the given inventory material from a "replenishment loop" location. This endpoint allows users to incrementally consume material, based on the given quantity. Another option is to consume an entire replenishment "card" (e.g., a container) using POST /loop/consume if the resolution of incremental consumption is not needed.

This consumption drives material replenishment to that location, since MOS uses "pull-based" material replenishment. This API endpoint is meant to be used by automated equipment to enable automated material consumption during production.

Defining a card location: Typical use would provide one of the following sets of inputs (described below) to uniquely define the card from which material is being consumed.

• partnumber and locationname
• containertag (e.g., bar code on a container)
• loopid

Technical Detail: This transaction decrements the inventory quantity from the oldest on-hand card available in the loop. That card is also marked so that isconsumptioncard=true. The system will have only one card marked as isconsumptioncard at any point in time. Once the on-hand card quantity goes to zero, that card will be released for replenishment. If the replenishment process requires more than one card to be grouped (Jobsize) then the card will wait in Begin cycle until the jobsize is reached. If the card is a temporary card or end-of-life card, that card will be destroyed, and a replenishment signal will not be sent to the source.

BODY PARAMETERS

Input parameters are passed in the raw post body as JSON fields.

resource.post().then(function (res) { ... });

Body

application/json

resources.loop.consumecard

Consume an entire card from a replenishment loop location.

var resource = client.resources.loop.consumecard;

POST

Consume an entire replenishment "card" from a "replenishment loop" location. This is a way to consume an entire container, as opposed to incrementally tracking consumption via POST /loop/consume.

This consumption drives material replenishment to that location, since MOS uses "pull-based" material replenishment. This API endpoint is meant to be used by automated equipment to enable automated material consumption of containers during production.

BODY PARAMETERS

Input parameters are passed in the raw post body as JSON fields.

resource.post().then(function (res) { ... });

Body

application/json

resources.loop.consumepallet

Consumes an entire pallet with child containers or stacks

var resource = client.resources.loop.consumepallet;

POST

Consume an entire pallet that has child container(s) or stack(s). This is a way to consume all the stacks at once, as opposed to incrementally tracking stack consumption via POST /loop/consume.

BODY PARAMETERS

Input parameters are passed in the raw post body as JSON fields.

resource.post().then(function (res) { ... });

Body

application/json

resources.loop.eject

Eject a card onto empty, residual, or MRB route

var resource = client.resources.loop.eject;

POST

Ejects a container onto one of three routes defined for the loop. The empty route is used if the identified container is attached to an empty card. The residual route is used if the card still has material in it. The MRB route is used if the card had MRB reported against it. The card must be in On Hand status.

The container can be identified through any of these parameters

• partnumber and locationname
• loopid
• containertag (e.g. barcode on a container)

If the container tag is not provided, the active consumption card on the loop identified by loop id or partnumber/locationname

BODY PARAMETERS

Input parameters are passed in the raw post body as JSON fields.

resource.post().then(function (res) { ... });

Body

application/json

resources.loop.createlocationro

Create an RO at a specific location

var resource = client.resources.loop.createlocationro;

POST

This API will create a replenishment order (RO) at a given location name. It expects there to be one active loop at that location. If there is more than one (e.g. during part pedigree changes) it will use the first one and expect part pedigree logic to pick the correct part. The RO card is returned.

QUERY PARAMETERS

Query parameters are passed as a query string in the URL.

resource.post().then(function (res) { ... });

Body

application/json

resources.loop.loopid(loopid).createro

Creates one or more RO's for a loop ID

var resource = client.resources.loop.loopid(loopid).createro;

POST

This API will create one or more replenishment orders (RO) in a loop.

BODY PARAMETERS

Body parameters are passed as the POSTed body in the request.

resource.post().then(function (res) { ... });

Body

application/json

resources.loop.locationpartsequence

Returns the sequence of parts to be used at a location

var resource = client.resources.loop.locationpartsequence;

GET

Returns the sequence of part counts required at a location and step. This API requires a thing to be at the step at the location. If there is no thing at that step then error code 1100 will be returned. The client should call back after a wait period to get new information. Note that prior information is valid until the next takt time as it only changes as each thing enters/exits the step.

The data returned include the current thing name at the location and an array of (PartNumber, LengthOfRun, Quantity) items indicating in order the parts that will be needed at that location for the upcoming manufacturing sequence. The LengthOfRun is the number of things (e.g. vehicles) for that part. Quantity is the number of parts per thing (vehicle) which comes from the BOM.

QUERY PARAMETERS

Query parameters are passed in the URL

resource.get().then(function (res) { ... });

resources.loop.setquantity

Sets the absolute quantity on a virtual kanban loop

var resource = client.resources.loop.setquantity;

POST

Sets the absolute quantity of material in a loop, typically through measuring. The loop must be defined as a Virtual Kanban. The typical sequence of events will be:

• Start with a permanent on hand card with quantity 100
• Measurement taken, call SetQuantity with 90; card quantity is adjusted
• Measurement taken, call SetQuantity with 80; card quantity is adjusted
• Virtual loop order at quantity is 85, so the system will
  • Convert the existing card to temporary
  • Create a new permanent card that is Released to the supplier
• Measurement taken, call SetQuantity with 70; temp card quantity is adjusted
• Measurement taken, call SetQuantity with 60; temp card quantity is adjusted
• Material arrives, call SetQuantity with 155
  • Released permanent card is put On Hand with quantity 155
  • Temporary card (was QOH 60) is deleted

BODY PARAMETERS

Input parameters are passed in the raw post body as JSON fields.

resource.post().then(function (res) { ... });

Body

application/json

resources.loop.adjustcounter

Adjusts a countdown loop counter up or down

var resource = client.resources.loop.adjustcounter;

POST

Adjusts the counter on a loop with type CountDown. Can be used to adjust the counter UP or DOWN. If adjusting down, MOS will reduce the counter to zero and place a replishment order as many times as necessary to use up the entire delta provided.

Example:

• Loop card quantity is 15
• Current counter is at 6
• AdjustCounter is called with -25

MOS will reduce the counter from 6 to zero and place one order. The counter gets reset to 15 (card quantity). Then since there is still -19 to apply, the counter is reduced from 15 to zero and another order is placed. The counter will end up at 11 (15 card quantity - 4 remaining from the delta argument.)

The loop can be identified by either

• partnumber and locationname
• loopid

If the identified loop is not of type CountDown, an error is returned.

BODY PARAMETERS

Input parameters are passed in the raw post body as JSON fields.

resource.post().then(function (res) { ... });

Body

application/json

resources.loop.counter

Gets the current counter for a countdown loop

var resource = client.resources.loop.counter;

GET

Returns the counter on a loop with type CountDown.

The loop can be identified by either

• partnumber and locationname
• loopid

If the identified loop is not of type CountDown, an error is returned.

URL PARAMETERS

URL parameters are passed in url in key=value&key2=value2 format

resource.get().then(function (res) { ... });

resources.loop.countdowncounters

Gets a filtered list of countdown counters

var resource = client.resources.loop.countdowncounters;

GET

Returns countdown loop counters filtered by part, location, and site. The parameters are combined together as one filter, e.g. if partnumber and site are provided, only loops with both that part and site will be included.

URL PARAMETERS

URL parameters are passed in url in key=value&key2=value2 format

resource.get().then(function (res) { ... });

resources.loop.id(ID).recallablecard

Return all recallable cards for the specified loop.

var resource = client.resources.loop.id(ID).recallablecard;

GET

Return all recallable cards for a loop.

QUERY PARAMETERS

Query parameters are passed as a query string in the URL.

Fields in a card response include:

resource.get().then(function (res) { ... });

resources.loop.inventoryreport.bytrailer

Returns on-hand inventory report by trailer

var resource = client.resources.loop.inventoryreport.bytrailer;

GET

Returns on-hand inventory report by trailer

QUERY PARAMETERS

Query parameters are passed as a query string in the URL.

Fields in the response include:

resource.get().then(function (res) { ... });

resources.loop.ryginventoryreport

Returns RYG inventory report by loop, part, location, or trailer

var resource = client.resources.loop.ryginventoryreport;

GET

Return RYG inventory report by location.

QUERY PARAMETERS

Query parameters are passed as a query string in the URL.

Fields in the response include:

resource.get().then(function (res) { ... });

resources.loop.materialexpirationreport

Returns material expiration report by site, part, warehouse, zone, or cardid

var resource = client.resources.loop.materialexpirationreport;

GET

Return material expiration inventory report for parts with shelf life by site/location/part.

QUERY PARAMETERS

Query parameters are passed as a query string in the URL.

resource.get().then(function (res) { ... });

resources.actor

Get all actors

var resource = client.resources.actor;

GET

Get all actors provides details on actors, their role, and optionally permisions.

QUERY PARAMETERS

Query parameters are passed as a query string in the URL (e.g. /actor?includepermission=true&type="actor,equipment").

resource.get().then(function (res) { ... });

resources.actor.actor(actor).picklist

Get released actor pick items or Post to autoaccept released items.

var resource = client.resources.actor.actor(actor).picklist;

GET

Return an array of pick items for the actor, typically a piece of equipment like ASRS or AGV. By default, returns pick items with status Released. This represents the work that the actor is being asked to do.

QUERY PARAMETERS

Query parameters are passed as a query string in the URL. NOTE: only one may be used.

resource.get().then(function (res) { ... });

POST

Auto accept and return an array of pick items for the actor, typically a piece of equipment like ASRS or AGV. Examine items in Released state for the actor in "time required" order and auto-accept them, up to "max to pick" if that field is non-zero on the route step for each pick item, otherwise all of them.

Items auto-accepted through this API will have a bubble ID assigned to them that represents the group of items. Some equipment (e.g., Dematic) has a special format for the response that is triggered by settinggroupbybubble=true parameter. Otherwise, the response is an array of pick items.

BODY PARAMETERS

Input parameters are passed in the raw post body as JSON fields.

resource.post().then(function (res) { ... });

Body

application/json

resources.actor.actorid(actorid).rolename(rolename)

• rolename string

Set the role for existing actor by id.

var resource = client.resources.actor.actorid(actorid).rolename(rolename);

PUT

Set an actor's role.

QUERY PARAMETERS

n/a

resource.put().then(function (res) { ... });

Body

application/json

resources.actorpermision.actorid(actorid).permissionshortname(permissionshortname)

• permissionshortname string

Set a permission for existing actor by id.

var resource = client.resources.actorpermision.actorid(actorid).permissionshortname(permissionshortname);

POST

Add a permission to an actor by id using the permisson short name (3 characters maximum)

QUERY PARAMETERS

n/a

resource.post().then(function (res) { ... });

Body

application/json

DELETE

Delete a permission from an actor by id using the permisson short name (3 characters maximum)

QUERY PARAMETERS

n/a

resource.delete().then(function (res) { ... });

Body

application/json

resources.card.id(ID)

• ID string

Get a card by ID.

var resource = client.resources.card.id(ID);

GET

Return basic information about a card.

Fields in a card response include:

resource.get().then(function (res) { ... });

resources.card.split

Split quantity from a single card into other containers by container

var resource = client.resources.card.split;

POST

Splits quantity from an existing on-hand card into multiple containers. The containers cannot be attached to cards, they must be empty.

BODY PARAMETERS

The body of split card by container request has the source container and an array of container/quantity objects for the destination containers.

resource.post().then(function (res) { ... });

Body

application/json

resources.card.mrb

Report MRB.

var resource = client.resources.card.mrb;

POST

MRB can be reported either by card ID, thingname, or container tag. To create MRB, at least one (cardid, thingname, containertag) should be provided with array of nonconformance object.

BODY PARAMETERS

Input parameters are passed in the raw post body as JSON fields.

resource.post().then(function (res) { ... });

Body

application/json

resources.card.lot.bycontainer.containertag(containertag)

• containertag string

Get a single lot by position in a card using container tag or add a lot.

var resource = client.resources.card.lot.bycontainer.containertag(containertag);

GET

Return information about a single lot in a card by position.

Lots with no position are ignored in the calculation.

Consider the following lot information:

In this case there is a gap (empty spots on a tray, for example).

A call to get lot by position 4 would return L1. A call with position 18 would return a 404 error since there is no lot at that position.

The parameter hightolow allows calculation of lot from the end of the lot positions to the beginning. This is useful when loading lots into a container from the bottom to top and then picking from the top of the container. In the example above, the last position is 28 which would correspond to position 1 when this flag is true. For this example, the following positions would give these results:

QUERY PARAMETERS

Query parameters are passed as a query string in the URL.

resource.get().then(function (res) { ... });

POST

Add a new lot to a card.

BODY PARAMETERS

Input parameters are passed in the raw post body as JSON fields.

resource.post().then(function (res) { ... });

Body

application/json

DELETE

Remove a lot from a card by the lot code and optional position. If position is not given, all instances of that lot code will be removed.

QUERY PARAMETERS

Query parameters are passed as a query string in the URL.

resource.delete().then(function (res) { ... });

Body

application/json

resources.card.lots.bycontainertag.containertag(containertag)

• containertag string

Get all of a card's lots using container tag.

var resource = client.resources.card.lots.bycontainertag.containertag(containertag);

GET

Return information about the lots in a card. Lot information is stored in the CardThing table with type "LOT." Typically, a lot is of the same part as the card, but it is possible with kitted parts to have lots of different parts. It is also possible to have multiple lots of the same part in a card.

Lot position is an optional field, but can be used to track where this lot starts and ends (using quantity) on a tray or a magazine. Position is 1-relative.

Fields in a card lot include:

resource.get().then(function (res) { ... });

resources.card.onhandforparts

Return the onhand quantities for all loops associated with a list of part IDs.

var resource = client.resources.card.onhandforparts;

POST

Accept an array of part IDs as input, and return an array containing all the loops for that part, along with the on-hand quantity for each loop.

resource.post().then(function (res) { ... });

Body

application/json

resources.card.forloop.id(ID)

• ID string

Get all the cards for the loop id

var resource = client.resources.card.forloop.id(ID);

GET

Get Cards for loop returns all the cards associated with that loop. If returnemptyarray is not given and there no cards found for that loop it will return error 404, but if given and set to true it will return 200 with empty cardlist

QUERY PARAMETERS

Query parameters are passed as a query string in the URL.

| retur