Transfer Item Services
All services related to transfer items are listed in this page.
GET Transfer Item List
GET Transfer Item ListThis method is used to get a comprehensive list of transfer items, providing detailed information for each item.
Path: /api/v1/oms/transfer-items/
Query Parameters
The following query parameters can be used to get the details of transfer items.
token
string
header
The API key of the customer account
{transfer_order}
string
query
The id of the transfer order we want to get the transfer items
Example Request
To get a detailed list of all transfer items, a GET request should be sent to
the /api/v1/oms/transfer-items/ endpoint. In the headers, set
the Authorization header to include the token for authentication.
Here's an example of how to make the request in python:
import requests
url = "https://{domain_url}/api/v1/oms/transfer-items/"
token = "f532eXXXXXXXXXXXXXXXXX201XXXXX9332d"
headers = {
'Content-Type': 'application/json',
'Authorization': f'Token {token}'
}
response = requests.request('GET', url, headers=headers)
print(response.json())
Example Response (200 OK)
In a successful response with a status code of 200 OK, the API returns all the details of the transfer items in a JSON format. The response body contains a JSON object with the transfer items and their associated attributes, which may include ID, created and modified date, product, state, etc.
These parameters are described in the following table.
id
integer
The primary key of transfer item
state
json
The status information of transfer item
unit_type
string
The unit type of transfer item
package_item
json
The package item information of transfer item
product
json
The product information of transfer item
created_date
date
The creation date
modified_date
date
The last modified date
name
string
The name of transfer item
quantity
string
How many transfer items
stock_code
string
The stock_code of transfer item
barcode
string
The barcode of transfer item
transfer_order
integer
The transfer order ID of transfer item
This example response serves as a reference to understand the structure and data format returned from this API service.
{
"count": 1,
"next": "https://{domain_url}/api/v1/oms/transfer-items/",
"previous": null,
"results": [
{
"id": 1,
"state": {
"id": 1,
"created_date": "2021-06-30T14:43:27.284188Z",
"modified_date": "2022-10-14T10:39:33.451857Z",
"translations": {
"en-us": {
"name": "Waiting"
},
"tr-tr": {
"name": "Bekliyor"
}
},
"name": "Waiting",
"config": {},
"enum_class": "TransferStatus",
"enum_value": "waiting",
"content_type": 2
},
"unit_type": "quantity",
"package_item": {
"id": 1,
"state": {
"id": 2,
"created_date": "2021-06-30T14:43:27.056807Z",
"modified_date": "2021-06-30T14:43:27.056828Z",
"translations": null,
"name": "Selected for Transfer",
"config": {},
"enum_class": "PackageItemStatus",
"enum_value": "150",
"content_type": 3
},
"order_item": {
"id": 1,
"state": {
"id": 2,
"created_date": "2021-06-30T14:43:26.758043Z",
"modified_date": "2022-10-14T10:39:33.582140Z",
"translations": {
"en-us": {
"name": "Approved"
},
"tr-tr": {
"name": "Onaylanmış"
}
},
"name": "Approved",
"config": {},
"enum_class": "OrderStatus",
"enum_value": "400",
"content_type": 3
},
"product": {
"id": 1,
"productimage_set": [
{
"order": 2,
"id": 3,
"url": "https://{cdn_url}//products/2021/03/17/3/2d8981ac-af12-4a73-9d57-25f447ced938.jpg",
"product": 4
}
],
"created_date": "2021-07-07T08:17:52.118555Z",
"modified_date": "2022-08-10T14:30:12.898719Z",
"omnitron_id": 5,
"name": "product3",
"base_code": "3",
"sku": "3",
"barcode": null,
"attributes": {
"renk": "SİYAH",
"beden": "S",
"hallo": "122",
"aciklama": "c",
"multiple": "test",
"integration_size": "S",
"integration_color": "KIRMIZI",
"integration_gram1": "One size",
"integration_SizeId": "L",
"integration_ColorID": "70c0fe45-43fa-4c51-a9e8-c7a8826b638e",
"integration_ColorId": "KIRMIZI",
"integration_kol_boyu": "orta"
},
"attributes_kwargs": {
"renk": {
"label": "SİYAH",
"value": "SİYAH",
"data_type": "dropdown"
},
"beden": {
"label": "Small",
"value": "S",
"data_type": "dropdown"
},
"hallo": {
"label": "122",
"value": "122",
"data_type": "valuelabel"
},
"integration_size": {
"label": "S",
"value": "S",
"data_type": "dropdown"
},
"integration_color": {
"label": "RED",
"value": "KIRMIZI",
"data_type": "dropdown"
},
"integration_gram1": {
"label": "One Size",
"value": "One size",
"data_type": "dropdown"
},
"integration_SizeId": {
"label": "L",
"value": "L",
"data_type": "dropdown"
},
"integration_ColorID": {
"label": "Blue",
"value": "70c0fe45-43fa-4c51-a9e8-c7a8826b638e",
"data_type": "dropdown"
},
"integration_ColorId": {
"label": "KIRMIZI",
"value": "KIRMIZI",
"data_type": "dropdown"
},
"integration_kol_boyu": {
"label": "Orta",
"value": "orta",
"data_type": "dropdown"
}
},
"extra_attributes": {},
"remote_modified_date": "2022-08-09T16:29:42.245987Z"
},
"created_date": "2021-09-28T08:29:28.515110Z",
"modified_date": "2021-09-28T08:29:28.515136Z",
"omnitron_id": 1,
"net_amount": "599.99",
"price": "599.99",
"price_currency": "try",
"retail_price": "1000.00",
"tax_rate": "8.00",
"tax_amount": null,
"discount_amount": "0.00",
"without_net_amount": null,
"installment_interest_amount": null,
"attributes": {},
"attributes_kwargs": {},
"image": null,
"price_list": {
"pk": 1,
"code": null,
"name": "pz_fiyat_list",
"created_date": "2021-02-25T13:41:08.252536Z",
"is_auto_sync": false,
"modified_date": "2021-02-25T13:41:08.252562Z"
},
"stock_list": {
"pk": 1,
"code": null,
"name": "pz_stok_list",
"created_date": "2021-02-25T13:41:20.523128Z",
"is_auto_sync": false,
"modified_date": "2021-02-25T13:41:20.523152Z"
},
"extra_field": {
"price_extra_field": {},
"stock_extra_field": {}
},
"parent_omnitron_id": null,
"order": 1
},
"created_date": "2021-09-28T08:42:54.128173Z",
"modified_date": "2021-09-28T08:42:54.215515Z",
"selected_barcode": null,
"serial_no": null,
"unit_weight": null,
"package": 1,
"denial_reason": null
},
"product": {
"id": 1,
"productimage_set": [
{
"order": 2,
"id": 3,
"url": "https://{cdn_url}/products/2021/03/17/3/2d9e81ac-af12-4a73-9d57-25a442ced938.jpg",
"product": 4
}
],
"created_date": "2021-07-07T08:17:52.118555Z",
"modified_date": "2022-08-10T14:30:12.898719Z",
"omnitron_id": 5,
"name": "product3",
"base_code": "3",
"sku": "3",
"barcode": null,
"attributes": {
"renk": "SİYAH",
"beden": "S",
"hallo": "122",
"aciklama": "c",
"multiple": "test",
"integration_size": "S",
"integration_color": "KIRMIZI",
"integration_gram1": "One size",
"integration_SizeId": "L",
"integration_ColorID": "70c0fe45-43fa-4c51-a9e8-c7a8826b638e",
"integration_ColorId": "KIRMIZI",
"integration_kol_boyu": "orta"
},
"attributes_kwargs": {
"renk": {
"label": "SİYAH",
"value": "SİYAH",
"data_type": "dropdown"
},
"beden": {
"label": "Small",
"value": "S",
"data_type": "dropdown"
},
"hallo": {
"label": "122",
"value": "122",
"data_type": "valuelabel"
},
"integration_size": {
"label": "S",
"value": "S",
"data_type": "dropdown"
},
"integration_color": {
"label": "RED",
"value": "KIRMIZI",
"data_type": "dropdown"
},
"integration_gram1": {
"label": "One Size",
"value": "One size",
"data_type": "dropdown"
},
"integration_SizeId": {
"label": "L",
"value": "L",
"data_type": "dropdown"
},
"integration_ColorID": {
"label": "Blue",
"value": "70c0fe45-43fa-4c51-a9e8-c7a8826b638e",
"data_type": "dropdown"
},
"integration_ColorId": {
"label": "KIRMIZI",
"value": "KIRMIZI",
"data_type": "dropdown"
},
"integration_kol_boyu": {
"label": "Orta",
"value": "orta",
"data_type": "dropdown"
}
},
"extra_attributes": {},
"remote_modified_date": "2022-08-09T16:29:42.245987Z"
},
"created_date": "2021-09-28T08:42:54.180173Z",
"modified_date": "2021-09-28T08:42:54.180199Z",
"name": "Transfer Item",
"quantity": "1.00",
"stock_code": null,
"barcode": null,
"transfer_order": 1
}
]
}GET Transfer Item List - Simple
GET Transfer Item List - SimpleThis method is used to get a list of transfer items with less detailed information.
Path: /api/v1/oms/transfer-items/list-simple/
Query Parameters
The following query parameters can be used to get the details of transfer items.
token
string
header
The API key of the customer account
{transfer_order}
string
query
The id of the transfer order we want to get the transfer items
Example Request
To get a less detailed information of the transfer items, a GET request
should be sent to the /api/v1/oms/transfer-items/list-simple/ endpoint. In the
headers, set the Authorization header to include the token for
authentication.
Here's an example of how to make the request in python:
import requests
url = "https://{domain_url}/api/v1/oms/transfer-items/list-simple/"
token = "f532eXXXXXXXXXXXXXXXXX201XXXXX9332d"
headers = {
'Content-Type': 'application/json',
'Authorization': f'Token {token}'
}
response = requests.request('GET', url, headers=headers)
print(response.json())
Example Response (200 OK)
In a successful response with a status code of 200 OK, the API returns information about the transfer items in a JSON format. The response body contains a JSON object with the transfer items and their associated attributes that are only used on the frontend.
id
integer
The primary key of transfer item
unit_type
string
The unit type of transfer item
created_date
date
The creation date
modified_date
date
The last modified date
name
string
The name of transfer item
quantity
string
How many transfer items
stock_code
string
The stock_code of transfer item
barcode
string
The barcode of transfer item
state
integer
The state ID of transfer item
transfer_order
integer
The transfer order ID of transfer item
package_item
integer
The package item ID of transfer item
product
integer
The product ID of transfer item
This example response serves as a reference to understand the structure and data format returned from this API service.
{
"count": 1,
"next": "https://{domain_url}/api/v1/oms/transfer-items/list-simple/",
"previous": null,
"results": [
{
"id": 1,
"unit_type": "quantity",
"created_date": "2021-09-28T08:42:54.180173Z",
"modified_date": "2021-09-28T08:42:54.180199Z",
"name": "Transfer Item",
"quantity": "1.00",
"stock_code": null,
"barcode": null,
"state": 2,
"transfer_order": 3,
"package_item": 4,
"product": 5
}
]
}GET Transfer Item - Single
GET Transfer Item - SingleThis method is used to get detailed information about a single transfer item based on its ID.
Path: /api/v1/oms/transfer-items/{id}/
Query Parameters
The following query parameters can be used to get the details of transfer items.
token
string
header
The API key of the customer account
{id}
integer
url
The ID of the transfer item
Example Request
To retrieve detailed information of given transfer item, a GET request should
be sent to the /api/v1/oms/transfer-items/{id}/ endpoint. In the headers, set
the Authorization header to include the token for authentication.
Here's an example of how to make the request in python:
import requests
url = "https://{domain_url}/api/v1/oms/transfer-items/{id}/"
token = "f532eXXXXXXXXXXXXXXXXX201XXXXX9332d"
headers = {
'Content-Type': 'application/json',
'Authorization': f'Token {token}'
}
response = requests.request('GET', url, headers=headers)
print(response.json())Example Response (200 OK)
In a successful response with a status code of 200 OK, the API returns all the details of the transfer items in a JSON format. The response body contains a JSON object with the transfer items and their associated attributes, which may include ID, created and modified date, product, state, etc.
These parameters are described in the following table.
id
integer
The primary key of transfer item
state
json
The status information of transfer item
unit_type
string
The unit type of transfer item
package_item
json
The package item information of transfer item
product
json
The product information of transfer item
created_date
date
The creation date
modified_date
date
The last modified date
name
string
The name of transfer item
quantity
string
How many transfer items
stock_code
string
The stock_code of transfer item
barcode
string
The barcode of transfer item
transfer_order
integer
The transfer order ID of transfer item
This example response serves as a reference to understand the structure and data format returned from this API service.
{
"id": 1,
"state": {
"id": 1,
"created_date": "2021-06-30T14:43:27.284188Z",
"modified_date": "2022-10-14T10:39:33.451857Z",
"translations": {
"en-us": {
"name": "Waiting"
},
"tr-tr": {
"name": "Bekliyor"
}
},
"name": "Waiting",
"config": {},
"enum_class": "TransferStatus",
"enum_value": "waiting",
"content_type": 2
},
"unit_type": "quantity",
"package_item": {
"id": 1,
"state": {
"id": 2,
"created_date": "2021-06-30T14:43:27.056807Z",
"modified_date": "2021-06-30T14:43:27.056828Z",
"translations": null,
"name": "Selected for Transfer",
"config": {},
"enum_class": "PackageItemStatus",
"enum_value": "150",
"content_type": 3
},
"order_item": {
"id": 1,
"state": {
"id": 2,
"created_date": "2021-06-30T14:43:26.758043Z",
"modified_date": "2022-10-14T10:39:33.582140Z",
"translations": {
"en-us": {
"name": "Approved"
},
"tr-tr": {
"name": "Onaylanmış"
}
},
"name": "Approved",
"config": {},
"enum_class": "OrderStatus",
"enum_value": "400",
"content_type": 3
},
"product": {
"id": 1,
"productimage_set": [
{
"order": 2,
"id": 3,
"url": "https://{cdn_url}//products/2021/03/17/3/2d8981ac-af12-4a73-9d57-25f447ced938.jpg",
"product": 4
}
],
"created_date": "2021-07-07T08:17:52.118555Z",
"modified_date": "2022-08-10T14:30:12.898719Z",
"omnitron_id": 5,
"name": "product3",
"base_code": "3",
"sku": "3",
"barcode": null,
"attributes": {
"renk": "SİYAH",
"beden": "S",
"hallo": "122",
"aciklama": "c",
"multiple": "test",
"integration_size": "S",
"integration_color": "KIRMIZI",
"integration_gram1": "One size",
"integration_SizeId": "L",
"integration_ColorID": "70c0fe45-43fa-4c51-a9e8-c7a8826b638e",
"integration_ColorId": "KIRMIZI",
"integration_kol_boyu": "orta"
},
"attributes_kwargs": {
"renk": {
"label": "SİYAH",
"value": "SİYAH",
"data_type": "dropdown"
},
"beden": {
"label": "Small",
"value": "S",
"data_type": "dropdown"
},
"hallo": {
"label": "122",
"value": "122",
"data_type": "valuelabel"
},
"integration_size": {
"label": "S",
"value": "S",
"data_type": "dropdown"
},
"integration_color": {
"label": "RED",
"value": "KIRMIZI",
"data_type": "dropdown"
},
"integration_gram1": {
"label": "One Size",
"value": "One size",
"data_type": "dropdown"
},
"integration_SizeId": {
"label": "L",
"value": "L",
"data_type": "dropdown"
},
"integration_ColorID": {
"label": "Blue",
"value": "70c0fe45-43fa-4c51-a9e8-c7a8826b638e",
"data_type": "dropdown"
},
"integration_ColorId": {
"label": "KIRMIZI",
"value": "KIRMIZI",
"data_type": "dropdown"
},
"integration_kol_boyu": {
"label": "Orta",
"value": "orta",
"data_type": "dropdown"
}
},
"extra_attributes": {},
"remote_modified_date": "2022-08-09T16:29:42.245987Z"
},
"created_date": "2021-09-28T08:29:28.515110Z",
"modified_date": "2021-09-28T08:29:28.515136Z",
"omnitron_id": 1,
"net_amount": "599.99",
"price": "599.99",
"price_currency": "try",
"retail_price": "1000.00",
"tax_rate": "8.00",
"tax_amount": null,
"discount_amount": "0.00",
"without_net_amount": null,
"installment_interest_amount": null,
"attributes": {},
"attributes_kwargs": {},
"image": null,
"price_list": {
"pk": 1,
"code": null,
"name": "pz_fiyat_list",
"created_date": "2021-02-25T13:41:08.252536Z",
"is_auto_sync": false,
"modified_date": "2021-02-25T13:41:08.252562Z"
},
"stock_list": {
"pk": 1,
"code": null,
"name": "pz_stok_list",
"created_date": "2021-02-25T13:41:20.523128Z",
"is_auto_sync": false,
"modified_date": "2021-02-25T13:41:20.523152Z"
},
"extra_field": {
"price_extra_field": {},
"stock_extra_field": {}
},
"parent_omnitron_id": null,
"order": 1
},
"created_date": "2021-09-28T08:42:54.128173Z",
"modified_date": "2021-09-28T08:42:54.215515Z",
"selected_barcode": null,
"serial_no": null,
"unit_weight": null,
"package": 1,
"denial_reason": null
},
"product": {
"id": 1,
"productimage_set": [
{
"order": 2,
"id": 3,
"url": "https://{cdn_url}/products/2021/03/17/3/2d9e81ac-af12-4a73-9d57-25a442ced938.jpg",
"product": 4
}
],
"created_date": "2021-07-07T08:17:52.118555Z",
"modified_date": "2022-08-10T14:30:12.898719Z",
"omnitron_id": 5,
"name": "product3",
"base_code": "3",
"sku": "3",
"barcode": null,
"attributes": {
"renk": "SİYAH",
"beden": "S",
"hallo": "122",
"aciklama": "c",
"multiple": "test",
"integration_size": "S",
"integration_color": "KIRMIZI",
"integration_gram1": "One size",
"integration_SizeId": "L",
"integration_ColorID": "70c0fe45-43fa-4c51-a9e8-c7a8826b638e",
"integration_ColorId": "KIRMIZI",
"integration_kol_boyu": "orta"
},
"attributes_kwargs": {
"renk": {
"label": "SİYAH",
"value": "SİYAH",
"data_type": "dropdown"
},
"beden": {
"label": "Small",
"value": "S",
"data_type": "dropdown"
},
"hallo": {
"label": "122",
"value": "122",
"data_type": "valuelabel"
},
"integration_size": {
"label": "S",
"value": "S",
"data_type": "dropdown"
},
"integration_color": {
"label": "RED",
"value": "KIRMIZI",
"data_type": "dropdown"
},
"integration_gram1": {
"label": "One Size",
"value": "One size",
"data_type": "dropdown"
},
"integration_SizeId": {
"label": "L",
"value": "L",
"data_type": "dropdown"
},
"integration_ColorID": {
"label": "Blue",
"value": "70c0fe45-43fa-4c51-a9e8-c7a8826b638e",
"data_type": "dropdown"
},
"integration_ColorId": {
"label": "KIRMIZI",
"value": "KIRMIZI",
"data_type": "dropdown"
},
"integration_kol_boyu": {
"label": "Orta",
"value": "orta",
"data_type": "dropdown"
}
},
"extra_attributes": {},
"remote_modified_date": "2022-08-09T16:29:42.245987Z"
},
"created_date": "2021-09-28T08:42:54.180173Z",
"modified_date": "2021-09-28T08:42:54.180199Z",
"name": "Transfer Item",
"quantity": "1.00",
"stock_code": null,
"barcode": null,
"transfer_order": 1
}Last updated
Was this helpful?