Transfer Order Services
This document covers all services related to transfer orders, requests, and responses for these services.
Status Codes
The following status codes returns in the response message body of the request.
200 OK: The request was successful and the requested resource is returned in the response.
204 No Content: The request was successful and there is no content to be returned.
400 Bad Request: The request was malformed or missing, false given required parameters.
401 Unauthorized: The requested user is not authorized to access the requested resource.
403 Forbidden: The server understands the request, but the client is not authorized to access the requested resource.
406 Not Acceptable: The server cannot produce a response matching the list of acceptable values defined in the request's headers.
429 Too Many Requests: Made too many requests in a given amount of time and the server is rate limiting the request.
500 Internal Server Error: An unexpected error occurred on the server.
GET Transfer Order List
GET Transfer Order ListReturns a detailed list of transfer orders.
Path: /api/v1/oms/transfer_orders/
Request
Headers: -
Authorization: Token
Content-Type: application/json
Request Body: None
Response (200 OK)
{
"count": 308,
"next": "{domain_url}/api/v1/oms/transfer_orders/?limit=2&page=2",
"previous": null,
"results": [
{
"id": 1358,
"source": {
"id": 1,
"stock_location_type": "store",
"address": {
"id": 1,
"city": {
"pk": 40,
"name": "İSTANBUL",
"country": 1,
"is_active": true,
"longitude": "28.97817800",
"latitude": "41.11121800"
},
"country": {
"pk": 1,
"name": "Türkiye",
"code": "tr",
"is_active": true,
"longitude": "35.30207500",
"latitude": "39.05625600"
},
"township": {
"pk": 457,
"name": "ESENLER",
"city": 40,
"is_active": true,
"longitude": "29.04731900",
"latitude": "41.16672000"
},
"district": {
"pk": 35463,
"name": "AKINON MAH",
"city": 40,
"township": 457,
"is_active": true,
"longitude": "29.13134900",
"latitude": "41.11495200"
},
"mapping": null,
"title": "PZ Store 1",
"is_active": true,
"line": "Lorem ipsum dolor sit amet, 34000 Sarıyer/İstanbul",
"postcode": null,
"notes": null,
"longitude": "28.88940480",
"latitude": "41.01462960"
},
"engine": 34,
"tags": [],
"created_date": "2021-07-06T13:07:14.377251Z",
"modified_date": "2023-03-17T13:18:04.558583Z",
"omnitron_id": 1,
"name": "PZ Store 1",
"is_fulfillment_center": true,
"is_pickup_location": true,
"is_delivery_location": true,
"is_return_available": true,
"is_fast_delivery_available": true,
"is_active": true,
"priority": 10,
"conf": {},
"daytime_phone": "765432",
"evening_phone": "76543",
"fax_number": "76545",
"email": "",
"target_packing_interval": "5 00:00:00",
"target_transfer_interval": "3 00:00:00",
"erp_code": "1",
"use_as_shipper_location": true
},
"destination": {
"id": 4,
"stock_location_type": "warehouse",
"address": {
"id": 4,
"city": {
"pk": 32,
"name": "ESKİŞEHİR",
"country": 1,
"is_active": true,
"longitude": "30.51135900",
"latitude": "39.78062300"
},
"country": {
"pk": 1,
"name": "Türkiye",
"code": "tr",
"is_active": true,
"longitude": "35.30207500",
"latitude": "39.05625600"
},
"township": {
"pk": 377,
"name": "ÇİFTELER",
"city": 32,
"is_active": true,
"longitude": "31.15012400",
"latitude": "39.31760300"
},
"district": {
"pk": 28739,
"name": "AKINON MAH",
"city": 32,
"township": 377,
"is_active": true,
"longitude": "31.13890400",
"latitude": "39.00229800"
},
"mapping": null,
"title": "Pz Store 4",
"is_active": true,
"line": "Lorem ipsum dolor sit amet, 34000 Çifteler/Eskişehir",
"postcode": null,
"notes": null,
"longitude": "30.41473040",
"latitude": "39.36525880"
},
"engine": 34,
"tags": [],
"created_date": "2021-07-06T13:07:14.467913Z",
"modified_date": "2023-04-03T06:22:17.151239Z",
"omnitron_id": 100,
"name": "Pz Store 4",
"is_fulfillment_center": true,
"is_pickup_location": false,
"is_delivery_location": true,
"is_return_available": false,
"is_fast_delivery_available": true,
"is_active": true,
"priority": 10,
"conf": {},
"daytime_phone": "555555",
"evening_phone": "555555",
"fax_number": "555555",
"email": "",
"target_packing_interval": "5 00:00:00",
"target_transfer_interval": "3 00:00:00",
"erp_code": "4",
"use_as_shipper_location": false
},
"transferitem_set": [
{
"id": 1358,
"state": {
"id": 80,
"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": "Bekliyor",
"config": {},
"enum_class": "TransferStatus",
"enum_value": "waiting",
"content_type": 7
},
"unit_type": "quantity",
"package_item": {
"id": 7030,
"state": {
"id": 56,
"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": 5
},
"order_item": {
"id": 6455,
"state": {
"id": 23,
"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": "Onaylanmış",
"config": {},
"enum_class": "OrderStatus",
"enum_value": "400",
"content_type": 3
},
"product": {
"id": 332,
"productimage_set": [
{
"order": 0,
"id": 398,
"url": "{cdn_url}/products/2022/09/07/8363/ca54b126-1f64-4154-9940-41f77b38d6a4.jpg",
"product": 332
}
],
"created_date": "2022-09-15T06:47:53.159625Z",
"modified_date": "2022-09-15T06:47:53.159635Z",
"omnitron_id": 8363,
"name": "Ultimate Organic Cotton T Shirt With Crew Neck",
"base_code": "AKN-009",
"sku": "AKN-009",
"barcode": null,
"attributes": {
"hallo": "Voorbeeld",
"integration_kol_boyu": "orta"
},
"attributes_kwargs": {
"hallo": {
"label": "Voorbeeld",
"value": "Voorbeeld",
"data_type": "valuelabel"
},
"integration_kol_boyu": {
"label": "Orta",
"value": "orta",
"data_type": "dropdown"
}
},
"extra_attributes": {},
"remote_modified_date": "2022-09-07T11:49:42.611585Z"
},
"created_date": "2023-04-03T06:32:06.953477Z",
"modified_date": "2023-04-03T06:32:06.953508Z",
"omnitron_id": 53711,
"net_amount": "10000.00",
"price": "10000.00",
"price_currency": "try",
"retail_price": "1000.00",
"tax_rate": "8.00",
"tax_amount": null,
"discount_amount": "5663.72",
"without_net_amount": null,
"installment_interest_amount": null,
"attributes": {},
"attributes_kwargs": {},
"image": null,
"price_list": {
"pk": 34,
"code": "pz_fiyat_list",
"name": "pz_fiyat_list",
"currency": "try",
"created_date": "2021-02-25T13:41:08.252536Z",
"is_auto_sync": false,
"modified_date": "2023-02-02T13:27:03.825072Z"
},
"stock_list": {
"pk": 34,
"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": 6571
},
"created_date": "2023-04-03T06:47:00.996387Z",
"modified_date": "2023-04-03T06:47:01.150697Z",
"selected_barcode": null,
"serial_no": null,
"unit_weight": null,
"package": 6839,
"denial_reason": null
},
"product": {
"id": 332,
"productimage_set": [
{
"order": 0,
"id": 398,
"url": "{cdn_url}/products/2022/09/07/8363/ca54b126-1f64-4154-9940-41f77b38d6a4.jpg",
"product": 332
}
],
"created_date": "2022-09-15T06:47:53.159625Z",
"modified_date": "2022-09-15T06:47:53.159635Z",
"omnitron_id": 8363,
"name": "Ultimate Organic Cotton T Shirt With Crew Neck",
"base_code": "AKN-009",
"sku": "AKN-009",
"barcode": null,
"attributes": {
"hallo": "Voorbeeld",
"integration_kol_boyu": "orta"
},
"attributes_kwargs": {
"hallo": {
"label": "Voorbeeld",
"value": "Voorbeeld",
"data_type": "valuelabel"
},
"integration_kol_boyu": {
"label": "Orta",
"value": "orta",
"data_type": "dropdown"
}
},
"extra_attributes": {},
"remote_modified_date": "2022-09-07T11:49:42.611585Z"
},
"created_date": "2023-04-03T06:47:01.093229Z",
"modified_date": "2023-04-03T06:47:01.093269Z",
"name": "Transfer Item",
"quantity": "1.00",
"stock_code": null,
"barcode": null,
"transfer_order": 1358
}
],
"number": "2252814672612461P3T2",
"order": 6571,
"order_number": "2252814672612461",
"package": 6839,
"package_number": "2252814672612461P3",
"target_transfer_date": "2023-04-06T06:47:00.981548Z",
"order_date_placed": "2023-04-03T06:31:29.830593Z",
"state": {
"id": 73,
"created_date": "2021-06-30T14:43:27.217659Z",
"modified_date": "2022-10-14T10:39:33.470885Z",
"translations": {
"en-us": {
"name": "Waiting"
},
"tr-tr": {
"name": "Bekliyor"
}
},
"name": "Bekliyor",
"config": {},
"enum_class": "TransferStatus",
"enum_value": "waiting",
"content_type": 6
},
"commands": [
{
"id": 694,
"is_packageitem_parameter_required": false,
"configuration": {},
"translations": null,
"command": "RENEW_TRANSFER_ORDER",
"label": "Renew Transfer Order",
"slug": "renew_transfer",
"ui_visibility": [
"third_party",
"oms_web",
"instore"
],
"source_state": 73,
"destination_state": 75
},
{
"id": 298,
"is_packageitem_parameter_required": false,
"configuration": {},
"translations": null,
"command": "READY_TO_SHIP_TRANSFER_ORDER_ADVANCE",
"label": "Transfer Kargola - Özel",
"slug": "transferorder__ready_to_ship_transfer_order_advance__waiting__ready-for-shipping",
"ui_visibility": [
"third_party",
"oms_web",
"instore"
],
"source_state": 73,
"destination_state": 78
},
{
"id": 100,
"is_packageitem_parameter_required": false,
"configuration": {
"create_shipment": false
},
"translations": null,
"command": "READY_TO_SHIP_TRANSFER_ORDER",
"label": "Transfere Hazır",
"slug": "transferorder__ready_to_ship_transfer_order__waiting__ready-for-shipping",
"ui_visibility": [
"oms_web",
"third_party",
"instore"
],
"source_state": 73,
"destination_state": 78
}
],
"invoice_number": null,
"remote_id": null,
"transfer_shipment": null,
"created_date": "2023-04-03T06:47:01.080369Z",
"modified_date": "2023-04-03T06:47:01.100180Z"
},
{
"id": 1357,
"source": {
"id": 1,
"stock_location_type": "store",
"address": {
"id": 1,
"city": {
"pk": 40,
"name": "İSTANBUL",
"country": 1,
"is_active": true,
"longitude": "28.97817800",
"latitude": "41.01121800"
},
"country": {
"pk": 1,
"name": "Türkiye",
"code": "tr",
"is_active": true,
"longitude": "35.30207500",
"latitude": "39.05625600"
},
"township": {
"pk": 457,
"name": "SARIYER",
"city": 40,
"is_active": true,
"longitude": "29.05731900",
"latitude": "41.16672000"
},
"district": {
"pk": 35463,
"name": "AKINON MAH",
"city": 40,
"township": 457,
"is_active": true,
"longitude": "29.13134900",
"latitude": "41.01495200"
},
"mapping": null,
"title": "PZ Store 1",
"is_active": true,
"line": "Lorem ipsum dolor sit amet, 35000 Sarıyer/İstanbul",
"postcode": null,
"notes": null,
"longitude": "29.88940280",
"latitude": "40.02462960"
},
"engine": 34,
"tags": [],
"created_date": "2021-07-06T13:07:14.377251Z",
"modified_date": "2023-03-17T13:18:04.558583Z",
"omnitron_id": 1,
"name": "PZ Store 1",
"is_fulfillment_center": true,
"is_pickup_location": true,
"is_delivery_location": true,
"is_return_available": true,
"is_fast_delivery_available": true,
"is_active": true,
"priority": 10,
"conf": {},
"daytime_phone": "765432",
"evening_phone": "76543",
"fax_number": "76545",
"email": "",
"target_packing_interval": "5 00:00:00",
"target_transfer_interval": "3 00:00:00",
"erp_code": "1",
"use_as_shipper_location": true
},
"destination": {
"id": 4,
"stock_location_type": "warehouse",
"address": {
"id": 4,
"city": {
"pk": 32,
"name": "ESKİŞEHİR",
"country": 1,
"is_active": true,
"longitude": "30.51135900",
"latitude": "39.78062300"
},
"country": {
"pk": 1,
"name": "Türkiye",
"code": "tr",
"is_active": true,
"longitude": "35.30207500",
"latitude": "39.05625600"
},
"township": {
"pk": 377,
"name": "ÇİFTELER",
"city": 32,
"is_active": true,
"longitude": "31.05012400",
"latitude": "39.32760300"
},
"district": {
"pk": 28739,
"name": "AKINON MAH",
"city": 32,
"township": 377,
"is_active": true,
"longitude": "30.03890400",
"latitude": "39.10229800"
},
"mapping": null,
"title": "Pz Store 4",
"is_active": true,
"line": "Lorem ipsum dolor sit amet, 35000 Çifteler/Eskişehir",
"postcode": null,
"notes": null,
"longitude": "31.40473040",
"latitude": "38.76525880"
},
"engine": 34,
"tags": [],
"created_date": "2021-07-06T13:07:14.467913Z",
"modified_date": "2023-04-03T06:22:17.151239Z",
"omnitron_id": 100,
"name": "Pz Store 4",
"is_fulfillment_center": true,
"is_pickup_location": false,
"is_delivery_location": true,
"is_return_available": false,
"is_fast_delivery_available": true,
"is_active": true,
"priority": 10,
"conf": {},
"daytime_phone": "555555",
"evening_phone": "555555",
"fax_number": "555555",
"email": "",
"target_packing_interval": "5 00:00:00",
"target_transfer_interval": "3 00:00:00",
"erp_code": "4",
"use_as_shipper_location": false
},
"transferitem_set": [
{
"id": 1357,
"state": {
"id": 80,
"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": "Bekliyor",
"config": {},
"enum_class": "TransferStatus",
"enum_value": "waiting",
"content_type": 7
},
"unit_type": "quantity",
"package_item": {
"id": 7029,
"state": {
"id": 56,
"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": 5
},
"order_item": {
"id": 6454,
"state": {
"id": 23,
"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": "Onaylanmış",
"config": {},
"enum_class": "OrderStatus",
"enum_value": "400",
"content_type": 3
},
"product": {
"id": 332,
"productimage_set": [
{
"order": 0,
"id": 398,
"url": "{cdn_url}/products/2022/09/07/8363/ca54b126-1f64-4154-9940-41f77b38d6a4.jpg",
"product": 332
}
],
"created_date": "2022-09-15T06:47:53.159625Z",
"modified_date": "2022-09-15T06:47:53.159635Z",
"omnitron_id": 8363,
"name": "Ultimate Organic Cotton T Shirt With Crew Neck",
"base_code": "AKN-009",
"sku": "AKN-009",
"barcode": null,
"attributes": {
"hallo": "Voorbeeld",
"integration_kol_boyu": "orta"
},
"attributes_kwargs": {
"hallo": {
"label": "Voorbeeld",
"value": "Voorbeeld",
"data_type": "valuelabel"
},
"integration_kol_boyu": {
"label": "Orta",
"value": "orta",
"data_type": "dropdown"
}
},
"extra_attributes": {},
"remote_modified_date": "2022-09-07T11:49:42.611585Z"
},
"created_date": "2023-04-03T06:32:06.931870Z",
"modified_date": "2023-04-03T06:32:06.931911Z",
"omnitron_id": 53710,
"net_amount": "10000.00",
"price": "10000.00",
"price_currency": "try",
"retail_price": "1000.00",
"tax_rate": "8.00",
"tax_amount": null,
"discount_amount": "5663.72",
"without_net_amount": null,
"installment_interest_amount": null,
"attributes": {},
"attributes_kwargs": {},
"image": null,
"price_list": {
"pk": 34,
"code": "pz_fiyat_list",
"name": "pz_fiyat_list",
"currency": "try",
"created_date": "2021-02-25T13:41:08.252536Z",
"is_auto_sync": false,
"modified_date": "2023-02-02T13:27:03.825072Z"
},
"stock_list": {
"pk": 34,
"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": 6571
},
"created_date": "2023-04-03T06:47:00.988485Z",
"modified_date": "2023-04-03T06:47:01.121002Z",
"selected_barcode": null,
"serial_no": null,
"unit_weight": null,
"package": 6839,
"denial_reason": null
},
"product": {
"id": 332,
"productimage_set": [
{
"order": 0,
"id": 398,
"url": "{cdn_url}/products/2022/09/07/8363/ca54b126-1f64-4154-9940-41f77b38d6a4.jpg",
"product": 332
}
],
"created_date": "2022-09-15T06:47:53.159625Z",
"modified_date": "2022-09-15T06:47:53.159635Z",
"omnitron_id": 8363,
"name": "Ultimate Organic Cotton T Shirt With Crew Neck",
"base_code": "AKN-009",
"sku": "AKN-009",
"barcode": null,
"attributes": {
"hallo": "Voorbeeld",
"integration_kol_boyu": "orta"
},
"attributes_kwargs": {
"hallo": {
"label": "Voorbeeld",
"value": "Voorbeeld",
"data_type": "valuelabel"
},
"integration_kol_boyu": {
"label": "Orta",
"value": "orta",
"data_type": "dropdown"
}
},
"extra_attributes": {},
"remote_modified_date": "2022-09-07T11:49:42.611585Z"
},
"created_date": "2023-04-03T06:47:01.067986Z",
"modified_date": "2023-04-03T06:47:01.068011Z",
"name": "Transfer Item",
"quantity": "1.00",
"stock_code": null,
"barcode": null,
"transfer_order": 1357
}
],
"number": "2252814672612461P3T1",
"order": 6571,
"order_number": "2252814672612461",
"package": 6839,
"package_number": "2252814672612461P3",
"target_transfer_date": "2023-04-06T06:47:00.981548Z",
"order_date_placed": "2023-04-03T06:31:29.830593Z",
"state": {
"id": 73,
"created_date": "2021-06-30T14:43:27.217659Z",
"modified_date": "2022-10-14T10:39:33.470885Z",
"translations": {
"en-us": {
"name": "Waiting"
},
"tr-tr": {
"name": "Bekliyor"
}
},
"name": "Bekliyor",
"config": {},
"enum_class": "TransferStatus",
"enum_value": "waiting",
"content_type": 6
},
"commands": [
{
"id": 694,
"is_packageitem_parameter_required": false,
"configuration": {},
"translations": null,
"command": "RENEW_TRANSFER_ORDER",
"label": "Renew Transfer Order",
"slug": "renew_transfer",
"ui_visibility": [
"third_party",
"oms_web",
"instore"
],
"source_state": 73,
"destination_state": 75
},
{
"id": 298,
"is_packageitem_parameter_required": false,
"configuration": {},
"translations": null,
"command": "READY_TO_SHIP_TRANSFER_ORDER_ADVANCE",
"label": "Transfer Kargola - Özel",
"slug": "transferorder__ready_to_ship_transfer_order_advance__waiting__ready-for-shipping",
"ui_visibility": [
"third_party",
"oms_web",
"instore"
],
"source_state": 73,
"destination_state": 78
},
{
"id": 100,
"is_packageitem_parameter_required": false,
"configuration": {
"create_shipment": false
},
"translations": null,
"command": "READY_TO_SHIP_TRANSFER_ORDER",
"label": "Transfere Hazır",
"slug": "transferorder__ready_to_ship_transfer_order__waiting__ready-for-shipping",
"ui_visibility": [
"oms_web",
"third_party",
"instore"
],
"source_state": 73,
"destination_state": 78
}
],
"invoice_number": null,
"remote_id": null,
"transfer_shipment": null,
"created_date": "2023-04-03T06:47:01.051719Z",
"modified_date": "2023-04-03T06:47:01.098143Z"
}
]
}Response Description:
A detailed information about transfer orders, transfer items, transfer shipments, available commands, state, transfer source and destination are transmitted in the message body.
GET Transfer Order List - Simple
GET Transfer Order List - SimpleReturns less detailed information of transfer orders compared to Transfer Order List.
Path: /api/v1/oms/transfer_orders/list-simple/
Request
Headers: -
Authorization: Token
Content-Type: application/json
Request Body: None
Response (200 OK)
{
"count": 308,
"next": "{domain_url}/api/v1/oms/transfer_orders/list-simple/?limit=2&page=2",
"previous": null,
"results": [
{
"id": 1358,
"created_date": "2023-04-03T06:47:01.080369Z",
"modified_date": "2023-04-03T06:47:01.100180Z",
"number": "2252814672612461P3T2",
"target_transfer_date": "2023-04-06T06:47:00.981548Z",
"invoice_number": null,
"remote_id": null,
"state": 73,
"source": 1,
"destination": 4,
"plan_item": 6905
},
{
"id": 1357,
"created_date": "2023-04-03T06:47:01.051719Z",
"modified_date": "2023-04-03T06:47:01.098143Z",
"number": "2252814672612461P3T1",
"target_transfer_date": "2023-04-06T06:47:00.981548Z",
"invoice_number": null,
"remote_id": null,
"state": 73,
"source": 1,
"destination": 4,
"plan_item": 6905
}
]
}Response Description:
Instead of repeatedly transmitting information for all related objects, only their keys are transmitted in the message body.
GET Transfer Order Detail
GET Transfer Order DetailReturns the detailed information of a single transfer order specified with the pk (ID).
Path: /api/v1/oms/transfer_orders/pk/
Request
Headers: -
Authorization: Token
Content-Type: application/json
Request Body: None
Response (200 OK)
{
"id": 1358,
"source": {
"id": 1,
"stock_location_type": "store",
"address": {
"id": 1,
"city": {
"pk": 40,
"name": "İSTANBUL",
"country": 1,
"is_active": true,
"longitude": "28.97817800",
"latitude": "41.11121800"
},
"country": {
"pk": 1,
"name": "Türkiye",
"code": "tr",
"is_active": true,
"longitude": "35.30207500",
"latitude": "39.05625600"
},
"township": {
"pk": 457,
"name": "SARIYER",
"city": 40,
"is_active": true,
"longitude": "29.05731900",
"latitude": "41.16672000"
},
"district": {
"pk": 35463,
"name": "AKINON MAH",
"city": 40,
"township": 457,
"is_active": true,
"longitude": "29.13134900",
"latitude": "41.01495200"
},
"mapping": null,
"title": "PZ Store 1",
"is_active": true,
"line": "Lorem ipsum dolor sit amet, 34000 Sarıyer/İstanbul",
"postcode": null,
"notes": null,
"longitude": "28.98940280",
"latitude": "41.12462960"
},
"engine": 34,
"tags": [],
"created_date": "2021-07-06T13:07:14.377251Z",
"modified_date": "2023-03-17T13:18:04.558583Z",
"omnitron_id": 1,
"name": "PZ Store 1",
"is_fulfillment_center": true,
"is_pickup_location": true,
"is_delivery_location": true,
"is_return_available": true,
"is_fast_delivery_available": true,
"is_active": true,
"priority": 10,
"conf": {},
"daytime_phone": "765432",
"evening_phone": "76543",
"fax_number": "76545",
"email": "",
"target_packing_interval": "5 00:00:00",
"target_transfer_interval": "3 00:00:00",
"erp_code": "1",
"use_as_shipper_location": true
},
"destination": {
"id": 4,
"stock_location_type": "warehouse",
"address": {
"id": 4,
"city": {
"pk": 32,
"name": "ESKİŞEHİR",
"country": 1,
"is_active": true,
"longitude": "30.41135900",
"latitude": "39.78062300"
},
"country": {
"pk": 1,
"name": "Türkiye",
"code": "tr",
"is_active": true,
"longitude": "35.40207500",
"latitude": "39.05625600"
},
"township": {
"pk": 377,
"name": "ÇİFTELER",
"city": 32,
"is_active": true,
"longitude": "31.15012400",
"latitude": "39.32760300"
},
"district": {
"pk": 28739,
"name": "AKINON MAH",
"city": 32,
"township": 377,
"is_active": true,
"longitude": "31.13890400",
"latitude": "39.21229800"
},
"mapping": null,
"title": "Pz Store 4",
"is_active": true,
"line": "Lorem ipsum dolor sit amet, 34000 Çifteler/Eskişehir",
"postcode": null,
"notes": null,
"longitude": "30.30473040",
"latitude": "39.96525880"
},
"engine": 34,
"tags": [],
"created_date": "2021-07-06T13:07:14.467913Z",
"modified_date": "2023-04-03T06:22:17.151239Z",
"omnitron_id": 100,
"name": "Pz Store 4",
"is_fulfillment_center": true,
"is_pickup_location": false,
"is_delivery_location": true,
"is_return_available": false,
"is_fast_delivery_available": true,
"is_active": true,
"priority": 10,
"conf": {},
"daytime_phone": "555555",
"evening_phone": "555555",
"fax_number": "555555",
"email": "",
"target_packing_interval": "5 00:00:00",
"target_transfer_interval": "3 00:00:00",
"erp_code": "4",
"use_as_shipper_location": false
},
"transferitem_set": [
{
"id": 1358,
"state": {
"id": 80,
"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": "Bekliyor",
"config": {},
"enum_class": "TransferStatus",
"enum_value": "waiting",
"content_type": 7
},
"unit_type": "quantity",
"package_item": {
"id": 7030,
"state": {
"id": 56,
"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": 5
},
"order_item": {
"id": 6455,
"state": {
"id": 23,
"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": "Onaylanmış",
"config": {},
"enum_class": "OrderStatus",
"enum_value": "400",
"content_type": 3
},
"product": {
"id": 332,
"productimage_set": [
{
"order": 0,
"id": 398,
"url": "{cdn_url}/products/2022/09/07/8363/ca54b126-1f64-4154-9940-41f77b38d6a4.jpg",
"product": 332
}
],
"created_date": "2022-09-15T06:47:53.159625Z",
"modified_date": "2022-09-15T06:47:53.159635Z",
"omnitron_id": 8363,
"name": "Ultimate Organic Cotton T Shirt With Crew Neck",
"base_code": "AKN-009",
"sku": "AKN-009",
"barcode": null,
"attributes": {
"hallo": "Voorbeeld",
"integration_kol_boyu": "orta"
},
"attributes_kwargs": {
"hallo": {
"label": "Voorbeeld",
"value": "Voorbeeld",
"data_type": "valuelabel"
},
"integration_kol_boyu": {
"label": "Orta",
"value": "orta",
"data_type": "dropdown"
}
},
"extra_attributes": {},
"remote_modified_date": "2022-09-07T11:49:42.611585Z"
},
"created_date": "2023-04-03T06:32:06.953477Z",
"modified_date": "2023-04-03T06:32:06.953508Z",
"omnitron_id": 53711,
"net_amount": "10000.00",
"price": "10000.00",
"price_currency": "try",
"retail_price": "1000.00",
"tax_rate": "8.00",
"tax_amount": null,
"discount_amount": "5663.72",
"without_net_amount": null,
"installment_interest_amount": null,
"attributes": {},
"attributes_kwargs": {},
"image": null,
"price_list": {
"pk": 34,
"code": "pz_fiyat_list",
"name": "pz_fiyat_list",
"currency": "try",
"created_date": "2021-02-25T13:41:08.252536Z",
"is_auto_sync": false,
"modified_date": "2023-02-02T13:27:03.825072Z"
},
"stock_list": {
"pk": 34,
"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": 6571
},
"created_date": "2023-04-03T06:47:00.996387Z",
"modified_date": "2023-04-03T06:47:01.150697Z",
"selected_barcode": null,
"serial_no": null,
"unit_weight": null,
"package": 6839,
"denial_reason": null
},
"product": {
"id": 332,
"productimage_set": [
{
"order": 0,
"id": 398,
"url": "{domain_url}/products/2022/09/07/8363/ca54b126-1f64-4154-9940-41f77b38d6a4.jpg",
"product": 332
}
],
"created_date": "2022-09-15T06:47:53.159625Z",
"modified_date": "2022-09-15T06:47:53.159635Z",
"omnitron_id": 8363,
"name": "Ultimate Organic Cotton T Shirt With Crew Neck",
"base_code": "AKN-009",
"sku": "AKN-009",
"barcode": null,
"attributes": {
"hallo": "Voorbeeld",
"integration_kol_boyu": "orta"
},
"attributes_kwargs": {
"hallo": {
"label": "Voorbeeld",
"value": "Voorbeeld",
"data_type": "valuelabel"
},
"integration_kol_boyu": {
"label": "Orta",
"value": "orta",
"data_type": "dropdown"
}
},
"extra_attributes": {},
"remote_modified_date": "2022-09-07T11:49:42.611585Z"
},
"created_date": "2023-04-03T06:47:01.093229Z",
"modified_date": "2023-04-03T06:47:01.093269Z",
"name": "Transfer Item",
"quantity": "1.00",
"stock_code": null,
"barcode": null,
"transfer_order": 1358
}
],
"number": "2252814672612461P3T2",
"order": 6571,
"order_number": "2252814672612461",
"package": 6839,
"package_number": "2252814672612461P3",
"channel_name": "PZ Shop",
"customer": {
"email": "test@test.com",
"first_name": "Ali",
"last_name": "Veli",
"phone_number": "05555555555",
"erp_code": null,
"pk": 1124,
"channel": 1
},
"shipping_address": {
"id": 1817,
"city": {
"pk": 7,
"name": "ANKARA",
"country": 1,
"is_active": true,
"longitude": "32.75404900",
"latitude": "39.82076300"
},
"country": {
"pk": 1,
"name": "Türkiye",
"code": "tr",
"is_active": true,
"longitude": "35.31207500",
"latitude": "39.15625600"
},
"township": {
"pk": 68,
"name": "SİNCAN",
"city": 7,
"is_active": true,
"longitude": "32.48453600",
"latitude": "39.85817300"
},
"district": {
"pk": 5309,
"name": "AKINON MAH",
"city": 7,
"township": 68,
"is_active": true,
"longitude": "32.47278600",
"latitude": "39.92543200"
},
"customer": {
"email": "test@test.com",
"first_name": "Ali",
"last_name": "Veli",
"phone_number": "05555555555",
"erp_code": null,
"pk": 1124,
"channel": 1
},
"address_type": "customer",
"created_date": "2022-03-21T11:31:50.745452Z",
"modified_date": "2023-04-05T10:53:45.708631Z",
"omnitron_id": 3994,
"mapping": null,
"title": "Test",
"is_active": true,
"line": "Test Caddesi Test Sokak 6/9",
"postcode": "34000",
"notes": null,
"email": "cihat.duman@akinon.com",
"phone_number": "05433506499",
"first_name": "Ali",
"last_name": "Veli",
"company_name": "",
"tax_office": "",
"tax_no": "",
"e_bill_taxpayer": false
},
"target_transfer_date": "2023-04-06T06:47:00.981548Z",
"state": {
"id": 73,
"created_date": "2021-06-30T14:43:27.217659Z",
"modified_date": "2022-10-14T10:39:33.470885Z",
"translations": {
"en-us": {
"name": "Waiting"
},
"tr-tr": {
"name": "Bekliyor"
}
},
"name": "Bekliyor",
"config": {},
"enum_class": "TransferStatus",
"enum_value": "waiting",
"content_type": 6
},
"commands": [
{
"id": 694,
"is_packageitem_parameter_required": false,
"configuration": {},
"translations": null,
"command": "RENEW_TRANSFER_ORDER",
"label": "Renew Transfer Order",
"slug": "renew_transfer",
"ui_visibility": [
"third_party",
"oms_web",
"instore"
],
"source_state": 73,
"destination_state": 75
},
{
"id": 298,
"is_packageitem_parameter_required": false,
"configuration": {},
"translations": null,
"command": "READY_TO_SHIP_TRANSFER_ORDER_ADVANCE",
"label": "Transfer Kargola - Özel",
"slug": "transferorder__ready_to_ship_transfer_order_advance__waiting__ready-for-shipping",
"ui_visibility": [
"third_party",
"oms_web",
"instore"
],
"source_state": 73,
"destination_state": 78
},
{
"id": 100,
"is_packageitem_parameter_required": false,
"configuration": {
"create_shipment": false
},
"translations": null,
"command": "READY_TO_SHIP_TRANSFER_ORDER",
"label": "Transfere Hazır",
"slug": "transferorder__ready_to_ship_transfer_order__waiting__ready-for-shipping",
"ui_visibility": [
"oms_web",
"third_party",
"instore"
],
"source_state": 73,
"destination_state": 78
}
],
"invoice_number": null,
"remote_id": null,
"transfer_shipment": null,
"created_date": "2023-04-03T06:47:01.080369Z",
"modified_date": "2023-04-03T06:47:01.100180Z"
}Response Description:
A detailed information of the transfer order, including transfer items, transfer shipment, available commands, state, transfer source and destination, and customer, is transmitted in the message body.
GET Transfer Order State Transition Log List
GET Transfer Order State Transition Log ListReturns the list of transition logs for a single transfer order specified with the pk (ID).
Path: /api/v1/oms/transfer_orders/pk/transition_logs/
Request
Headers: -
Authorization: Token
Content-Type: application/json
Request Body: None
Response (200 OK)
{
"count": 3,
"next": null,
"previous": null,
"results": [
{
"id": 49749,
"old_state": {
"id": 74,
"name": "In Transit",
"enum_value": "in_transit",
"enum_class": "TransferStatus"
},
"new_state": {
"id": 76,
"name": "Transferred",
"enum_value": "transferred",
"enum_class": "TransferStatus"
},
"user": {
"pk": 661,
"first_name": "Test",
"last_name": "Application",
"email": "test@test.com",
"username": "test.application"
},
"attributes": {
"command": {
"slug": "TRANSFER_ORDER_TRANSFERRED"
},
"remote_user_pk": "298"
},
"created_date": "2023-03-01T13:06:38.320361Z",
"object_id": 1329,
"content_type": 6
},
{
"id": 49747,
"old_state": {
"id": 78,
"name": "Ready for Shipping",
"enum_value": "ready_to_shipment",
"enum_class": "TransferStatus"
},
"new_state": {
"id": 74,
"name": "In Transit",
"enum_value": "in_transit",
"enum_class": "TransferStatus"
},
"user": {
"pk": 661,
"first_name": "Test",
"last_name": "Application",
"email": "test@test.com",
"username": "test.application"
},
"attributes": {
"command": {
"slug": "IN_TRANSIT_TRANSFER_ORDER"
},
"remote_user_pk": "298"
},
"created_date": "2023-03-01T13:06:36.406877Z",
"object_id": 1329,
"content_type": 6
},
{
"id": 49745,
"old_state": {
"id": 73,
"name": "Waiting",
"enum_value": "waiting",
"enum_class": "TransferStatus"
},
"new_state": {
"id": 78,
"name": "Ready for Shipping",
"enum_value": "ready_to_shipment",
"enum_class": "TransferStatus"
},
"user": {
"pk": 661,
"first_name": "Test",
"last_name": "Application",
"email": "test@test.com",
"username": "test.application"
},
"attributes": {
"command": {
"slug": "READY_TO_SHIP_TRANSFER_ORDER_ADVANCE"
},
"remote_user_pk": "298"
},
"created_date": "2023-03-01T13:06:32.112715Z",
"object_id": 1329,
"content_type": 6
}
]
}Response Description:
State transition logs ID, old state, new state, user attributes, created date, object ID and content type are transmitted in the message body.
GET Transfer Order State Transition Log List - Short
GET Transfer Order State Transition Log List - ShortReturns less detailed list of transition logs. The object_id and content_type are omitted when compared to the Transfer Order State Transition Log List.
Path: /api/v1/oms/transfer_orders/pk/transition_logs/short/
Request
Headers: -
Authorization: Token
Content-Type: application/json
Request Body: None
Response (200 OK)
{
"count": 3,
"next": null,
"previous": null,
"results": [
{
"id": 49749,
"old_state": {
"id": 74,
"name": "In Transit",
"enum_value": "in_transit",
"enum_class": "TransferStatus"
},
"new_state": {
"id": 76,
"name": "Transferred",
"enum_value": "transferred",
"enum_class": "TransferStatus"
},
"user": {
"pk": 661,
"first_name": "Test",
"last_name": "Application",
"email": "test@test.com",
"username": "test.application"
},
"attributes": {
"command": {
"slug": "TRANSFER_ORDER_TRANSFERRED"
},
"remote_user_pk": "298"
},
"created_date": "2023-03-01T13:06:38.320361Z"
},
{
"id": 49747,
"old_state": {
"id": 78,
"name": "Ready for Shipping",
"enum_value": "ready_to_shipment",
"enum_class": "TransferStatus"
},
"new_state": {
"id": 74,
"name": "In Transit",
"enum_value": "in_transit",
"enum_class": "TransferStatus"
},
"user": {
"pk": 661,
"first_name": "Test",
"last_name": "Application",
"email": "test@test.com",
"username": "test.application"
},
"attributes": {
"command": {
"slug": "IN_TRANSIT_TRANSFER_ORDER"
},
"remote_user_pk": "298"
},
"created_date": "2023-03-01T13:06:36.406877Z"
},
{
"id": 49745,
"old_state": {
"id": 73,
"name": "Waiting",
"enum_value": "waiting",
"enum_class": "TransferStatus"
},
"new_state": {
"id": 78,
"name": "Ready for Shipping",
"enum_value": "ready_to_shipment",
"enum_class": "TransferStatus"
},
"user": {
"pk": 661,
"first_name": "Test",
"last_name": "Application",
"email": "test@test.com",
"username": "test.application"
},
"attributes": {
"command": {
"slug": "READY_TO_SHIP_TRANSFER_ORDER_ADVANCE"
},
"remote_user_pk": "298"
},
"created_date": "2023-03-01T13:06:32.112715Z"
}
]
}Response Description:
Same as the response in the Transfer Order State Transition Log List, except that the content_type and object_id parameters are not included.
GET Transfer Order State Transition Log Detail
GET Transfer Order State Transition Log DetailReturns details of a single state transition log with thelog_id of the transfer order specified with the pk (ID).
Path: /api/v1/oms/packages/pk/transition_logs/log_id/
Request
Headers: -
Authorization: Token
Content-Type: application/json
Request Body: None
Response (200 OK)
{
"id": 49749,
"old_state": {
"id": 74,
"name": "In Transit",
"enum_value": "in_transit",
"enum_class": "TransferStatus"
},
"new_state": {
"id": 76,
"name": "Transferred",
"enum_value": "transferred",
"enum_class": "TransferStatus"
},
"user": {
"pk": 661,
"first_name": "Test",
"last_name": "Application",
"email": "test@test.com",
"username": "test.application"
},
"attributes": {
"command": {
"slug": "TRANSFER_ORDER_TRANSFERRED"
},
"remote_user_pk": "288"
},
"created_date": "2023-03-01T13:06:38.320361Z",
"object_id": 1329,
"content_type": 6
}Response Description:
State transition log ID, old state, new state, user, attributes, created date object ID and content type are transmitted in the message body.
GET Transfer Order Webhook Event List
GET Transfer Order Webhook Event ListReturns the list of webhook events of the transfer order specified with the pk (ID).
Path: /api/v1/oms/transfer_orders/pk/webhook_events/
Request
Headers: -
Authorization: Token
Content-Type: application/json
Request Body: None
Response (200 OK)
{
"count": 1,
"next": null,
"previous": null,
"results": [
{
"id": 2549,
"webhook": {
"id": 133,
"retry_countdown_config": {
"choice": "fixed",
"kwargs": {
"seconds": 60
}
},
"created_date": "2023-01-04T13:02:18.404799Z",
"modified_date": "2023-01-04T13:02:18.404838Z",
"target_url": "https://httpstat.us/200",
"is_active": true,
"secret_key": null,
"event_type": "transfer.status.cancelled",
"callback": null,
"additional_headers": {},
"config": {}
},
"created_date": "2023-02-10T07:12:20.728712Z",
"modified_date": "2023-02-10T07:12:20.728737Z",
"uuid": "28d0c015-b7d7-4bc9-a031-6379055bd4fd",
"request_payload": {
"event": {
"type": "transfer.status.cancelled",
"uuid": "28d0c015b7d74bc9a0316379055bd4fd"
},
"payload": {
"id": 1292,
"order": 5975,
"state": {
"id": 75,
"name": "Canceled",
"config": {},
"enum_class": "TransferStatus",
"enum_value": "cancelled",
"content_type": 6,
"created_date": "2021-06-30T14:43:27.235431Z",
"translations": {
"en-us": {
"name": "Canceled"
},
"tr-tr": {
"name": "İptal Edilmiş"
}
},
"modified_date": "2022-10-14T10:39:33.464883Z"
},
"number": "2201222151313424P2T5",
"source": {
"id": 1,
"conf": {},
"name": "PZ Store 1",
"tags": [],
"email": "",
"engine": 34,
"address": {
"id": 1,
"city": {
"pk": 40,
"name": "İSTANBUL",
"country": 1,
"latitude": "41.11121800",
"is_active": true,
"longitude": "28.97817800"
},
"line": "Lorem ipsum dolor sit amet, 34000 Sarıyer/İstanbul",
"notes": null,
"title": "PZ Store 1",
"country": {
"pk": 1,
"code": "tr",
"name": "Türkiye",
"latitude": "39.15625600",
"is_active": true,
"longitude": "35.20207500"
},
"mapping": null,
"district": {
"pk": 35463,
"city": 40,
"name": "AKINON MAH",
"latitude": "40.11495200",
"township": 457,
"is_active": true,
"longitude": "28.03134900"
},
"latitude": "41.02462960",
"postcode": null,
"township": {
"pk": 457,
"city": 40,
"name": "SARIYER",
"latitude": "41.06672000",
"is_active": true,
"longitude": "29.15731900"
},
"is_active": true,
"longitude": "28.98940280"
},
"erp_code": "1",
"priority": 10,
"is_active": true,
"fax_number": "76545",
"omnitron_id": 1,
"created_date": "2021-07-06T13:07:14.377251Z",
"daytime_phone": "765432",
"evening_phone": "76543",
"modified_date": "2023-01-25T12:24:19.512801Z",
"is_pickup_location": true,
"is_return_available": true,
"stock_location_type": "store",
"is_delivery_location": true,
"is_fulfillment_center": true,
"target_packing_interval": "5 00:00:00",
"use_as_shipper_location": true,
"target_transfer_interval": "3 00:00:00",
"is_fast_delivery_available": true
},
"package": 6118,
"commands": [],
"remote_id": null,
"destination": {
"id": 3,
"conf": {},
"name": "Pz Store 3",
"tags": [],
"email": "",
"engine": 34,
"address": {
"id": 3,
"city": {
"pk": 40,
"name": "İSTANBUL",
"country": 1,
"latitude": "41.11121800",
"is_active": true,
"longitude": "28.97817800"
},
"line": "Lorem ipsum dolor sit amet, 34000 Adalar/İstanbul",
"notes": null,
"title": "Pz Store 3",
"country": {
"pk": 1,
"code": "tr",
"name": "Türkiye",
"latitude": "39.15625600",
"is_active": true,
"longitude": "35.30207500"
},
"mapping": null,
"district": {
"pk": 36147,
"city": 40,
"name": "AKINON MAH",
"latitude": "41.87945900",
"township": 486,
"is_active": true,
"longitude": "28.09945000"
},
"latitude": "40.75619760",
"postcode": null,
"township": {
"pk": 486,
"city": 40,
"name": "ADALAR",
"latitude": "41.87392200",
"is_active": true,
"longitude": "28.12667800"
},
"is_active": true,
"longitude": "28.10564550"
},
"erp_code": "3",
"priority": 10,
"is_active": true,
"fax_number": "42342341",
"omnitron_id": 67,
"created_date": "2021-07-06T13:07:14.443720Z",
"daytime_phone": "42342341",
"evening_phone": "4234234",
"modified_date": "2023-02-01T09:48:39.783400Z",
"is_pickup_location": true,
"is_return_available": true,
"stock_location_type": "store",
"is_delivery_location": true,
"is_fulfillment_center": true,
"target_packing_interval": "5 00:00:00",
"use_as_shipper_location": false,
"target_transfer_interval": "3 00:00:00",
"is_fast_delivery_available": false
},
"order_number": "2201222151313424",
"invoice_number": null,
"package_number": "2201222151313424P2",
"transferitem_set": [
{
"id": 1292,
"name": "Transfer Item",
"state": {
"id": 82,
"name": "Canceled",
"config": {},
"enum_class": "TransferStatus",
"enum_value": "cancelled",
"content_type": 7,
"created_date": "2021-06-30T14:43:27.301969Z",
"translations": {
"en-us": {
"name": "Canceled"
},
"tr-tr": {
"name": "İptal Edilmiş"
}
},
"modified_date": "2022-10-14T10:39:33.446332Z"
},
"barcode": null,
"product": {
"id": 331,
"sku": "AKN-003",
"name": "Ultimate Organic Cotton T Shirt With Crew Neck",
"barcode": null,
"base_code": "AKN-003",
"attributes": {
"hallo": "Voorbeeld",
"Length": "Long",
"integration_kol_boyu": "kısa"
},
"omnitron_id": 8357,
"created_date": "2022-09-14T08:10:44.353121Z",
"modified_date": "2022-09-14T08:10:44.353133Z",
"extra_attributes": {},
"productimage_set": [
{
"id": 397,
"url": "{cdn_url}/products/2022/09/07/8357/40a65ef3-91d9-4cb6-b031-ab6ae560d410.jpg",
"order": 0,
"product": 331
}
],
"attributes_kwargs": {
"hallo": {
"label": "Voorbeeld",
"value": "Voorbeeld",
"data_type": "valuelabel"
},
"Length": {
"label": "Long",
"value": "Long",
"data_type": "dropdown"
},
"integration_kol_boyu": {
"label": "kısa",
"value": "kısa",
"data_type": "dropdown"
}
},
"remote_modified_date": "2022-09-07T11:47:37.003205Z"
},
"quantity": "1.00",
"unit_type": "quantity",
"stock_code": null,
"created_date": "2023-02-02T13:38:46.823051Z",
"package_item": {
"id": 6231,
"state": {
"id": 66,
"name": "Cancelled",
"config": {},
"enum_class": "PackageItemStatus",
"enum_value": "600",
"content_type": 5,
"created_date": "2021-06-30T14:43:27.146371Z",
"translations": {
"en-us": {
"name": "Cancelled"
},
"tr-tr": {
"name": "İptal Edilmiş"
}
},
"modified_date": "2022-10-14T10:39:33.484288Z"
},
"package": 6118,
"serial_no": null,
"order_item": {
"id": 5835,
"image": null,
"order": 5975,
"price": "999.00",
"state": {
"id": 19,
"name": "Canceled",
"config": {},
"enum_class": "OrderStatus",
"enum_value": "100",
"content_type": 3,
"created_date": "2021-06-30T14:43:26.722855Z",
"translations": {
"en-us": {
"name": "Canceled"
},
"tr-tr": {
"name": "İptal Edilmiş"
}
},
"modified_date": "2022-10-14T10:39:33.593541Z"
},
"product": {
"id": 331,
"sku": "AKN-003",
"name": "Ultimate Organic Cotton T Shirt With Crew Neck",
"barcode": null,
"base_code": "AKN-003",
"attributes": {
"hallo": "Voorbeeld",
"Length": "Long",
"integration_kol_boyu": "kısa"
},
"omnitron_id": 8357,
"created_date": "2022-09-14T08:10:44.353121Z",
"modified_date": "2022-09-14T08:10:44.353133Z",
"extra_attributes": {},
"productimage_set": [
{
"id": 397,
"url": "{cdn_url}/products/2022/09/07/8357/40a65ef3-91d9-4cb6-b031-ab6ae560d410.jpg",
"order": 0,
"product": 331
}
],
"attributes_kwargs": {
"hallo": {
"label": "Voorbeeld",
"value": "Voorbeeld",
"data_type": "valuelabel"
},
"Length": {
"label": "Long",
"value": "Long",
"data_type": "dropdown"
},
"integration_kol_boyu": {
"label": "kısa",
"value": "kısa",
"data_type": "dropdown"
}
},
"remote_modified_date": "2022-09-07T11:47:37.003205Z"
},
"tax_rate": "8.00",
"attributes": {},
"net_amount": "999.00",
"price_list": {
"pk": 34,
"code": "pz_fiyat_list",
"name": "pz_fiyat_list",
"currency": "try",
"created_date": "2021-02-25T13:41:08.252536Z",
"is_auto_sync": false,
"modified_date": "2023-02-02T13:27:03.825072Z"
},
"stock_list": {
"pk": 34,
"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"
},
"tax_amount": null,
"extra_field": {
"price_extra_field": {},
"stock_extra_field": {}
},
"omnitron_id": 52773,
"created_date": "2023-02-02T13:38:11.281631Z",
"retail_price": "1000.00",
"modified_date": "2023-02-10T07:12:19.350481Z",
"price_currency": "try",
"discount_amount": "249.75",
"attributes_kwargs": {},
"parent_omnitron_id": null,
"without_net_amount": null,
"installment_interest_amount": null
},
"unit_weight": null,
"created_date": "2023-02-02T13:38:46.696329Z",
"denial_reason": null,
"modified_date": "2023-02-10T07:12:19.473964Z",
"selected_barcode": null
},
"modified_date": "2023-02-10T07:12:19.580450Z",
"transfer_order": 1292
}
],
"order_date_placed": "2023-02-02T13:23:57.698430Z",
"transfer_shipment": null,
"target_transfer_date": "2023-02-05T13:38:46.677146Z"
}
},
"response_content": "b'200 OK'",
"response_http_status": 200,
"delivered": true,
"request_datetimes": [
"2023-02-10T07:12:20.199831Z"
],
"retry_count": 1,
"object_id": 1292,
"content_type": 6
}
]
}Response Description:
Detailed information about the webhook event of the transfer order is transmitted in the message body.
GET Transfer Order Webhook Event List - Short
GET Transfer Order Webhook Event List - ShortReturns less detailed webhook event data for the transfer order specified with the pk (ID). Compared to Transfer Order Webhook Event List less information about the webhook is transmitted and payload is excluded from the response.
Path: /api/v1/oms/transfer_orders/pk/webhook_events/short/
Request
Headers: -
Authorization: Token
Content-Type: application/json
Request Body: None
Response (200 OK)
{
"count": 1,
"next": null,
"previous": null,
"results": [
{
"id": 2549,
"webhook": {
"id": 133,
"target_url": "https://httpstat.us/200",
"is_active": true,
"event_type": "transfer.status.cancelled"
},
"created_date": "2023-02-10T07:12:20.728712Z",
"modified_date": "2023-02-10T07:12:20.728737Z",
"delivered": true
}
]
}Response Description:
Less detailed webhook data (id, target_url, is_active, event_type), id, created_date, modified_date and delivered status of the webhook event are transmitted in the message body.
GET Transfer Order Webhook Event Detail
GET Transfer Order Webhook Event DetailReturns the details for the single webhook event of the transfer order specified with the pk (ID).
Path: /api/v1/oms/transfer_orders/pk/webhook_events/webhook_event_id/
Request
Headers: -
Authorization: Token
Content-Type: application/json
Request Body: None
Response (200 OK)
{
"id": 2549,
"webhook": {
"id": 133,
"retry_countdown_config": {
"choice": "fixed",
"kwargs": {
"seconds": 60
}
},
"created_date": "2023-01-04T13:02:18.404799Z",
"modified_date": "2023-01-04T13:02:18.404838Z",
"target_url": "https://httpstat.us/200",
"is_active": true,
"secret_key": null,
"event_type": "transfer.status.cancelled",
"callback": null,
"additional_headers": {},
"config": {}
},
"created_date": "2023-02-10T07:12:20.728712Z",
"modified_date": "2023-02-10T07:12:20.728737Z",
"uuid": "28d0c015-b7d7-4bc8-a031-6379055bd4fd",
"request_payload": {
"event": {
"type": "transfer.status.cancelled",
"uuid": "28d0c015b7d74bc9a0316379055bd4fd"
},
"payload": {
"id": 1292,
"order": 5975,
"state": {
"id": 75,
"name": "Canceled",
"config": {},
"enum_class": "TransferStatus",
"enum_value": "cancelled",
"content_type": 6,
"created_date": "2021-06-30T14:43:27.235431Z",
"translations": {
"en-us": {
"name": "Canceled"
},
"tr-tr": {
"name": "İptal Edilmiş"
}
},
"modified_date": "2022-10-14T10:39:33.464883Z"
},
"number": "2201222151313424P2T5",
"source": {
"id": 1,
"conf": {},
"name": "PZ Store 1",
"tags": [],
"email": "",
"engine": 34,
"address": {
"id": 1,
"city": {
"pk": 40,
"name": "İSTANBUL",
"country": 1,
"latitude": "41.11121800",
"is_active": true,
"longitude": "28.87817800"
},
"line": "Lorem ipsum dolor sit amet, 34000 Sarıyer/İstanbul",
"notes": null,
"title": "PZ Store 1",
"country": {
"pk": 1,
"code": "tr",
"name": "Türkiye",
"latitude": "38.05625600",
"is_active": true,
"longitude": "36.30207500"
},
"mapping": null,
"district": {
"pk": 35463,
"city": 40,
"name": "AKINON MAH",
"latitude": "41.01495200",
"township": 457,
"is_active": true,
"longitude": "29.13134900"
},
"latitude": "41.02462960",
"postcode": null,
"township": {
"pk": 457,
"city": 40,
"name": "SARIYER",
"latitude": "41.06672000",
"is_active": true,
"longitude": "29.15731900"
},
"is_active": true,
"longitude": "28.88940280"
},
"erp_code": "1",
"priority": 10,
"is_active": true,
"fax_number": "76545",
"omnitron_id": 1,
"created_date": "2021-07-06T13:07:14.377251Z",
"daytime_phone": "765432",
"evening_phone": "76543",
"modified_date": "2023-01-25T12:24:19.512801Z",
"is_pickup_location": true,
"is_return_available": true,
"stock_location_type": "store",
"is_delivery_location": true,
"is_fulfillment_center": true,
"target_packing_interval": "5 00:00:00",
"use_as_shipper_location": true,
"target_transfer_interval": "3 00:00:00",
"is_fast_delivery_available": true
},
"package": 6118,
"commands": [],
"remote_id": null,
"destination": {
"id": 3,
"conf": {},
"name": "Pz Store 3",
"tags": [],
"email": "",
"engine": 34,
"address": {
"id": 3,
"city": {
"pk": 40,
"name": "İSTANBUL",
"country": 1,
"latitude": "40.01121800",
"is_active": true,
"longitude": "29.97817800"
},
"line": "Lorem ipsum dolor sit amet, 35000 Adalar/İstanbul",
"notes": null,
"title": "Pz Store 3",
"country": {
"pk": 1,
"code": "tr",
"name": "Türkiye",
"latitude": "38.05625600",
"is_active": true,
"longitude": "36.30207500"
},
"mapping": null,
"district": {
"pk": 36147,
"city": 40,
"name": "AKINON MAH",
"latitude": "41.87945900",
"township": 486,
"is_active": true,
"longitude": "28.09945000"
},
"latitude": "40.85619760",
"postcode": null,
"township": {
"pk": 486,
"city": 40,
"name": "ADALAR",
"latitude": "41.87392200",
"is_active": true,
"longitude": "28.12667800"
},
"is_active": true,
"longitude": "29.10564550"
},
"erp_code": "3",
"priority": 10,
"is_active": true,
"fax_number": "42362341",
"omnitron_id": 67,
"created_date": "2021-07-06T13:07:14.443720Z",
"daytime_phone": "42342341",
"evening_phone": "4234234",
"modified_date": "2023-02-01T09:48:39.783400Z",
"is_pickup_location": true,
"is_return_available": true,
"stock_location_type": "store",
"is_delivery_location": true,
"is_fulfillment_center": true,
"target_packing_interval": "5 00:00:00",
"use_as_shipper_location": false,
"target_transfer_interval": "3 00:00:00",
"is_fast_delivery_available": false
},
"order_number": "2201222151313424",
"invoice_number": null,
"package_number": "2201222151313424P2",
"transferitem_set": [
{
"id": 1292,
"name": "Transfer Item",
"state": {
"id": 82,
"name": "Canceled",
"config": {},
"enum_class": "TransferStatus",
"enum_value": "cancelled",
"content_type": 7,
"created_date": "2021-06-30T14:43:27.301969Z",
"translations": {
"en-us": {
"name": "Canceled"
},
"tr-tr": {
"name": "İptal Edilmiş"
}
},
"modified_date": "2022-10-14T10:39:33.446332Z"
},
"barcode": null,
"product": {
"id": 331,
"sku": "AKN-003",
"name": "Ultimate Organic Cotton T Shirt With Crew Neck",
"barcode": null,
"base_code": "AKN-003",
"attributes": {
"hallo": "Voorbeeld",
"Length": "Long",
"integration_kol_boyu": "kısa"
},
"omnitron_id": 8357,
"created_date": "2022-09-14T08:10:44.353121Z",
"modified_date": "2022-09-14T08:10:44.353133Z",
"extra_attributes": {},
"productimage_set": [
{
"id": 397,
"url": "{cdn_url}/products/2022/09/07/8357/40a65ef3-91d9-4cb6-b031-ab6ae560d410.jpg",
"order": 0,
"product": 331
}
],
"attributes_kwargs": {
"hallo": {
"label": "Voorbeeld",
"value": "Voorbeeld",
"data_type": "valuelabel"
},
"Length": {
"label": "Long",
"value": "Long",
"data_type": "dropdown"
},
"integration_kol_boyu": {
"label": "kısa",
"value": "kısa",
"data_type": "dropdown"
}
},
"remote_modified_date": "2022-09-07T11:47:37.003205Z"
},
"quantity": "1.00",
"unit_type": "quantity",
"stock_code": null,
"created_date": "2023-02-02T13:38:46.823051Z",
"package_item": {
"id": 6231,
"state": {
"id": 66,
"name": "Cancelled",
"config": {},
"enum_class": "PackageItemStatus",
"enum_value": "600",
"content_type": 5,
"created_date": "2021-06-30T14:43:27.146371Z",
"translations": {
"en-us": {
"name": "Cancelled"
},
"tr-tr": {
"name": "İptal Edilmiş"
}
},
"modified_date": "2022-10-14T10:39:33.484288Z"
},
"package": 6118,
"serial_no": null,
"order_item": {
"id": 5835,
"image": null,
"order": 5975,
"price": "999.00",
"state": {
"id": 19,
"name": "Canceled",
"config": {},
"enum_class": "OrderStatus",
"enum_value": "100",
"content_type": 3,
"created_date": "2021-06-30T14:43:26.722855Z",
"translations": {
"en-us": {
"name": "Canceled"
},
"tr-tr": {
"name": "İptal Edilmiş"
}
},
"modified_date": "2022-10-14T10:39:33.593541Z"
},
"product": {
"id": 331,
"sku": "AKN-003",
"name": "Ultimate Organic Cotton T Shirt With Crew Neck",
"barcode": null,
"base_code": "AKN-003",
"attributes": {
"hallo": "Voorbeeld",
"Length": "Long",
"integration_kol_boyu": "kısa"
},
"omnitron_id": 8357,
"created_date": "2022-09-14T08:10:44.353121Z",
"modified_date": "2022-09-14T08:10:44.353133Z",
"extra_attributes": {},
"productimage_set": [
{
"id": 397,
"url": "{cdn_url}/products/2022/09/07/8357/40a65ef3-91d9-4cb6-b031-ab6ae560d410.jpg",
"order": 0,
"product": 331
}
],
"attributes_kwargs": {
"hallo": {
"label": "Voorbeeld",
"value": "Voorbeeld",
"data_type": "valuelabel"
},
"Length": {
"label": "Long",
"value": "Long",
"data_type": "dropdown"
},
"integration_kol_boyu": {
"label": "kısa",
"value": "kısa",
"data_type": "dropdown"
}
},
"remote_modified_date": "2022-09-07T11:47:37.003205Z"
},
"tax_rate": "8.00",
"attributes": {},
"net_amount": "999.00",
"price_list": {
"pk": 34,
"code": "pz_fiyat_list",
"name": "pz_fiyat_list",
"currency": "try",
"created_date": "2021-02-25T13:41:08.252536Z",
"is_auto_sync": false,
"modified_date": "2023-02-02T13:27:03.825072Z"
},
"stock_list": {
"pk": 34,
"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"
},
"tax_amount": null,
"extra_field": {
"price_extra_field": {},
"stock_extra_field": {}
},
"omnitron_id": 52773,
"created_date": "2023-02-02T13:38:11.281631Z",
"retail_price": "1000.00",
"modified_date": "2023-02-10T07:12:19.350481Z",
"price_currency": "try",
"discount_amount": "249.75",
"attributes_kwargs": {},
"parent_omnitron_id": null,
"without_net_amount": null,
"installment_interest_amount": null
},
"unit_weight": null,
"created_date": "2023-02-02T13:38:46.696329Z",
"denial_reason": null,
"modified_date": "2023-02-10T07:12:19.473964Z",
"selected_barcode": null
},
"modified_date": "2023-02-10T07:12:19.580450Z",
"transfer_order": 1292
}
],
"order_date_placed": "2023-02-02T13:23:57.698430Z",
"transfer_shipment": null,
"target_transfer_date": "2023-02-05T13:38:46.677146Z"
}
},
"response_content": "b'200 OK'",
"response_http_status": 200,
"delivered": true,
"request_datetimes": [
"2023-02-10T07:12:20.199831Z"
],
"retry_count": 1,
"object_id": 1292,
"content_type": 6
}Response Description:
Detailed information about the webhook event with the entire payload is transmitted in the message body.
POST Transfer Order Command
POST Transfer Order CommandRuns the command given in the request body for the transfer order specified with the pk (ID).
Path: /api/v1/oms/transfer_orders/pk/command/
Request
Headers: -
Authorization: Token
Content-Type: application/json
Body Parameters
Field
Data Type
Required
Description
transition
int
false*
Transition ID
slug
str
false*
Unique slug of transition
input_parameters
dict
true
Parameters ( {} is entered if there are no parameters)
*Either slug or transition is required.
Request Body Example 1
{
"transition": 100,
"input_parameters": {
"cargo_company": "1"
}
}Request Body Example 2
{
"slug": "transferorder__ready_to_ship_transfer_order__waiting__ready-for-shipping",
"input_parameters": {
"cargo_company": "1"
}
}Response (204 No Content)
No ContentResponse Description:
There is no content to send for this request. If there is a content (depending on the command), the status code is 200 OK.
POST Transfer Order - Set Invoice Number
POST Transfer Order - Set Invoice NumberUpdates the invoice number of the transfer order specified with the pk (ID).
Path: /api/v1/oms/transfer_orders/pk/set_invoice_number/
Request
Headers: -
Authorization: Token
Content-Type: application/json
Body Parameters
Field
Data Type
Required
Descriptions
invoice_number
str
true
New invoice number of transfer order
Request Body Example
{
"invoice_number": "123-XYZ-ABC"
}Response (204 No Content)
No ContentResponse Description:
There is no content to send for this request.
POST Transfer Order - Set Remote ID
POST Transfer Order - Set Remote IDUpdates the remote ID of the transfer order specified with the pk (ID).
Path: /api/v1/oms/transfer_orders/pk/set_remote_id/
Request
Headers: -
Authorization: Token
Content-Type: application/json
Body Parameters
Property
Data Type
Required
Descriptions
remote_id
str
true
new remote id of the transfer order
Request Body Example
{
"remote_id": "123"
}Response (204 No Content)
No ContentResponse Description:
There is no content to send for this request.
Last updated
Was this helpful?