Accepts a Transfer

Fetch API (v3.0: 3.22.2.4)

For differences between versions, see Changelog.

Download OpenAPI description

api.json

api.yaml

Overview

API Support Group api@yellowdogsoftware.com

Servers

Mock server

https://developer.yellowdogsoftware.com/_mock/fetch/api/

Accounting

Accounting Export Reports that can be consumed by 3rd Party accounting systems

Operations

AttachedFiles

Items, Recipes, and Purchasing Documents are able to have files of record or images associated to them.

Operations

CountSheets

A dynamic list of Items that are designed to aide with physical inventories. Countsheets are based on a static list of items, Levels, and Flags

Operations

Currency

Operations used to manage currency conversion for the database. These are used when multiple currencies are used in a database.

Operations

Dimensions

Attributes that are available for assigning to an Item. Attributes can be like a Size or Color.

Operations

Flags

Flags allow you to indicate storage locations, making ordering and physical inventories easier.

Operations

Inventory

Item Inventory OnHand information.

Operations

Invoices

A Purchasing document

Operations

ItemAliases

UPCs or additional SKUs to for an Item.

Operations

Items

Product information that is tracked in Yellow Dog Inventory.

Operations

ManualAdjusts

A Manual Adjustment will affect an Item's OnHand.

Operations

MetaInfo

Database specific configuration information

Operations

PurchaseOrders

A Purchasing document

Operations

Receipts

A Receiving document

Operations

Recipes

Collections of items and recipes, with quantities, that are used to create other items.

Operations

Requests

A requisition for purchasing or transfering an item.

Operations

Sessions

Associate a count to an Item, these sessions can be used for Purchasing Documents or Physical Inventories.

Operations

Stores

Business Entities or locations of a single business entity that need to maintain their own inventory records.

Operations

ThirdPartyCodes

Additional configuration options that control item, store or level behavior with third-party integrations

Operations

ThirdParty

Third Party Mappings with Yellow Dog Inventory

Operations

ThirdPartySessions

Records that increment or decrement inventory based on customer interactions with a store

Operations

Transactions

Records that increment or decrement inventory based on customer interactions with a store

Operations

Transfers

A record of movement of Items from one Store to another.

Operations

Accepts a Transfer

Request

Accepting a Transfer is an indication that the Store on the recieving side of the Item movement has been recieved at the quantities indicated by the accepting quantity.

Path

idstring(uuid)required

CommDoc Id of Transfer

Body

Any alterations to the accepting Transfer

linesArray of objects or null(Api.Models.Dto.CommDocLineUpdate)

doCommitboolean

commitboolean

idstring(uuid)

thirdPartyIDstring or null

docNumberstring or null

referencestring or null

descriptionstring or null

instructionsstring or null

totalAmountnumber(double)

createdstring(date-time)

lastUpdatedstring(date-time)

vendorstring or null

createdByUserstring or null

notesstring or null

storestring or null

curl -i -X PATCH \
  'https://developer.yellowdogsoftware.com/_mock/fetch/api/api/v3/transfers/{id}/Accept' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
    "lines": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "quantity": 0.1,
        "notes": "string"
      }
    ],
    "doCommit": true,
    "commit": true,
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "thirdPartyID": "string",
    "docNumber": "string",
    "reference": "string",
    "description": "string",
    "instructions": "string",
    "totalAmount": 0.1,
    "created": "2019-08-24T14:15:22Z",
    "lastUpdated": "2019-08-24T14:15:22Z",
    "vendor": "string",
    "createdByUser": "string",
    "notes": "string",
    "store": "string"
  }'

Responses

User does not have sufficient access for this endpoint: Access required Purchasing > Transfers > TransferEditor > Accept.

Response

No response example

Issues a Transfer

Request

Issuing a Transfer is an indication that the Store on the sending side of the Item movement has been sent to the Store on the Recieving side.

Path

idstring(uuid)required

CommDoc Id of Transfer

curl -i -X PATCH \
  'https://developer.yellowdogsoftware.com/_mock/fetch/api/api/v3/transfers/{id}/Issue' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

User does not have sufficient access for this endpoint: Access required Purchasing > Transfers > TransferEditor > Issue.

Response

No response example

Creates a Transfer

Request

Body

Object Representing a Transfer to be created

linesArray of objects or null(Api.Models.Dto.CommDocLineCreate)non-empty

commitboolean

thirdPartyIDstring or null

referencestring or null

descriptionstring or null

instructionsstring or null

totalAmountnumber(double)

notesstring or null

fromStorestring(uuid)

toStorestring(uuid)

duestring or null(date-time)

curl -i -X POST \
  https://developer.yellowdogsoftware.com/_mock/fetch/api/api/v3/transfers \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
    "lines": [
      {
        "itemID": "f1f85a48-b9b1-447d-a06c-c1acf57ed3a8",
        "quantity": 0.1
      }
    ],
    "commit": true,
    "thirdPartyID": "string",
    "reference": "string",
    "description": "string",
    "instructions": "string",
    "totalAmount": 0.1,
    "notes": "string",
    "fromStore": "922ea2e6-43bc-423b-beb5-f95edf9c79d5",
    "toStore": "a56faa3b-2099-4b8f-93cc-055c6ad82860",
    "due": "2019-08-24T14:15:22Z"
  }'

Responses

Body

storestring or null

store2string or null

committedstring or null(date-time)

committedByUserstring or null

committed2string or null(date-time)

committed2ByUserstring or null

