Transfers

Fetch API (v3.0: 3.23.1.1)

REST API logo


For differences between versions, see Changelog.

Download OpenAPI description
api.json
api.yaml
Overview
API Support Group api@yellowdogsoftware.com
Languages
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 and Recipes are able to have 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 content

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 content

Gets Transfers

Request

Example use cases

api/v2/transfers?pageNumber=1&pageSize=100&Filter=committed>2024-03-05T06:06:58.529Z&Filter=lastUpdated>2024-03-06&orderBy=committed

will get the first page of transfers where the committed date is later than 2024-03-05T06:06:58.529Z AND the lastUpdated date is later than 2024-03-06T00:00:00Z, ordering by the committed date

/api/v2/transfers?pageNumber=1&pageSize=100&Filter=committed>2024-03-05T06:06:58.529Z&orderBy=committed

will get the first page of transfers where the committed date is later than 2024-03-05T06:06:58.529Z ordering by the committed date.

Query
FilterArray of strings

Filter Options:

  • DocNumber (string: allows for pulling based on a particular document number)
  • Committed (Issued DateTime in v2, DateTimeOffset in v3: See Differences between v2 and v3 in Getting Started Section for more information)
  • Committed2 (Accepted DateTime in v2, DateTimeOffset in v3: See Differences between v2 and v3 in Getting Started Section for more information)
  • LastUpdated(DateTime in v2, DateTimeOffset in v3: See Differences between v2 and v3 in Getting Started Section for more information)
  • Store (GUID: allows for filtering down to only a particular issuingStoreId. This id can be found from the GET /stores endpoint)
  • Store2 (GUID: allows for filtering down to only a particular acceptedStoreId. This id can be found from the GET /stores endpoint)
ExpandArray of strings

Expand Options:

  • Lines
  • Items
OrderByArray of strings

Order By Options:

  • Committed
  • DocNumber
  • LastUpdated
PageNumberinteger(int32)

Page Number for the result set.

This is expected to be an integer value greater than 0. Defaults to 1 when not passed in.

For more information see the Getting Started Section for Pagination.

PageSizeinteger(int32)

Page Size

  • Default page size: 100
  • Max page size: 500

This is expected to be an integer value greater than 0. Defaults to 100 when not passed in.

For more information see the Getting Started Section for Pagination.

