Dcove
  1. transactional
Dcove
  • master
    • Stores**
      POST
    • Article Batches
      POST
    • Article Eans
      POST
    • Article Master**
      POST
    • Article Supplier Mapping**
      POST
    • DC - Store Mapping**
      POST
    • Manufacturer
      POST
    • Purchase Returns
      POST
    • Wastages
      POST
    • Supplier Master**
      POST
    • Supplier Contacts
      POST
    • Production Pipeline Execution
      POST
    • Kit Master
      POST
    • Bulk Repack Master
      POST
    • Article Uom Master
      POST
    • Supplier WalkIns
      POST
    • Article Pricing Master
      POST
    • Article Store Limits
      POST
    • Current Stock**
      POST
    • Stores As Suppliers
      POST
    • Stock Location**
      POST
    • Customer Master
      POST
    • Company Group
      POST
    • Hierarchy Headers**
      POST
    • Hierarchy Details**
      POST
    • Article Hierarchy**
      POST
    • Article Attributes
      POST
    • ArticleGateKeeperMargin
      POST
  • transactional
    • Stock Ledger**
      POST
    • Bill Header**
      POST
    • Bill Detail**
      POST
    • Invoices Header**
      POST
    • Invoices Detail**
      POST
    • Supplier Invoice Acknowledgement
      POST
    • Purchase Order Header**
      POST
    • Purchase Order Detail
      POST
    • Transfer In Header**
      POST
    • Transfer In Detail**
      POST
    • Transfer Out Header**
      POST
    • Transfer Out Detail**
      POST
    • Transfer Advice Header
      POST
    • Transfer Advice Detail
      POST
  1. transactional

Transfer Advice Header

POST
/tx/transfer_advice_header/
transactional
Transfer advices raised from the system. Ignore if advice process is not used.

Request

Query Params
full_sync
boolean 
optional
Whether the data should be synced in an incremental manner or completely. Defaults to false.
Header Params
X-SYNC-TOKEN
string 
required

<sync_token>

Accept-Encoding
string 
required
gzip (mandatory)
Body Params application/json
array of:
tadvice_id
string 
required
Transfer Advice ID generated at the originating store
hq_sta_id
string 
required
Mapping central ID to the store generated ID.
target_store
string 
required
Store that has to receive the transfer
origin_store
string 
required
Store from where the transfer is originated
transfer_advice_date
string <date>
required
Date the advice was raised.
item_count
number 
required
Number of unique articles
Eg. If 5 pieces of article A and 7 pieces of article B are being transferred, this field should have 2 as the value as there are 2 unique articles.
po_ref
string 
optional
A GRN on a PO can lead to STA's being raised immediately in the case of FT articles. The corresponding PO ID is captured in this field.
transfer_advice_type
enum<string> 
required
Type of the transfer advice. Transfer In(TI), Transfer Out(TO).
Allowed values:
TOTI
transfer_ref
string 
required
A linking reference to map with associated transfer out/in. Can be the same value as the hq_sta_id.
created_at
string <date-time>
required
Example
[
  {
    "tadvice_id": "string",
    "hq_sta_id": "string",
    "target_store": "string",
    "origin_store": "string",
    "transfer_advice_date": "2019-08-24",
    "item_count": 0,
    "po_ref": "string",
    "transfer_advice_type": "TO",
    "transfer_ref": "string",
    "created_at": "2019-08-24T14:15:22Z"
  }
]

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://test.your-api-server.com/tx/transfer_advice_header/' \
--header 'X-SYNC-TOKEN;' \
--header 'Accept-Encoding;' \
--header 'Content-Type: application/json' \
--data-raw '[
    {
        "tadvice_id": "string",
        "hq_sta_id": "string",
        "target_store": "string",
        "origin_store": "string",
        "transfer_advice_date": "2019-08-24",
        "item_count": 0,
        "po_ref": "string",
        "transfer_advice_type": "TO",
        "transfer_ref": "string",
        "created_at": "2019-08-24T14:15:22Z"
    }
]'

Responses

🟢200OK
application/json
Successful Sync
Body
status
string 
optional
message
string 
optional
Example
{
  "status": "string",
  "message": "string"
}
🟠403Forbidden
🟠405405
Modified at 2025-02-10 12:39:04
Previous
Transfer Out Detail**
Next
Transfer Advice Detail
Built with