duestring or null(date-time)

commitboolean

idstring(uuid)

thirdPartyIDstring or null

docNumberstring or null

referencestring or null

descriptionstring or null

instructionsstring or null

totalAmountnumber(double)

linesArray of objects or null(Api.Models.Dto.CommdocLine)

createdstring(date-time)

lastUpdatedstring(date-time)

vendorstring or null

createdByUserstring or null

notesstring or null

Response

No response example

Add Additional lines to an existing Transfer that has not been committed

Request

Path

idstring(uuid)required

CommDoc Id of Transfer

Body

new lines to be added to Transfer

Array [

itemIDstring(uuid)

quantitynumber(double)

]

curl -i -X POST \
  'https://developer.yellowdogsoftware.com/_mock/fetch/api/api/v3/transfers/{id}/lines' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json-patch+json' \
  -d '[
    {
      "itemID": "f1f85a48-b9b1-447d-a06c-c1acf57ed3a8",
      "quantity": 0.1
    }
  ]'

Responses

Body

Array [

idstring(uuid)

thirdPartyLineIDstring or null

lineNumberinteger(int32)

vendorPricenumber or null(double)

quantitynumber or null(double)

notesstring or null

backLinkLineIDstring or null

itemstring or null

]

Response

No response example

Updates existing lines of a given Transfer

Request

Path

idstring(uuid)required

CommDoc Id of Transfer

Body

Any alterations to a Transfer

Array [

idstring or null(uuid)

quantitynumber(double)

notesstring or null

]

curl -i -X PATCH \
  'https://developer.yellowdogsoftware.com/_mock/fetch/api/api/v3/transfers/{id}/lines' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json-patch+json' \
  -d '[
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "quantity": 0.1,
      "notes": "string"
    }
  ]'

Responses

Body

Array [

idstring(uuid)

thirdPartyLineIDstring or null

lineNumberinteger(int32)

vendorPricenumber or null(double)

quantitynumber or null(double)

notesstring or null

backLinkLineIDstring or null

itemstring or null

]

Response

No response example

Delete existing lines from a Transfer

Request

Path

idstring(uuid)required

CommDoc Id of Transfer

Body

unique identifiers of lines to be deleted

Array [

string(uuid)

]

curl -i -X DELETE \
  'https://developer.yellowdogsoftware.com/_mock/fetch/api/api/v3/transfers/{id}/lines' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json-patch+json' \
  -d '[
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ]'

Responses

Body

Array [

idstring(uuid)

thirdPartyLineIDstring or null

lineNumberinteger(int32)

vendorPricenumber or null(double)

quantitynumber or null(double)

notesstring or null

backLinkLineIDstring or null

itemstring or null

]

Response

No response example

Creates a Transfer

Request

Body

Object Representing a Transfer to be created

linesArray of objects or null(Api.Models.Dto.CommDocLineCreate)non-empty

commitboolean

thirdPartyIDstring or null

referencestring or null

descriptionstring or null

instructionsstring or null

totalAmountnumber(double)

notesstring or null

fromStorestring(uuid)

toStorestring(uuid)

duestring or null(date-time)

curl -i -X POST \
  'https://developer.yellowdogsoftware.com/_mock/fetch/api/api/v3/transfers/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
    "lines": [
      {
        "itemID": "f1f85a48-b9b1-447d-a06c-c1acf57ed3a8",
        "quantity": 0.1
      }
    ],
    "commit": true,
    "thirdPartyID": "string",
    "reference": "string",
    "description": "string",
    "instructions": "string",
    "totalAmount": 0.1,
    "notes": "string",
    "fromStore": "922ea2e6-43bc-423b-beb5-f95edf9c79d5",
    "toStore": "a56faa3b-2099-4b8f-93cc-055c6ad82860",
    "due": "2019-08-24T14:15:22Z"
  }'

Responses

Body

storestring or null

store2string or null

committedstring or null(date-time)

committedByUserstring or null

committed2string or null(date-time)

committed2ByUserstring or null

duestring or null(date-time)

commitboolean

idstring(uuid)

thirdPartyIDstring or null

docNumberstring or null

referencestring or null

descriptionstring or null

instructionsstring or null

totalAmountnumber(double)

linesArray of objects or null(Api.Models.Dto.CommdocLine)

createdstring(date-time)

lastUpdatedstring(date-time)

vendorstring or null

createdByUserstring or null

notesstring or null

Response

No response example

Vendors

Vendors, Suppliers, Distributors, or Manufacturors that provide Items into the Inventory.

Operations

Fetch API (v3.0: 3.22.2.4)

Accounting

AttachedFiles

CountSheets

Currency

Dimensions

Flags

Inventory

Invoices

ItemAliases

Items

ManualAdjusts

MetaInfo

PurchaseOrders

Receipts

Recipes

Requests

Sessions

Stores

ThirdPartyCodes

ThirdParty

ThirdPartySessions

Transactions

Transfers

Accepts a Transfer

RequestExpand all

Responses

Was this page helpful?

Issues a Transfer

Request

Responses

Was this page helpful?

Creates a Transfer

RequestExpand all

Responses

Was this page helpful?

Add Additional lines to an existing Transfer that has not been committed

Request

Responses

Was this page helpful?

Updates existing lines of a given Transfer

Request

Responses

Was this page helpful?

Delete existing lines from a Transfer

Request

Responses

Was this page helpful?

Creates a Transfer

RequestExpand all

Responses

Was this page helpful?

Vendors

Request

Request

Request