curl -i -X GET \
  'https://developer.yellowdogsoftware.com/_mock/fetch/api/api/v3/transfers?Expand=string&Filter=string&OrderBy=string&PageNumber=0&PageSize=0' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/jsonArray [
idstring(uuid)

Yellow Dog's unique ID of the Commdoc; formatted as GUID (example: 433ef432-f63e-4c26-a29f-39d4079d9fc9)

thirdPartyIDstring or null
docNumberstring or null

The document number of the Transfer.

referencestring or null

Reference is used to store a secondary code for the Transfer such the supplier's document number.

descriptionstring or null

This is an arbitrary description of the Transfer.

instructionsstring or null

Instructions can be printed on the document printout.

commitboolean

Indicates whether the Transfer is committed or not.

committedstring or null(date-time)

DateTime when the Transfer was issued in Yellow Dog, in ISO 8601 format.

committed2string or null(date-time)

DateTime when the Transfer was accepted in Yellow Dog, in ISO 8601 format.

notesstring or null

Note is used to store other information about the Transfer.

needBystring(date-time)

DateTime when the Transfer is needed by, in ISO 8601 format

expectedArrivalstring or null(date-time)

DateTime when the arrival of the transfer is expected, in ISO 8601 format

createdstring(date-time)

DateTime when the Transfer was created in Yellow Dog, in ISO 8601 format

lastUpdatedstring(date-time)

DateTime when the Transfer was last updated in Yellow Dog, in ISO 8601 format

storestring or null

Unique ID of the Yellow Dog Store; formatted as GUID (example: 433ef432-f63e-4c26-a29f-39d4079d9fc9) The store that issued the Transfer.

store2string or null

Unique ID of the Yellow Dog Store; formatted as GUID (example: 433ef432-f63e-4c26-a29f-39d4079d9fc9) The store that accepted the Transfer.

createdByUserstring or null

Unique ID of the user who created the Transfer

committedByUserstring or null

Unique ID of the user who issued the Transfer

committed2ByUserstring or null

Unique ID of the user who accepted the Transfer

totalAmountIssuednumber(double)

Total Amount Issued TotalAmountShortage can be calculated by subtracting TotalAmountAccepted from TotalAmountIssued.

totalAmountAcceptednumber(double)

Total Amount Accepted TotalAmountShortage can be calculated by subtracting TotalAmountAccepted from TotalAmountIssued.

statusstring or null

Status of the Transfer.

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

List of Commdoc Lines which belongs to the Transfer.

duestring or null(date-time)Deprecatedread-only

DateTime when the Transfer is needed by, in ISO 8601 format

vendorstring or nullDeprecated

Unique ID of the Yellow Dog Store; formatted as GUID (example: 433ef432-f63e-4c26-a29f-39d4079d9fc9)

]
Response
application/json
[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "thirdPartyID": "string",
    "docNumber": "string",
    "reference": "string",
    "description": "string",
    "instructions": "string",
    "commit": true,
    "committed": "2019-08-24T14:15:22Z",
    "committed2": "2019-08-24T14:15:22Z",
    "notes": "string",
    "needBy": "2019-08-24T14:15:22Z",
    "due": "2019-08-24T14:15:22Z",
    "expectedArrival": "2019-08-24T14:15:22Z",
    "created": "2019-08-24T14:15:22Z",
    "lastUpdated": "2019-08-24T14:15:22Z",
    "vendor": "string",
    "store": "string",
    "store2": "string",
    "createdByUser": "string",
    "committedByUser": "string",
    "committed2ByUser": "string",
    "totalAmountIssued": 0.1,
    "totalAmountAccepted": 0.1,
    "status": "string",
    "lines": [ … ]
  }
]

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

OK

Body
idstring(uuid)

Yellow Dog's unique ID of the Commdoc; formatted as GUID (example: 433ef432-f63e-4c26-a29f-39d4079d9fc9)

thirdPartyIDstring or null
docNumberstring or null

The document number of the Transfer.

referencestring or null

Reference is used to store a secondary code for the Transfer such the supplier's document number.

descriptionstring or null

This is an arbitrary description of the Transfer.

instructionsstring or null

Instructions can be printed on the document printout.

commitboolean

Indicates whether the Transfer is committed or not.

committedstring or null(date-time)

DateTime when the Transfer was issued in Yellow Dog, in ISO 8601 format.

committed2string or null(date-time)

DateTime when the Transfer was accepted in Yellow Dog, in ISO 8601 format.

notesstring or null

Note is used to store other information about the Transfer.

needBystring(date-time)

DateTime when the Transfer is needed by, in ISO 8601 format

expectedArrivalstring or null(date-time)

DateTime when the arrival of the transfer is expected, in ISO 8601 format

createdstring(date-time)

DateTime when the Transfer was created in Yellow Dog, in ISO 8601 format

lastUpdatedstring(date-time)

DateTime when the Transfer was last updated in Yellow Dog, in ISO 8601 format

storestring or null

Unique ID of the Yellow Dog Store; formatted as GUID (example: 433ef432-f63e-4c26-a29f-39d4079d9fc9) The store that issued the Transfer.

store2string or null

Unique ID of the Yellow Dog Store; formatted as GUID (example: 433ef432-f63e-4c26-a29f-39d4079d9fc9) The store that accepted the Transfer.

createdByUserstring or null

Unique ID of the user who created the Transfer

committedByUserstring or null

Unique ID of the user who issued the Transfer

committed2ByUserstring or null

Unique ID of the user who accepted the Transfer

totalAmountIssuednumber(double)

Total Amount Issued TotalAmountShortage can be calculated by subtracting TotalAmountAccepted from TotalAmountIssued.

totalAmountAcceptednumber(double)

Total Amount Accepted TotalAmountShortage can be calculated by subtracting TotalAmountAccepted from TotalAmountIssued.

statusstring or null

Status of the Transfer.

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

List of Commdoc Lines which belongs to the Transfer.

duestring or null(date-time)Deprecatedread-only

DateTime when the Transfer is needed by, in ISO 8601 format

vendorstring or nullDeprecated

Unique ID of the Yellow Dog Store; formatted as GUID (example: 433ef432-f63e-4c26-a29f-39d4079d9fc9)

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

OK

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

OK

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

OK

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

Gets a Transfer By ID

Request

Path
idstring(uuid)required
Query
ExpandArray of strings

Expand Options:

  • Lines
  • Items
PageNumberinteger(int32)

Page Number for the result set.

This is expected to be an integer value greater than 0. Defaults to 1 when not passed in.

For more information see the Getting Started Section for Pagination.

PageSizeinteger(int32)

Page Size

  • Default page size: 100
  • Max page size: 500

This is expected to be an integer value greater than 0. Defaults to 100 when not passed in.

For more information see the Getting Started Section for Pagination.

FilterArray of strings
OrderByArray of strings
curl -i -X GET \
  'https://developer.yellowdogsoftware.com/_mock/fetch/api/api/v3/transfers/{id}?Expand=string&Filter=string&OrderBy=string&PageNumber=0&PageSize=0' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json
idstring(uuid)

Yellow Dog's unique ID of the Commdoc; formatted as GUID (example: 433ef432-f63e-4c26-a29f-39d4079d9fc9)

thirdPartyIDstring or null
docNumberstring or null

The document number of the Transfer.

referencestring or null

Reference is used to store a secondary code for the Transfer such the supplier's document number.

descriptionstring or null

This is an arbitrary description of the Transfer.

instructionsstring or null

Instructions can be printed on the document printout.

commitboolean

Indicates whether the Transfer is committed or not.

committedstring or null(date-time)

DateTime when the Transfer was issued in Yellow Dog, in ISO 8601 format.

committed2string or null(date-time)

DateTime when the Transfer was accepted in Yellow Dog, in ISO 8601 format.

notesstring or null

Note is used to store other information about the Transfer.

needBystring(date-time)

DateTime when the Transfer is needed by, in ISO 8601 format

expectedArrivalstring or null(date-time)

DateTime when the arrival of the transfer is expected, in ISO 8601 format

createdstring(date-time)

DateTime when the Transfer was created in Yellow Dog, in ISO 8601 format

lastUpdatedstring(date-time)

DateTime when the Transfer was last updated in Yellow Dog, in ISO 8601 format

storestring or null

Unique ID of the Yellow Dog Store; formatted as GUID (example: 433ef432-f63e-4c26-a29f-39d4079d9fc9) The store that issued the Transfer.

store2string or null

Unique ID of the Yellow Dog Store; formatted as GUID (example: 433ef432-f63e-4c26-a29f-39d4079d9fc9) The store that accepted the Transfer.

createdByUserstring or null

Unique ID of the user who created the Transfer

committedByUserstring or null

Unique ID of the user who issued the Transfer

committed2ByUserstring or null

Unique ID of the user who accepted the Transfer

totalAmountIssuednumber(double)

Total Amount Issued TotalAmountShortage can be calculated by subtracting TotalAmountAccepted from TotalAmountIssued.

totalAmountAcceptednumber(double)

Total Amount Accepted TotalAmountShortage can be calculated by subtracting TotalAmountAccepted from TotalAmountIssued.

statusstring or null

Status of the Transfer.

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

List of Commdoc Lines which belongs to the Transfer.

duestring or null(date-time)Deprecatedread-only

DateTime when the Transfer is needed by, in ISO 8601 format

vendorstring or nullDeprecated

Unique ID of the Yellow Dog Store; formatted as GUID (example: 433ef432-f63e-4c26-a29f-39d4079d9fc9)

Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "thirdPartyID": "string",
  "docNumber": "string",
  "reference": "string",
  "description": "string",
  "instructions": "string",
  "commit": true,
  "committed": "2019-08-24T14:15:22Z",
  "committed2": "2019-08-24T14:15:22Z",
  "notes": "string",
  "needBy": "2019-08-24T14:15:22Z",
  "due": "2019-08-24T14:15:22Z",
  "expectedArrival": "2019-08-24T14:15:22Z",
  "created": "2019-08-24T14:15:22Z",
  "lastUpdated": "2019-08-24T14:15:22Z",
  "vendor": "string",
  "store": "string",
  "store2": "string",
  "createdByUser": "string",
  "committedByUser": "string",
  "committed2ByUser": "string",
  "totalAmountIssued": 0.1,
  "totalAmountAccepted": 0.1,
  "status": "string",
  "lines": [
    { … }
  ]
}

Updates an existing Transfer

Request

Path
idstring(uuid)required

CommDoc Id of Transfer

Body

Updated data regarding Transfer

commitboolean
referencestring or null
descriptionstring or null
instructionsstring or null
notesstring or null
duestring or null(date-time)
curl -i -X PATCH \
  '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 '{
    "commit": true,
    "reference": "string",
    "description": "string",
    "instructions": "string",
    "notes": "string",
    "due": "2019-08-24T14:15:22Z"
  }'

Responses

OK

Body
idstring(uuid)

Yellow Dog's unique ID of the Commdoc; formatted as GUID (example: 433ef432-f63e-4c26-a29f-39d4079d9fc9)

thirdPartyIDstring or null
docNumberstring or null

The document number of the Transfer.

referencestring or null

Reference is used to store a secondary code for the Transfer such the supplier's document number.

descriptionstring or null

This is an arbitrary description of the Transfer.

instructionsstring or null

Instructions can be printed on the document printout.

commitboolean

Indicates whether the Transfer is committed or not.

committedstring or null(date-time)

DateTime when the Transfer was issued in Yellow Dog, in ISO 8601 format.

committed2string or null(date-time)

DateTime when the Transfer was accepted in Yellow Dog, in ISO 8601 format.

notesstring or null

Note is used to store other information about the Transfer.

needBystring(date-time)

DateTime when the Transfer is needed by, in ISO 8601 format

expectedArrivalstring or null(date-time)

DateTime when the arrival of the transfer is expected, in ISO 8601 format

createdstring(date-time)

DateTime when the Transfer was created in Yellow Dog, in ISO 8601 format

lastUpdatedstring(date-time)

DateTime when the Transfer was last updated in Yellow Dog, in ISO 8601 format

storestring or null

Unique ID of the Yellow Dog Store; formatted as GUID (example: 433ef432-f63e-4c26-a29f-39d4079d9fc9) The store that issued the Transfer.

store2string or null

Unique ID of the Yellow Dog Store; formatted as GUID (example: 433ef432-f63e-4c26-a29f-39d4079d9fc9) The store that accepted the Transfer.

createdByUserstring or null

Unique ID of the user who created the Transfer

committedByUserstring or null

Unique ID of the user who issued the Transfer

committed2ByUserstring or null

Unique ID of the user who accepted the Transfer

totalAmountIssuednumber(double)

Total Amount Issued TotalAmountShortage can be calculated by subtracting TotalAmountAccepted from TotalAmountIssued.

totalAmountAcceptednumber(double)

Total Amount Accepted TotalAmountShortage can be calculated by subtracting TotalAmountAccepted from TotalAmountIssued.

statusstring or null

Status of the Transfer.

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

List of Commdoc Lines which belongs to the Transfer.

duestring or null(date-time)Deprecatedread-only

DateTime when the Transfer is needed by, in ISO 8601 format

vendorstring or nullDeprecated

Unique ID of the Yellow Dog Store; formatted as GUID (example: 433ef432-f63e-4c26-a29f-39d4079d9fc9)

Response
No response example

Vendors

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

Operations