Package Services
This document covers all services related to packages, 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 Package List
Returns a detailed list of packaging orders.
Path: /api/v1/oms/packages/
Request
- Headers: -
- Authorization: Token
- Body Parameters: None
- Request Body: None
Response (200 OK)
{
"count": 945,
"next": "{domain_url}/api/v1/oms/packages/?limit=2&page=5",
"previous": "{domain_url}/api/v1/oms/packages/?limit=2&page=3",
"results": [
{
"packageitem_set": [
{
"id": 6801,
"state": {
"id": 70,
"created_date": "2021-06-30T14:43:27.186515Z",
"modified_date": "2022-10-14T10:39:33.476374Z",
"translations": {
"en-us": {
"name": "Delivered"
},
"tr-tr": {
"name": "Teslim Edildi"
}
},
"name": "Delivered",
"config": {},
"enum_class": "PackageItemStatus",
"enum_value": "900",
"content_type": 5
},
"discrepancy_reason": null,
"order_item": {
"id": 6307,
"state": {
"id": 28,
"created_date": "2021-06-30T14:43:26.801262Z",
"modified_date": "2022-10-14T10:39:33.568211Z",
"translations": {
"en-us": {
"name": "Preparing"
},
"tr-tr": {
"name": "Hazırlanıyor"
}
},
"name": "Preparing",
"config": {},
"enum_class": "OrderStatus",
"enum_value": "450",
"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-03-15T12:20:30.385608Z",
"modified_date": "2023-03-16T07:14:05.695687Z",
"omnitron_id": 53332,
"net_amount": "10000.00",
"price": "10000.00",
"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": 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": 6438
},
"transfer_order": null,
"denial_reason": null,
"created_date": "2023-03-15T13:19:09.553732Z",
"modified_date": "2023-03-16T09:18:42.225161Z",
"selected_barcode": null,
"serial_no": null,
"unit_weight": null,
"package": 6636
}
],
"order_number": "2236607691411584",
"date_placed": "2023-03-15T12:19:51.710043Z",
"city": "MILANO",
"channel_name": "PZ Shop",
"payment_type": "funds_transfer",
"state": {
"id": 47,
"created_date": "2021-06-30T14:43:26.971748Z",
"modified_date": "2022-10-14T10:39:33.515753Z",
"translations": {
"en-us": {
"name": "Delivered"
},
"tr-tr": {
"name": "Teslim Edildi"
}
},
"name": "Delivered",
"config": {},
"enum_class": "PackageStatus",
"enum_value": "800",
"content_type": 4
},
"number": "2236607691411584P1",
"tracking_number": "68993",
"id": 6636,
"shipping_address": {
"id": 1948,
"city": {
"pk": 1,
"name": "MILANO",
"country": 1,
"is_active": true,
"longitude": "28.97817800",
"latitude": "41.01121800"
},
"country": {
"pk": 1,
"name": "Italy",
"code": "it",
"is_active": true,
"longitude": "35.30207500",
"latitude": "39.05625600"
},
"township": {
"pk": 481,
"name": "20158 Milano MI",
"city": 40,
"is_active": true,
"longitude": "28.85837000",
"latitude": "40.99849900"
},
"district": {
"pk": 36058,
"name": "Lorem Ipsum",
"city": 40,
"township": 481,
"is_active": true,
"longitude": "28.86925700",
"latitude": "41.00260300"
},
"customer": {
"email": "example@mail.com",
"first_name": "John",
"last_name": "Doe",
"phone_number": "+90 555XXX0000",
"erp_code": null,
"pk": 1123,
"channel": 1
},
"address_type": "customer",
"created_date": "2022-04-18T09:22:56.621276Z",
"modified_date": "2023-03-15T13:25:13.628163Z",
"omnitron_id": 4358,
"mapping": null,
"title": "dolor sit amet",
"is_active": true,
"line": "Viale Edoardo Jenner",
"postcode": "34123",
"notes": null,
"email": "example@mail.com",
"phone_number": "+90 555XXX0000",
"first_name": "John",
"last_name": "Doe",
"company_name": "",
"tax_office": "",
"tax_no": "",
"e_bill_taxpayer": false
},
"target_packing_date": "2023-03-20T12:19:51.710043Z",
"order_id": 6438,
"stock_location": {
"id": 1,
"stock_location_type": "store",
"address": {
"id": 1,
"city": {
"pk": 40,
"name": "MILANO",
"country": 1,
"is_active": true,
"longitude": "28.97817800",
"latitude": "41.01121800"
},
"country": {
"pk": 1,
"name": "Italy",
"code": "it",
"is_active": true,
"longitude": "35.30207500",
"latitude": "39.05625600"
},
"township": {
"pk": 457,
"name": "20158 Milano MI",
"city": 40,
"is_active": true,
"longitude": "29.05731900",
"latitude": "41.16672000"
},
"district": {
"pk": 35463,
"name": "Lorem Ipsum",
"city": 40,
"township": 457,
"is_active": true,
"longitude": "29.03134900",
"latitude": "41.11495200"
},
"mapping": null,
"title": "dolor sit amet",
"is_active": true,
"line": "Viale Edoardo Jenner",
"postcode": null,
"notes": null,
"longitude": "28.88940280",
"latitude": "41.02462960"
},
"engine": 1,
"tags": [],
"created_date": "2021-07-06T13:07:14.377251Z",
"modified_date": "2023-03-15T11:49:43.340102Z",
"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": "+90 555XXX0000",
"evening_phone": "+90 555XXX0000",
"fax_number": "+90 555XXX0000",
"email": "",
"target_packing_interval": "5 00:00:00",
"target_transfer_interval": "3 00:00:00",
"erp_code": "1",
"use_as_shipper_location": true
},
"commands": [],
"shipment": {
"id": 3007,
"cargo_company": {
"id": 728,
"shipping_company": "speeta",
"created_date": "2023-01-23T15:14:07.829927Z",
"modified_date": "2023-01-23T15:14:07.829963Z",
"name": "Speeta",
"erp_code": "speeta",
"is_active": true
},
"created_date": "2023-03-16T07:14:05.613687Z",
"modified_date": "2023-03-16T09:18:42.126349Z",
"awb_number": "68993",
"pay_on_delivery_amount": null,
"update_date_time": "2023-03-16T07:14:05.613160Z",
"estimated_delivery_date": null,
"query_number": "68993",
"state": 99,
"package": 6636,
"invoice": null
},
"shipping_label": {
"id": 2974,
"is_file": false,
"preview_url": "/api/v1/oms/shipping-label/2974/preview/",
"uuid": "e6dccd01-bf75-4543-a7ae-ee06bb26ba7d",
"full_path_url": "{domain_url}/api/v1/oms/shipping-label/2974/preview/"
},
"order_gift_box_note": null,
"order_has_gift_box": false,
"order_retail_store_id": null,
"invoice_number": null,
"remote_id": null,
"is_click_and_collect": false,
"delivery_range": null,
"shipment_date": "2023-03-16T07:14:08.633837Z",
"order_notes": null,
"created_date": "2023-03-15T13:19:09.545549Z",
"modified_date": "2023-03-16T09:18:42.164504Z",
"extra_information": {
"distance_to_shipping_address": 3
},
"channel_omnitron_id": 1,
"delivery_type": "standard",
"omnitron_order_id": 46566,
"id_encrypted": "NjYzNg:1pd1tX:gTUEh3rUKoQJC4eBbl0z3ysbUizimE6ELRrfbpnXZFE"
},
{
"packageitem_set": [
{
"id": 6799,
"state": {
"id": 55,
"created_date": "2021-06-30T14:43:27.047706Z",
"modified_date": "2022-10-14T10:39:33.496318Z",
"translations": {
"en-us": {
"name": "Waiting"
},
"tr-tr": {
"name": "Bekliyor"
}
},
"name": "Waiting",
"config": {},
"enum_class": "PackageItemStatus",
"enum_value": "100",
"content_type": 5
},
"discrepancy_reason": null,
"order_item": {
"id": 6309,
"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": "Approved",
"config": {},
"enum_class": "OrderStatus",
"enum_value": "400",
"content_type": 3
},
"product": {
"id": 1,
"productimage_set": [
{
"order": 1,
"id": 1,
"url": "{cdn_url}/products/2021/03/17/8/604303c1-e2f9-4e78-a666-67d75bbca1e3.jpg",
"product": 1
}
],
"created_date": "2021-07-07T08:17:49.890983Z",
"modified_date": "2022-02-09T08:14:57.425198Z",
"omnitron_id": 8,
"name": "PzUrun8",
"base_code": "8",
"sku": "8",
"barcode": null,
"attributes": {
"renk": "SİYAH",
"beden": "L",
"integration_size": "L",
"integration_color": "SİYAH",
"integration_gram1": "One size",
"integration_SizeId": "S",
"integration_ColorId": "SİYAH"
},
"attributes_kwargs": {
"renk": {
"label": "SİYAH",
"value": "SİYAH",
"data_type": "dropdown"
},
"beden": {
"label": "Large",
"value": "L",
"data_type": "dropdown"
},
"integration_size": {
"label": "L",
"value": "L",
"data_type": "dropdown"
},
"integration_color": {
"label": "BLACK",
"value": "SİYAH",
"data_type": "dropdown"
},
"integration_gram1": {
"label": "One Size",
"value": "One size",
"data_type": "dropdown"
},
"integration_SizeId": {
"label": "S",
"value": "S",
"data_type": "dropdown"
},
"integration_ColorId": {
"label": "SİYAH",
"value": "SİYAH",
"data_type": "dropdown"
}
},
"extra_attributes": {},
"remote_modified_date": "2022-02-03T11:53:24.467975Z"
},
"created_date": "2023-03-15T13:07:28.919070Z",
"modified_date": "2023-03-15T13:07:28.919103Z",
"omnitron_id": 53334,
"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": 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": 6440
},
"transfer_order": null,
"denial_reason": null,
"created_date": "2023-03-15T13:19:09.549799Z",
"modified_date": "2023-03-15T13:19:09.549837Z",
"selected_barcode": null,
"serial_no": null,
"unit_weight": null,
"package": 6635
}
],
"order_number": "2236635981212192",
"date_placed": "2023-03-15T13:07:00.687586Z",
"city": "MILANO",
"channel_name": "PZ Shop",
"payment_type": "funds_transfer",
"state": {
"id": 35,
"created_date": "2021-06-30T14:43:26.865903Z",
"modified_date": "2022-10-14T10:39:33.547981Z",
"translations": {
"en-us": {
"name": "Waiting"
},
"tr-tr": {
"name": "Bekliyor"
}
},
"name": "Waiting",
"config": {},
"enum_class": "PackageStatus",
"enum_value": "100",
"content_type": 4
},
"number": "2236635981212192P1",
"tracking_number": null,
"id": 6635,
"shipping_address": {
"id": 4852,
"city": {
"pk": 40,
"name": "MILANO",
"country": 1,
"is_active": true,
"longitude": "28.97817800",
"latitude": "41.01121800"
},
"country": {
"pk": 1,
"name": "Italy",
"code": "it",
"is_active": true,
"longitude": "35.30207500",
"latitude": "39.05625600"
},
"township": {
"pk": 481,
"name": "20158 Milano MI",
"city": 40,
"is_active": true,
"longitude": "28.85837000",
"latitude": "40.99849900"
},
"district": {
"pk": 36048,
"name": "Lorem Ipsum",
"city": 40,
"township": 481,
"is_active": true,
"longitude": "28.83633400",
"latitude": "41.00396400"
},
"customer": {
"email": "example@mail.com",
"first_name": "John",
"last_name": "Doe",
"phone_number": "+90 555XXX0000",
"erp_code": null,
"pk": 1090,
"channel": 1
},
"address_type": "customer",
"created_date": "2022-07-21T13:01:05.503708Z",
"modified_date": "2023-03-15T13:07:28.883066Z",
"omnitron_id": 5248,
"mapping": null,
"title": "dolor sit amet",
"is_active": true,
"line": "Viale Edoardo Jenner",
"postcode": "34000",
"notes": null,
"email": "example@mail.com",
"phone_number": "+90 555XXX0000",
"first_name": "John",
"last_name": "Doe",
"company_name": "",
"tax_office": "",
"tax_no": "",
"e_bill_taxpayer": false
},
"target_packing_date": "2023-03-20T13:07:00.687586Z",
"order_id": 6440,
"stock_location": {
"id": 1,
"stock_location_type": "store",
"address": {
"id": 1,
"city": {
"pk": 40,
"name": "MILANO",
"country": 1,
"is_active": true,
"longitude": "28.97817800",
"latitude": "41.01121800"
},
"country": {
"pk": 1,
"name": "Italy",
"code": "it",
"is_active": true,
"longitude": "35.30207500",
"latitude": "39.05625600"
},
"township": {
"pk": 457,
"name": "20158 Milano MI",
"city": 40,
"is_active": true,
"longitude": "29.05731900",
"latitude": "41.16672000"
},
"district": {
"pk": 35463,
"name": "Lorem Ipsum",
"city": 40,
"township": 457,
"is_active": true,
"longitude": "29.03134900",
"latitude": "41.11495200"
},
"mapping": null,
"title": "dolor sit amet",
"is_active": true,
"line": "Viale Edoardo Jenner",
"postcode": null,
"notes": null,
"longitude": "28.88940280",
"latitude": "41.02462960"
},
"engine": 1,
"tags": [],
"created_date": "2021-07-06T13:07:14.377251Z",
"modified_date": "2023-03-15T11:49:43.340102Z",
"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
},
"commands": [
{
"id": 166,
"is_packageitem_parameter_required": false,
"configuration": {},
"translations": null,
"command": "REFUSE_PACKAGE",
"label": "Refuse Package",
"slug": "package__refuse_package__waiting__requires-replan",
"ui_visibility": [
"oms_web"
],
"source_state": 35,
"destination_state": 52
},
{
"id": 199,
"is_packageitem_parameter_required": false,
"configuration": {},
"translations": null,
"command": "PREPARE_PACKAGE_COMMAND",
"label": "waiting to prep",
"slug": "package__prepare_package_command__waiting__preparing",
"ui_visibility": [
"oms_web"
],
"source_state": 35,
"destination_state": 37
},
{
"id": 138,
"is_packageitem_parameter_required": false,
"configuration": {},
"translations": null,
"command": "PKG_STATE_TRANSITION",
"label": "hazırlamaya başla",
"slug": "package__pkg_state_transition__waiting__preparing",
"ui_visibility": [
"instore",
"oms_web",
"third_party"
],
"source_state": 35,
"destination_state": 37
},
{
"id": 430,
"is_packageitem_parameter_required": true,
"configuration": {},
"translations": null,
"command": "DETECTED_OUT_OF_STOCK_ITEM",
"label": "stokta yok işaretleme",
"slug": "package__detected_out_of_stock_item__waiting__contains-out-of-stock-products",
"ui_visibility": [
"oms_web"
],
"source_state": 35,
"destination_state": 51
},
{
"id": 232,
"is_packageitem_parameter_required": false,
"configuration": {},
"translations": null,
"command": "COMPLETE_PACKAGING_WITHOUT_SHIPMENT",
"label": "test paketle",
"slug": "package__complete_packaging_without_shipment__waiting__packed-all-items",
"ui_visibility": [
"third_party",
"oms_web",
"instore"
],
"source_state": 35,
"destination_state": 40
},
{
"id": 3,
"is_packageitem_parameter_required": false,
"configuration": {},
"translations": null,
"command": "COMPLETE_PACKAGING",
"label": "Pack",
"slug": "package__complete_packaging__waiting__packed-all-items",
"ui_visibility": [
"oms_web",
"third_party",
"instore"
],
"source_state": 35,
"destination_state": 40
},
{
"id": 331,
"is_packageitem_parameter_required": false,
"configuration": {},
"translations": null,
"command": "CHANNEL_BASED_COMPLETE_PACKAGING",
"label": "Channel Based Complete Packaging",
"slug": "package__channel_based_complete_packaging__waiting__packed-all-items",
"ui_visibility": [
"third_party",
"oms_web",
"instore"
],
"source_state": 35,
"destination_state": 40
}
],
"shipment": null,
"shipping_label": null,
"order_gift_box_note": null,
"order_has_gift_box": false,
"order_retail_store_id": null,
"invoice_number": null,
"remote_id": null,
"is_click_and_collect": false,
"delivery_range": null,
"shipment_date": null,
"order_notes": null,
"created_date": "2023-03-15T13:19:09.540339Z",
"modified_date": "2023-03-15T13:19:09.555459Z",
"extra_information": {
"distance_to_shipping_address": 5
},
"channel_omnitron_id": 1,
"delivery_type": "standard",
"omnitron_order_id": 46568,
"id_encrypted": "NjYzNQ:1pd1tX:p8glsWe4BJOLGKAwff-CA-xz6018pxktRGkCAv7qf9o"
}
]
}
Response Description
A detailed list of packages, shipments, shipping labels, package items, available commands, and stock_locations is transmitted in the message body.
GET Package Short List
Returns less detailed list of packages. Compared to Package List packageitem_count is returned instead of packageitem_set, as well as omiting some parameters.
Path: /api/v1/oms/packages/short/
Request
- Headers: -
- Authorization: Token
- Body Parameters: None
- Request Body: None
Response (200 OK)
{
"count": 36404,
"next": "{domain_url}/api/v1/oms/packages/short/?limit=2&page=2",
"previous": null,
"results": [
{
"packageitem_count": 1,
"order_number": "1287006557011424",
"date_placed": "2020-03-11T10:32:13.366823Z",
"channel_name": "E-Commerce",
"state": {
"id": 34,
"created_date": "2019-07-04T15:14:52.390025Z",
"modified_date": "2023-02-14T10:38:27.758634Z",
"translations": {
"en-us": {
"name": "Preparing"
},
"tr-tr": {
"name": "Hazırlanıyor"
}
},
"name": "Hazırlanıyor",
"config": {},
"enum_class": "PackageStatus",
"enum_value": "200",
"content_type": 25
},
"number": "1287006557011424P12",
"id": 162434,
"target_packing_date": "2020-03-16T10:32:13.366823Z",
"order_id": 1848,
"stock_location": {
"id": 648,
"name": "test123",
"erp_code": "test111111123",
"address": {
"line": "Viale Edoardo Jenner",
"city": {
"id": 2,
"name": "MILANO"
}
}
},
"is_click_and_collect": false,
"delivery_type": null
},
{
"packageitem_count": 1,
"order_number": "1625645440612643",
"date_placed": "2021-04-07T09:09:26.643590Z",
"channel_name": "E-Commerce",
"state": {
"id": 34,
"created_date": "2019-07-04T15:14:52.390025Z",
"modified_date": "2023-02-14T10:38:27.758634Z",
"translations": {
"en-us": {
"name": "Preparing"
},
"tr-tr": {
"name": "Hazırlanıyor"
}
},
"name": "Hazırlanıyor",
"config": {},
"enum_class": "PackageStatus",
"enum_value": "200",
"content_type": 25
},
"number": "1625645440612643P6",
"id": 162408,
"target_packing_date": "2021-04-12T09:09:26.643590Z",
"order_id": 3828,
"stock_location": {
"id": 513,
"name": "ankara lokasyon",
"erp_code": "ankara-06",
"address": {
"line": "Viale Edoardo Jenner",
"city": {
"id": 7,
"name": "MILANO"
}
}
},
"is_click_and_collect": false,
"delivery_type": null
}
]
}
Response Description:
Only the parameters needed for the packaging orders list page in the OMS are transmitted. Instead of repeatedly transmitting information for all related objects, only their keys are transmitted in the message body.
GET Package Simple List
Returns less detailed list of packaging orders.
Path: /api/v1/oms/packages/list-simple/
Request
- Headers: -
- Authorization: Token
- Body Parameters: None
- Request Body: None
Response 200 OK
{
"count": 36404,
"next": "{domain_url}/api/v1/oms/packages/list-simple/?count=2&page=3",
"previous": "{domain_url}/api/v1/oms/packages/list-simple/?count=2",
"results": [
{
"id": 162344,
"created_date": "2022-07-07T06:01:26.869420Z",
"modified_date": "2022-07-19T13:52:04.832316Z",
"number": "1777009380716417P2",
"extra_information": {
"distance_to_shipping_address": 3292
},
"target_packing_date": "2021-10-04T13:42:42.446808Z",
"invoice_number": null,
"invoice_url": null,
"remote_id": null,
"state": 34,
"order": 5151,
"shipping_address": 8671,
"stock_location": 513,
"invoice": null,
"plan_item": 287568
},
{
"id": 162343,
"created_date": "2022-07-07T06:01:26.263171Z",
"modified_date": "2022-07-19T08:20:05.627631Z",
"number": "1775214897314431P2",
"extra_information": {
"distance_to_shipping_address": 3626
},
"target_packing_date": "2021-10-02T11:51:59.502532Z",
"invoice_number": null,
"invoice_url": null,
"remote_id": null,
"state": 34,
"order": 5116,
"shipping_address": 8638,
"stock_location": 513,
"invoice": null,
"plan_item": 287567
},
{
"id": 162342,
"created_date": "2022-07-07T06:01:25.675854Z",
"modified_date": "2022-08-12T07:19:57.319534Z",
"number": "1748569371512697P2",
"extra_information": {
"distance_to_shipping_address": 3626
},
"target_packing_date": "2021-09-01T15:42:40.137331Z",
"invoice_number": null,
"invoice_url": null,
"remote_id": null,
"state": 44,
"order": 4817,
"shipping_address": 388,
"stock_location": 513,
"invoice": null,
"plan_item": 287566
},
{
"id": 162341,
"created_date": "2022-07-07T06:01:25.522977Z",
"modified_date": "2022-08-08T12:47:08.433859Z",
"number": "1690628309711932P2",
"extra_information": {
"distance_to_shipping_address": 3842
},
"target_packing_date": "2021-06-26T14:14:14.202454Z",
"invoice_number": null,
"invoice_url": null,
"remote_id": null,
"state": 34,
"order": 4426,
"shipping_address": 39,
"stock_location": 513,
"invoice": null,
"plan_item": 287565
},
{
"id": 162340,
"created_date": "2022-07-07T06:01:25.493237Z",
"modified_date": "2022-10-07T07:23:48.881841Z",
"number": "1396672652811871P8",
"extra_information": {
"distance_to_shipping_address": 3842
},
"target_packing_date": "2020-07-21T08:48:18.172982Z",
"invoice_number": null,
"invoice_url": null,
"remote_id": null,
"state": 142,
"order": 2543,
"shipping_address": 39,
"stock_location": 513,
"invoice": null,
"plan_item": 287564
},
{
"id": 162339,
"created_date": "2022-07-07T06:01:24.727294Z",
"modified_date": "2022-10-05T13:36:07.687503Z",
"number": "1690626044122589P3",
"extra_information": {
"distance_to_shipping_address": 3842
},
"target_packing_date": "2021-06-26T14:10:26.994104Z",
"invoice_number": null,
"invoice_url": null,
"remote_id": null,
"state": 44,
"order": 4424,
"shipping_address": 39,
"stock_location": 513,
"invoice": null,
"plan_item": 287563
},
{
"id": 162338,
"created_date": "2022-07-07T06:01:24.616388Z",
"modified_date": "2022-10-05T13:56:56.757481Z",
"number": "1577324199212424P4",
"extra_information": {
"distance_to_shipping_address": 3626
},
"target_packing_date": "2021-02-15T10:54:02.511544Z",
"invoice_number": null,
"invoice_url": null,
"remote_id": null,
"state": 142,
"order": 3171,
"shipping_address": 817,
"stock_location": 513,
"invoice": null,
"plan_item": 287561
},
{
"id": 162337,
"created_date": "2022-07-07T06:01:24.594910Z",
"modified_date": "2022-10-03T11:48:22.900669Z",
"number": "1577338596812926P12",
"extra_information": {
"distance_to_shipping_address": 3668
},
"target_packing_date": "2021-02-15T11:18:02.316549Z",
"invoice_number": null,
"invoice_url": null,
"remote_id": null,
"state": 34,
"order": 3172,
"shipping_address": 50,
"stock_location": 513,
"invoice": null,
"plan_item": 287560
},
{
"id": 162336,
"created_date": "2022-07-07T06:01:24.581096Z",
"modified_date": "2022-10-03T11:48:57.929897Z",
"number": "1607531023411379P9",
"extra_information": {
"distance_to_shipping_address": 3626
},
"target_packing_date": "2021-03-22T10:00:36.562285Z",
"invoice_number": null,
"invoice_url": null,
"remote_id": null,
"state": 34,
"order": 3630,
"shipping_address": 1081,
"stock_location": 513,
"invoice": null,
"plan_item": 287559
},
{
"id": 162335,
"created_date": "2022-07-07T06:01:24.542703Z",
"modified_date": "2022-10-07T07:23:08.594997Z",
"number": "1569656327412405P15",
"extra_information": {
"distance_to_shipping_address": 3624
},
"target_packing_date": "2021-02-06T13:54:15.520988Z",
"invoice_number": null,
"invoice_url": null,
"remote_id": null,
"state": 142,
"order": 3069,
"shipping_address": 41,
"stock_location": 513,
"invoice": null,
"plan_item": 287562
}
]
}
Response Description:
Since this endpoint is designed specifically for the BI tool, it includes the created_date and modified_date parameters. It excludes the majority of the other parameters.
GET Package Detail
Returns the detailed information of a single package with pk (ID).
Path: /api/v1/oms/packages/pk/
Request
- Headers: -
- Authorization: Token
- Body Parameters: None
- Request Body: None
Response (200 OK)
{
"packageitem_set": [
{
"id": 277271,
"state": {
"id": 241,
"created_date": "2020-12-24T20:11:13.477040Z",
"modified_date": "2023-02-14T10:38:27.865571Z",
"translations": {
"en-us": {
"name": "Preparing"
},
"tr-tr": {
"name": "Hazırlanıyor"
}
},
"name": "Hazırlanıyor",
"config": {},
"enum_class": "PackageItemStatus",
"enum_value": "250",
"content_type": 26
},
"discrepancy_reason": null,
"order_item": {
"id": 3609,
"state": {
"id": 22,
"created_date": "2019-07-04T15:14:51.986693Z",
"modified_date": "2023-02-14T10:38:27.618765Z",
"translations": {
"en-us": {
"name": "Approved"
},
"tr-tr": {
"name": "Onaylanmış"
}
},
"name": "Onaylanmış",
"config": {},
"enum_class": "OrderStatus",
"enum_value": "400",
"content_type": 20
},
"product": {
"id": 84,
"productimage_set": [
{
"order": 11,
"id": 1134,
"url": "{cdn_url}/products/2019/03/17/68/9c7bd616-98f6-499c-b58f-c7f56f042180.jpg",
"product": 84
},
{
"order": 42,
"id": 1135,
"url": "{cdn_url}/products/2019/03/17/68/04936e2c-050a-4a15-abc8-58b16cfc3d73.jpg",
"product": 84
},
{
"order": 63,
"id": 1136,
"url": "{cdn_url}/products/2019/03/17/68/18742616-b244-46fd-a51c-05de483f3866.jpg",
"product": 84
}
],
"created_date": "2020-02-14T14:28:13.795823Z",
"modified_date": "2021-06-21T14:10:21.572603Z",
"omnitron_id": 68,
"name": "YAPAY SUKULENT CAM TERARYUM 8 CM",
"base_code": "1185177",
"sku": "1185177001",
"barcode": null,
"attributes": {
"renk": "RENKSİZ",
"beden": "Standart",
"ebat_en": "8.0",
"erp_Msb": "False",
"erp_Yil": "2017",
"cinsiyet": "Genel",
"ebat_boy": "8.0",
"erp_Beden": "000",
"erp_Sezon": "Devamlı",
"erp_EbatEn": "8.0",
"erp_Outlet": "False",
"erp_AnaRenk": "X",
"erp_EbatBoy": "8.0",
"ebat_agirlik": "0.0",
"erp_AsilRenk": "RENKSİZ",
"erp_Cinsiyet": "Genel",
"variant_renk": "RENKSİZ",
"erp_AnaMalTip": "0",
"erp_VaryantNo": "1185177-000",
"ebat_yukseklik": "1.0",
"erp_MalGrupAdi": "CONCEPT",
"erp_UretimYeri": "TÜRKİYE",
"erp_EbatAgirlik": "0.0",
"erp_MalDetayAdi": "SAKSILI ÇİÇEK",
"erp_MalSinifAdi": "BİTKİ GRUBU",
"integration_Msb": "False",
"integration_Yil": "2017",
"erp_EbatYukseklik": "1.0",
"erp_MalAltGrupAdi": "DEKORATIF",
"integration_Beden": "000",
"integration_Sezon": "Devamlı",
"erp_MalAltSinifAdi": "ÇİÇEK GRUBU",
"integration_EbatEn": "8.0",
"integration_Outlet": "False",
"erp_AciklayiciBilgi": "<p> </p><p>En: 8</p><p>Boy: 8</p><p>Yükseklik: 1</p><p>Menşei: TÜRKİYE</p>",
"integration_AnaRenk": "X",
"integration_EbatBoy": "8.0",
"integration_AsilRenk": "RENKSİZ",
"integration_Cinsiyet": "Genel",
"integration_AnaMalTip": "0",
"integration_VaryantNo": "1185177-000",
"integration_MalGrupAdi": "CONCEPT",
"integration_UretimYeri": "TÜRKİYE",
"integration_EbatAgirlik": "0.0",
"integration_MalDetayAdi": "SAKSILI ÇİÇEK",
"integration_MalSinifAdi": "BİTKİ GRUBU",
"integration_EbatYukseklik": "1.0",
"integration_MalAltGrupAdi": "DEKORATIF",
"integration_MalAltSinifAdi": "ÇİÇEK GRUBU",
"integration_AciklayiciBilgi": "<p> </p><p>En: 8</p><p>Boy: 8</p><p>Yükseklik: 1</p><p>Menşei: TÜRKİYE</p>"
},
"attributes_kwargs": {
"renk": {
"label": "RENKSİZ",
"value": "RENKSİZ",
"data_type": "dropdown"
},
"beden": {
"label": "Standart",
"value": "Standart",
"data_type": "dropdown"
},
"erp_Msb": {
"label": "False",
"value": "False",
"data_type": "dropdown"
},
"cinsiyet": {
"label": "Genel",
"value": "Genel",
"data_type": "dropdown"
},
"erp_Beden": {
"label": "000",
"value": "000",
"data_type": "dropdown"
},
"erp_Outlet": {
"label": "False",
"value": "False",
"data_type": "dropdown"
},
"erp_AnaRenk": {
"label": "X",
"value": "X",
"data_type": "dropdown"
},
"erp_AsilRenk": {
"label": "RENKSİZ",
"value": "RENKSİZ",
"data_type": "dropdown"
},
"erp_Cinsiyet": {
"label": "Genel",
"value": "Genel",
"data_type": "dropdown"
},
"variant_renk": {
"label": "RENKSİZ",
"value": "RENKSİZ",
"data_type": "dropdown"
},
"erp_AnaMalTip": {
"label": "0",
"value": "0",
"data_type": "dropdown"
},
"erp_MalGrupAdi": {
"label": "CONCEPT",
"value": "CONCEPT",
"data_type": "dropdown"
},
"erp_UretimYeri": {
"label": "TÜRKİYE",
"value": "TÜRKİYE",
"data_type": "dropdown"
},
"erp_MalDetayAdi": {
"label": "SAKSILI ÇİÇEK",
"value": "SAKSILI ÇİÇEK",
"data_type": "dropdown"
},
"erp_MalSinifAdi": {
"label": "BİTKİ GRUBU",
"value": "BİTKİ GRUBU",
"data_type": "dropdown"
},
"erp_MalAltGrupAdi": {
"label": "DEKORATIF",
"value": "DEKORATIF",
"data_type": "dropdown"
},
"erp_MalAltSinifAdi": {
"label": "ÇİÇEK GRUBU",
"value": "ÇİÇEK GRUBU",
"data_type": "dropdown"
}
},
"extra_attributes": {},
"remote_modified_date": "2021-06-13T22:07:08.316236Z"
},
"created_date": "2021-06-21T14:10:22.034062Z",
"modified_date": "2021-06-21T14:10:22.034092Z",
"omnitron_id": 5909,
"net_amount": "100.00",
"price": "100.00",
"price_currency": "try",
"retail_price": "200.00",
"tax_rate": "18.00",
"tax_amount": null,
"discount_amount": "20.00",
"without_net_amount": null,
"installment_interest_amount": null,
"attributes": {},
"attributes_kwargs": {},
"image": null,
"price_list": {
"pk": 1,
"code": null,
"name": "Demo Price List",
"created_date": "2019-05-22T14:59:02.904438Z",
"is_auto_sync": false,
"modified_date": "2019-05-22T14:59:02.904461Z"
},
"stock_list": {
"pk": 1,
"code": null,
"name": "Demo Stock List",
"created_date": "2019-05-22T14:59:20.055271Z",
"is_auto_sync": false,
"modified_date": "2019-05-22T14:59:20.055292Z"
},
"extra_field": {
"price_extra_field": {},
"stock_extra_field": {}
},
"parent_omnitron_id": null,
"order": 4423
},
"transfer_order": null,
"denial_reason": null,
"created_date": "2022-10-06T06:49:28.195280Z",
"modified_date": "2022-10-07T07:01:57.708415Z",
"selected_barcode": null,
"serial_no": null,
"unit_weight": null,
"package": 162407
}
],
"order_number": "1690624566214332",
"date_placed": "2021-06-21T14:07:59.205955Z",
"city": "MILANO",
"channel_name": "E-Commerce",
"payment_type": "credit_card",
"state": {
"id": 34,
"created_date": "2019-07-04T15:14:52.390025Z",
"modified_date": "2023-02-14T10:38:27.758634Z",
"translations": {
"en-us": {
"name": "Preparing"
},
"tr-tr": {
"name": "Hazırlanıyor"
}
},
"name": "Hazırlanıyor",
"config": {},
"enum_class": "PackageStatus",
"enum_value": "200",
"content_type": 25
},
"number": "1690624566214332P5",
"tracking_number": null,
"id": 162407,
"shipping_address": {
"id": 39,
"city": {
"pk": 2,
"name": "MILANO",
"country": 1,
"is_active": true,
"longitude": "38.27725920",
"latitude": "37.76365000"
},
"country": {
"pk": 1,
"name": "Italy",
"code": "it",
"is_active": true,
"longitude": "35.24332200",
"latitude": "38.96374500"
},
"township": {
"pk": 21,
"name": "20158 Milano MI",
"city": 2,
"is_active": true,
"longitude": "37.59607040",
"latitude": "37.77087630"
},
"district": {
"pk": 1605,
"name": "Lorem Ipsum",
"city": 2,
"township": 21,
"is_active": true,
"longitude": "37.69180000",
"latitude": "37.84640000"
},
"customer": {
"email": "example@mail.com",
"first_name": "John",
"last_name": "Doe",
"phone_number": "+90 555XXX0000",
"erp_code": null,
"pk": 335,
"channel": 1
},
"address_type": "customer",
"created_date": "2019-09-19T07:32:47.514656Z",
"modified_date": "2021-06-29T12:16:02.586289Z",
"omnitron_id": 34,
"mapping": null,
"title": "dolor sit amet",
"is_active": true,
"line": "Viale Edoardo Jenner",
"postcode": "11111",
"notes": null,
"email": "example@mail.com",
"phone_number": "+90 555XXX0000",
"first_name": "John",
"last_name": "Doe",
"company_name": "",
"tax_office": "",
"tax_no": "",
"e_bill_taxpayer": false
},
"target_packing_date": "2021-06-22T14:07:59.205955Z",
"order_id": 4423,
"stock_location": {
"id": 150,
"stock_location_type": "store",
"address": {
"id": 187,
"city": {
"pk": 4,
"name": "MILANO",
"country": 1,
"is_active": true,
"longitude": null,
"latitude": null
},
"country": {
"pk": 1,
"name": "Italy",
"code": "it",
"is_active": true,
"longitude": "35.24332200",
"latitude": "38.96374500"
},
"township": {
"pk": 44,
"name": "20158 Milano MI",
"city": 4,
"is_active": true,
"longitude": null,
"latitude": null
},
"district": {
"pk": 3230,
"name": "Lorem Ipsum",
"city": 4,
"township": 44,
"is_active": true,
"longitude": null,
"latitude": null
},
"mapping": null,
"title": "dolor sit amet",
"is_active": true,
"line": "Viale Edoardo Jenner",
"postcode": null,
"notes": null,
"longitude": "26.00000000",
"latitude": "40.00000000"
},
"engine": 1143,
"tags": [],
"created_date": "2021-01-14T14:31:12.467262Z",
"modified_date": "2021-06-03T11:47:14.296553Z",
"omnitron_id": null,
"name": "Test magaza",
"is_fulfillment_center": true,
"is_pickup_location": false,
"is_delivery_location": false,
"is_return_available": false,
"is_fast_delivery_available": null,
"is_active": true,
"priority": 10,
"conf": {},
"daytime_phone": "",
"evening_phone": "",
"fax_number": "",
"email": "",
"target_packing_interval": "1 00:00:00",
"target_transfer_interval": "1 00:00:00",
"erp_code": "test_123",
"use_as_shipper_location": true
},
"commands": [
{
"id": 1215,
"is_packageitem_parameter_required": false,
"configuration": {},
"translations": null,
"command": "COMPLETE_PACKAGING",
"label": "Test Cache Command",
"slug": "package__complete_packaging__hazırlanıyor__paketlendi",
"ui_visibility": [
"third_party",
"oms_web",
"instore"
],
"source_state": 34,
"destination_state": 37
}
],
"shipment": null,
"shipping_label": null,
"order_gift_box_note": null,
"order_has_gift_box": false,
"order_retail_store_id": null,
"invoice_number": null,
"remote_id": null,
"is_click_and_collect": false,
"delivery_range": null,
"shipment_date": null,
"order_notes": null,
"created_date": "2022-10-06T06:49:28.189765Z",
"modified_date": "2022-10-07T07:01:57.689998Z",
"extra_information": {
"distance_to_shipping_address": 1039
},
"channel_omnitron_id": 1,
"delivery_type": null,
"omnitron_order_id": 106640,
"id_encrypted": "MTYyNDA3:1pbc9S:x6hN_rCYmyLdtsO0EWlO1CfHy6gjGMbzRyCZuZinKFY"
}
Response Description:
Package related information, including shipment, shipping label, package items, available commands, and stock locations, is transmitted in the message body.
GET Package Short Detail
Returns less detailed information of the package with pk (ID) compared to Package Detail.
Path: /api/v1/oms/packages/pk/short/
Request
- Headers: -
- Authorization: Token
- Body Parameters: None
- Request Body: None
Response (200 OK)
{
"packageitem_set": [
{
"id": 277270,
"state": {
"id": 56,
"created_date": "2019-07-04T15:14:52.589559Z",
"modified_date": "2023-02-14T10:38:27.889363Z",
"translations": {
"en-us": {
"name": "Cancelled"
},
"tr-tr": {
"name": "İptal Edilmiş"
}
},
"name": "İptal Edilmiş",
"config": {},
"enum_class": "PackageItemStatus",
"enum_value": "600",
"content_type": 26
},
"discrepancy_reason": null,
"order_item": {
"id": 3609,
"state": {
"id": 22,
"created_date": "2019-07-04T15:14:51.986693Z",
"modified_date": "2023-02-14T10:38:27.618765Z",
"translations": {
"en-us": {
"name": "Approved"
},
"tr-tr": {
"name": "Onaylanmış"
}
},
"name": "Onaylanmış",
"config": {},
"enum_class": "OrderStatus",
"enum_value": "400",
"content_type": 20
},
"product": {
"id": 84,
"productimage_set": [
{
"order": 11,
"id": 1134,
"url": "{cdn_url}/products/2019/03/17/68/9c7bd616-98f6-499c-b58f-c7f56f042180.jpg",
"product": 84
},
{
"order": 42,
"id": 1135,
"url": "{cdn_url}/products/2019/03/17/68/04936e2c-050a-4a15-abc8-58b16cfc3d73.jpg",
"product": 84
},
{
"order": 63,
"id": 1136,
"url": "{cdn_url}/products/2019/03/17/68/18742616-b244-46fd-a51c-05de483f3866.jpg",
"product": 84
}
],
"created_date": "2020-02-14T14:28:13.795823Z",
"modified_date": "2021-06-21T14:10:21.572603Z",
"omnitron_id": 68,
"name": "YAPAY SUKULENT CAM TERARYUM 8 CM",
"base_code": "1185177",
"sku": "1185177001",
"barcode": null,
"attributes": {
"renk": "RENKSİZ",
"beden": "Standart",
"ebat_en": "8.0",
"erp_Msb": "False",
"erp_Yil": "2017",
"cinsiyet": "Genel",
"ebat_boy": "8.0",
"erp_Beden": "000",
"erp_Sezon": "Devamlı",
"erp_EbatEn": "8.0",
"erp_Outlet": "False",
"erp_AnaRenk": "X",
"erp_EbatBoy": "8.0",
"ebat_agirlik": "0.0",
"erp_AsilRenk": "RENKSİZ",
"erp_Cinsiyet": "Genel",
"variant_renk": "RENKSİZ",
"erp_AnaMalTip": "0",
"erp_VaryantNo": "1185177-000",
"ebat_yukseklik": "1.0",
"erp_MalGrupAdi": "CONCEPT",
"erp_UretimYeri": "TÜRKİYE",
"erp_EbatAgirlik": "0.0",
"erp_MalDetayAdi": "SAKSILI ÇİÇEK",
"erp_MalSinifAdi": "BİTKİ GRUBU",
"integration_Msb": "False",
"integration_Yil": "2017",
"erp_EbatYukseklik": "1.0",
"erp_MalAltGrupAdi": "DEKORATIF",
"integration_Beden": "000",
"integration_Sezon": "Devamlı",
"erp_MalAltSinifAdi": "ÇİÇEK GRUBU",
"integration_EbatEn": "8.0",
"integration_Outlet": "False",
"erp_AciklayiciBilgi": "<p> </p><p>En: 8</p><p>Boy: 8</p><p>Yükseklik: 1</p><p>Menşei: TÜRKİYE</p>",
"integration_AnaRenk": "X",
"integration_EbatBoy": "8.0",
"integration_AsilRenk": "RENKSİZ",
"integration_Cinsiyet": "Genel",
"integration_AnaMalTip": "0",
"integration_VaryantNo": "1185177-000",
"integration_MalGrupAdi": "CONCEPT",
"integration_UretimYeri": "TÜRKİYE",
"integration_EbatAgirlik": "0.0",
"integration_MalDetayAdi": "SAKSILI ÇİÇEK",
"integration_MalSinifAdi": "BİTKİ GRUBU",
"integration_EbatYukseklik": "1.0",
"integration_MalAltGrupAdi": "DEKORATIF",
"integration_MalAltSinifAdi": "ÇİÇEK GRUBU",
"integration_AciklayiciBilgi": "<p> </p><p>En: 8</p><p>Boy: 8</p><p>Yükseklik: 1</p><p>Menşei: TÜRKİYE</p>"
},
"attributes_kwargs": {
"renk": {
"label": "RENKSİZ",
"value": "RENKSİZ",
"data_type": "dropdown"
},
"beden": {
"label": "Standart",
"value": "Standart",
"data_type": "dropdown"
},
"erp_Msb": {
"label": "False",
"value": "False",
"data_type": "dropdown"
},
"cinsiyet": {
"label": "Genel",
"value": "Genel",
"data_type": "dropdown"
},
"erp_Beden": {
"label": "000",
"value": "000",
"data_type": "dropdown"
},
"erp_Outlet": {
"label": "False",
"value": "False",
"data_type": "dropdown"
},
"erp_AnaRenk": {
"label": "X",
"value": "X",
"data_type": "dropdown"
},
"erp_AsilRenk": {
"label": "RENKSİZ",
"value": "RENKSİZ",
"data_type": "dropdown"
},
"erp_Cinsiyet": {
"label": "Genel",
"value": "Genel",
"data_type": "dropdown"
},
"variant_renk": {
"label": "RENKSİZ",
"value": "RENKSİZ",
"data_type": "dropdown"
},
"erp_AnaMalTip": {
"label": "0",
"value": "0",
"data_type": "dropdown"
},
"erp_MalGrupAdi": {
"label": "CONCEPT",
"value": "CONCEPT",
"data_type": "dropdown"
},
"erp_UretimYeri": {
"label": "TÜRKİYE",
"value": "TÜRKİYE",
"data_type": "dropdown"
},
"erp_MalDetayAdi": {
"label": "SAKSILI ÇİÇEK",
"value": "SAKSILI ÇİÇEK",
"data_type": "dropdown"
},
"erp_MalSinifAdi": {
"label": "BİTKİ GRUBU",
"value": "BİTKİ GRUBU",
"data_type": "dropdown"
},
"erp_MalAltGrupAdi": {
"label": "DEKORATIF",
"value": "DEKORATIF",
"data_type": "dropdown"
},
"erp_MalAltSinifAdi": {
"label": "ÇİÇEK GRUBU",
"value": "ÇİÇEK GRUBU",
"data_type": "dropdown"
}
},
"extra_attributes": {},
"remote_modified_date": "2021-06-13T22:07:08.316236Z"
},
"created_date": "2021-06-21T14:10:22.034062Z",
"modified_date": "2021-06-21T14:10:22.034092Z",
"omnitron_id": 5909,
"net_amount": "100.00",
"price": "100.00",
"price_currency": "try",
"retail_price": "200.00",
"tax_rate": "18.00",
"tax_amount": null,
"discount_amount": "20.00",
"without_net_amount": null,
"installment_interest_amount": null,
"attributes": {},
"attributes_kwargs": {},
"image": null,
"price_list": {
"pk": 1,
"code": null,
"name": "Demo Price List",
"created_date": "2019-05-22T14:59:02.904438Z",
"is_auto_sync": false,
"modified_date": "2019-05-22T14:59:02.904461Z"
},
"stock_list": {
"pk": 1,
"code": null,
"name": "Demo Stock List",
"created_date": "2019-05-22T14:59:20.055271Z",
"is_auto_sync": false,
"modified_date": "2019-05-22T14:59:20.055292Z"
},
"extra_field": {
"price_extra_field": {},
"stock_extra_field": {}
},
"parent_omnitron_id": null,
"order": 4423
},
"transfer_order": null,
"denial_reason": null,
"created_date": "2022-10-05T14:07:53.518391Z",
"modified_date": "2022-10-06T06:49:28.109308Z",
"selected_barcode": null,
"serial_no": null,
"unit_weight": null,
"package": 162406
}
],
"order_number": "1690624566214332",
"channel_name": "E-Commerce",
"state": {
"id": 44,
"created_date": "2019-07-04T15:14:52.483388Z",
"modified_date": "2023-02-14T10:38:27.814213Z",
"translations": {
"en-us": {
"name": "Packaging Canceled"
},
"tr-tr": {
"name": "İptal Edildi"
}
},
"name": "İptal Edildi",
"config": {},
"enum_class": "PackageStatus",
"enum_value": "900",
"content_type": 25
},
"number": "1690624566214332P4",
"id": 162406,
"shipping_address": {
"id": 39,
"city": {
"pk": 2,
"name": "MILANO",
"country": 1,
"is_active": true,
"longitude": "38.27725920",
"latitude": "37.76365000"
},
"country": {
"pk": 1,
"name": "Italy",
"code": "it",
"is_active": true,
"longitude": "35.24332200",
"latitude": "38.96374500"
},
"township": {
"pk": 21,
"name": "20158 Milano MI",
"city": 2,
"is_active": true,
"longitude": "37.59607040",
"latitude": "37.77087630"
},
"district": {
"pk": 1605,
"name": "Lorem Ipsum",
"city": 2,
"township": 21,
"is_active": true,
"longitude": "37.69180000",
"latitude": "37.84640000"
},
"customer": {
"email": "example@mail.com",
"first_name": "John",
"last_name": "Doe",
"phone_number": "+90 555XXX0000",
"erp_code": null,
"pk": 335,
"channel": 1
},
"address_type": "customer",
"created_date": "2019-09-19T07:32:47.514656Z",
"modified_date": "2021-06-29T12:16:02.586289Z",
"omnitron_id": 34,
"mapping": null,
"title": "dolor sit amet",
"is_active": true,
"line": "Viale Edoardo Jenner",
"postcode": "11111",
"notes": null,
"email": "example@mail.com",
"phone_number": "+90 555XXX0000",
"first_name": "John",
"last_name": "Doe",
"company_name": "",
"tax_office": "",
"tax_no": "",
"e_bill_taxpayer": false
},
"order_id": 4423,
"stock_location": {
"id": 5,
"name": "Beşiktaş Istanbul Mağaza B (Demo)",
"erp_code": "S0001",
"address": {
"line": "Viale Edoardo Jenner",
"city": {
"id": 40,
"name": "MILANO"
}
}
},
"commands": [],
"shipment": null,
"shipping_label": null,
"is_click_and_collect": false,
"shipment_date": null,
"extra_information": {
"parent_package": {
"id": 162404,
"number": "1690624566214332P3"
},
"distance_to_shipping_address": 824
},
"delivery_type": null,
"omnitron_order_id": 106640
}
Response Description:
Only the required parameters on the OMS Packaging Order Detail page are transmitted in the message body.
GET Package State Transition Log List
Returns the list of transition logs for the package with pk (ID).
Path: /api/v1/oms/packages/pk/transition_logs/
Request
- Headers: -
- Authorization: Token
- Body Parameters: None
- Request Body: None
Response (200 OK)
{
"count": 1,
"next": null,
"previous": null,
"results": [
{
"id": 863135,
"old_state": {
"id": 33,
"name": "Waiting",
"enum_value": "100",
"enum_class": "PackageStatus"
},
"new_state": {
"id": 44,
"name": "Packaging Canceled",
"enum_value": "900",
"enum_class": "PackageStatus"
},
"user": null,
"attributes": {},
"created_date": "2022-10-06T06:49:28.100876Z",
"object_id": 162406,
"content_type": 25
}
]
}
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 Package State Transition Log Short List
Returns less detailed list of transition logs. The object_id and content_type are omitted when compared to the Package State Transition Log List.
Path: /api/v1/oms/packages/pk/transition_logs/short/
Request
- Headers: -
- Authorization: Token
- Body Parameters: None
- Request Body: None
Response (200 OK)
{
"count": 1,
"next": null,
"previous": null,
"results": [
{
"id": 863135,
"old_state": {
"id": 33,
"name": "Waiting",
"enum_value": "100",
"enum_class": "PackageStatus"
},
"new_state": {
"id": 44,
"name": "Packaging Canceled",
"enum_value": "900",
"enum_class": "PackageStatus"
},
"user": null,
"attributes": {},
"created_date": "2022-10-06T06:49:28.100876Z"
}
]
}
Response Description:
Only the required parameters on the OMS Package Detail page transition logs are transmitted in the message body.
GET Package State Transition Log Detail
Returns details of a single state transition log with thelog_id of the package specified with the pk (ID).
Path: /api/v1/oms/packages/pk/transition_logs/log_id/
Request
- Headers: -
- Authorization: Token
- Body Parameters: None
- Request Body: None
Response (200 OK)
{
"id": 863135,
"old_state": {
"id": 33,
"name": "Waiting",
"enum_value": "100",
"enum_class": "PackageStatus"
},
"new_state": {
"id": 44,
"name": "Packaging Canceled",
"enum_value": "900",
"enum_class": "PackageStatus"
},
"user": null,
"attributes": {},
"created_date": "2022-10-06T06:49:28.100876Z",
"object_id": 162406,
"content_type": 25
}
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 Package State Transition Log Short Detail
Returns less detailed information of transition logs. The object_id and content_type are omitted when compared to the Package State Transition Log Detail.
Path: /api/v1/oms/packages/pk/transition_logs/short/log_id/
Request
- Headers: -
- Authorization: Token
- Body Parameters: None
- Request Body: None
Response (200 OK)
{
"id": 863135,
"old_state": {
"id": 33,
"name": "Waiting",
"enum_value": "100",
"enum_class": "PackageStatus"
},
"new_state": {
"id": 44,
"name": "Packaging Canceled",
"enum_value": "900",
"enum_class": "PackageStatus"
},
"user": null,
"attributes": {},
"created_date": "2022-10-06T06:49:28.100876Z"
}
Response Description:
Only the required parameters on the OMS Package State Transition Log page are transmitted in the message body.
GET Package Webhook Event List
Returns the list of webhook events of the package specified with the pk (ID).
Path: /api/v1/oms/packages/pk/webhook_events/
Request
- Headers: -
- Authorization: Token
- Body Parameters: None
- Request Body: None
Response (200 OK)
{
"count": 2,
"next": null,
"previous": null,
"results": [
{
"id": 3113,
"webhook": {
"id": 67,
"retry_countdown_config": {
"choice": "exponential",
"kwargs": {
"base": 2,
"factor": 1
}
},
"created_date": "2020-08-21T11:03:38.463786Z",
"modified_date": "2022-04-23T13:11:56.314897Z",
"target_url": "{domain_url}",
"is_active": true,
"secret_key": "",
"event_type": "package.created",
"callback": "",
"additional_headers": {},
"config": {}
},
"created_date": "2022-10-05T14:07:53.785643Z",
"modified_date": "2022-10-08T15:00:00.067697Z",
"uuid": "7181da21-dcc8-4921-a1f1-3740fb51b73e",
"request_payload": {
"event": {
"type": "package.created",
"uuid": "7181da21dcc84921a1f13740fb51b73e"
},
"payload": {
"id": 162406,
"city": "MILANO",
"state": {
"id": 33,
"name": "Bekliyor",
"config": {},
"enum_class": "PackageStatus",
"enum_value": "100",
"content_type": 25,
"created_date": "2019-07-04T15:14:52.354690Z",
"translations": {
"en-us": {
"name": "Waiting"
},
"tr-tr": {
"name": "Bekliyor"
}
},
"modified_date": "2022-05-26T13:20:05.613791Z"
},
"number": "1690624566214332P4",
"commands": [
{
"id": 1512,
"label": "Refuse Package",
"command": "REFUSE_PACKAGE",
"source_state": 33,
"translations": null,
"configuration": {},
"ui_visibility": [
"oms_web"
],
"destination_state": 85,
"is_packageitem_parameter_required": false
},
{
"id": 1313,
"label": "ipsum",
"command": "PREPARE_PACKAGE_COMMAND",
"source_state": 33,
"translations": {
"en-us": {
"label": "lorem"
},
"tr-tr": {
"label": "lorem"
}
},
"configuration": {},
"ui_visibility": [
"oms_web"
],
"destination_state": 34,
"is_packageitem_parameter_required": false
},
{
"id": 1346,
"label": "Test Yeni",
"command": "PKG_STATE_TRANSITION",
"source_state": 33,
"translations": null,
"configuration": {},
"ui_visibility": [
"oms_web",
"instore"
],
"destination_state": 142,
"is_packageitem_parameter_required": false
},
{
"id": 1049,
"label": "hazırla",
"command": "PKG_STATE_TRANSITION",
"source_state": 33,
"translations": {
"en-us": {
"label": "preparing"
},
"tr-tr": {
"label": "hazırla"
}
},
"configuration": {},
"ui_visibility": [
"oms_web"
],
"destination_state": 34,
"is_packageitem_parameter_required": false
},
{
"id": 125,
"label": "Ürün Bulunamadı / Hatalı Ürün",
"command": "DETECTED_OUT_OF_STOCK_ITEM",
"source_state": 33,
"translations": null,
"configuration": {},
"ui_visibility": [
"oms_web",
"instore",
"third_party"
],
"destination_state": 46,
"is_packageitem_parameter_required": true
},
{
"id": 786,
"label": "kargolamadan paketle",
"command": "COMPLETE_PACKAGING_WITHOUT_SHIPMENT",
"source_state": 33,
"translations": null,
"configuration": {},
"ui_visibility": [
"oms_web",
"instore",
"third_party"
],
"destination_state": 37,
"is_packageitem_parameter_required": false
},
{
"id": 2,
"label": "Paketle",
"command": "COMPLETE_PACKAGING",
"source_state": 33,
"translations": null,
"configuration": {},
"ui_visibility": [
"oms_web",
"instore",
"third_party"
],
"destination_state": 37,
"is_packageitem_parameter_required": false
},
{
"id": 917,
"label": "Paketle (Marketplace)",
"command": "CHANNEL_BASED_COMPLETE_PACKAGING",
"source_state": 33,
"translations": null,
"configuration": {},
"ui_visibility": [
"oms_web",
"third_party",
"instore"
],
"destination_state": 37,
"is_packageitem_parameter_required": false
},
{
"id": 1511,
"label": "Assign package items manually",
"command": "ASSIGN_PACKAGE_ITEMS_MANUALLY",
"source_state": 33,
"translations": null,
"configuration": {},
"ui_visibility": [
"oms_web"
],
"destination_state": 44,
"is_packageitem_parameter_required": false
}
],
"order_id": 4423,
"shipment": null,
"remote_id": null,
"date_placed": "2021-06-21T14:07:59.205955Z",
"order_notes": null,
"channel_name": "E-Commerce",
"created_date": "2022-10-05T14:07:53.514014Z",
"order_number": "1690624566214332",
"payment_type": "credit_card",
"delivery_type": null,
"modified_date": "2022-10-05T14:07:53.568956Z",
"shipment_date": null,
"delivery_range": null,
"invoice_number": null,
"shipping_label": null,
"stock_location": {
"id": 5,
"conf": {},
"name": "Beşiktaş Istanbul Mağaza B (Demo)",
"tags": [],
"email": "",
"engine": 605,
"address": {
"id": 5,
"city": {
"pk": 40,
"name": "MILANO",
"country": 1,
"latitude": "41.00823760",
"is_active": true,
"longitude": "28.97835890"
},
"line": "Viale Edoardo Jenner",
"notes": null,
"title": "dolor sit amet",
"country": {
"pk": 1,
"code": "it",
"name": "Italy",
"latitude": "38.96374500",
"is_active": true,
"longitude": "35.24332200"
},
"mapping": null,
"district": {
"pk": 36194,
"city": 40,
"name": "Lorem Ipsum",
"latitude": "41.05397030",
"township": 477,
"is_active": true,
"longitude": "29.02708060"
},
"latitude": "41.05244600",
"postcode": null,
"township": {
"pk": 477,
"city": 40,
"name": "20158 Milano MI",
"latitude": "41.04220660",
"is_active": true,
"longitude": "29.00670370"
},
"is_active": true,
"longitude": "29.02982600"
},
"erp_code": "S0001",
"priority": 1,
"is_active": true,
"fax_number": "",
"omnitron_id": null,
"created_date": "2019-07-04T15:14:51.039101Z",
"daytime_phone": "",
"evening_phone": "",
"modified_date": "2021-06-03T11:41:21.258018Z",
"is_pickup_location": false,
"is_return_available": false,
"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": true
},
"packageitem_set": [
{
"id": 277270,
"state": {
"id": 47,
"name": "Bekliyor",
"config": {},
"enum_class": "PackageItemStatus",
"enum_value": "100",
"content_type": 26,
"created_date": "2019-07-04T15:14:52.508854Z",
"translations": {
"en-us": {
"name": "Waiting"
},
"tr-tr": {
"name": "Bekliyor"
}
},
"modified_date": "2022-05-26T13:20:05.547034Z"
},
"package": 162406,
"serial_no": null,
"order_item": {
"id": 3609,
"image": null,
"order": 4423,
"price": "100.00",
"state": {
"id": 22,
"name": "Onaylanmış",
"config": {},
"enum_class": "OrderStatus",
"enum_value": "400",
"content_type": 20,
"created_date": "2019-07-04T15:14:51.986693Z",
"translations": {
"en-us": {
"name": "Approved"
},
"tr-tr": {
"name": "Onaylanmış"
}
},
"modified_date": "2022-05-26T13:20:05.670181Z"
},
"product": {
"id": 84,
"sku": "1185177001",
"name": "YAPAY SUKULENT CAM TERARYUM 8 CM",
"barcode": null,
"base_code": "1185177",
"attributes": {
"renk": "RENKSİZ",
"beden": "Standart",
"ebat_en": "8.0",
"erp_Msb": "False",
"erp_Yil": "2017",
"cinsiyet": "Genel",
"ebat_boy": "8.0",
"erp_Beden": "000",
"erp_Sezon": "Devamlı",
"erp_EbatEn": "8.0",
"erp_Outlet": "False",
"erp_AnaRenk": "X",
"erp_EbatBoy": "8.0",
"ebat_agirlik": "0.0",
"erp_AsilRenk": "RENKSİZ",
"erp_Cinsiyet": "Genel",
"variant_renk": "RENKSİZ",
"erp_AnaMalTip": "0",
"erp_VaryantNo": "1185177-000",
"ebat_yukseklik": "1.0",
"erp_MalGrupAdi": "CONCEPT",
"erp_UretimYeri": "TÜRKİYE",
"erp_EbatAgirlik": "0.0",
"erp_MalDetayAdi": "SAKSILI ÇİÇEK",
"erp_MalSinifAdi": "BİTKİ GRUBU",
"integration_Msb": "False",
"integration_Yil": "2017",
"erp_EbatYukseklik": "1.0",
"erp_MalAltGrupAdi": "DEKORATIF",
"integration_Beden": "000",
"integration_Sezon": "Devamlı",
"erp_MalAltSinifAdi": "ÇİÇEK GRUBU",
"integration_EbatEn": "8.0",
"integration_Outlet": "False",
"erp_AciklayiciBilgi": "<p> </p><p>En: 8</p><p>Boy: 8</p><p>Yükseklik: 1</p><p>Menşei: TÜRKİYE</p>",
"integration_AnaRenk": "X",
"integration_EbatBoy": "8.0",
"integration_AsilRenk": "RENKSİZ",
"integration_Cinsiyet": "Genel",
"integration_AnaMalTip": "0",
"integration_VaryantNo": "1185177-000",
"integration_MalGrupAdi": "CONCEPT",
"integration_UretimYeri": "TÜRKİYE",
"integration_EbatAgirlik": "0.0",
"integration_MalDetayAdi": "SAKSILI ÇİÇEK",
"integration_MalSinifAdi": "BİTKİ GRUBU",
"integration_EbatYukseklik": "1.0",
"integration_MalAltGrupAdi": "DEKORATIF",
"integration_MalAltSinifAdi": "ÇİÇEK GRUBU",
"integration_AciklayiciBilgi": "<p> </p><p>En: 8</p><p>Boy: 8</p><p>Yükseklik: 1</p><p>Menşei: TÜRKİYE</p>"
},
"omnitron_id": 68,
"created_date": "2020-02-14T14:28:13.795823Z",
"modified_date": "2021-06-21T14:10:21.572603Z",
"extra_attributes": {},
"productimage_set": [
{
"id": 1134,
"url": "{cdn_url}/products/2019/03/17/68/9c7bd616-98f6-499c-b58f-c7f56f042180.jpg",
"order": 11,
"product": 84
},
{
"id": 1135,
"url": "{cdn_url}/products/2019/03/17/68/04936e2c-050a-4a15-abc8-58b16cfc3d73.jpg",
"order": 42,
"product": 84
},
{
"id": 1136,
"url": "{cdn_url}/products/2019/03/17/68/18742616-b244-46fd-a51c-05de483f3866.jpg",
"order": 63,
"product": 84
}
],
"attributes_kwargs": {
"renk": {
"label": "RENKSİZ",
"value": "RENKSİZ",
"data_type": "dropdown"
},
"beden": {
"label": "Standart",
"value": "Standart",
"data_type": "dropdown"
},
"erp_Msb": {
"label": "False",
"value": "False",
"data_type": "dropdown"
},
"cinsiyet": {
"label": "Genel",
"value": "Genel",
"data_type": "dropdown"
},
"erp_Beden": {
"label": "000",
"value": "000",
"data_type": "dropdown"
},
"erp_Outlet": {
"label": "False",
"value": "False",
"data_type": "dropdown"
},
"erp_AnaRenk": {
"label": "X",
"value": "X",
"data_type": "dropdown"
},
"erp_AsilRenk": {
"label": "RENKSİZ",
"value": "RENKSİZ",
"data_type": "dropdown"
},
"erp_Cinsiyet": {
"label": "Genel",
"value": "Genel",
"data_type": "dropdown"
},
"variant_renk": {
"label": "RENKSİZ",
"value": "RENKSİZ",
"data_type": "dropdown"
},
"erp_AnaMalTip": {
"label": "0",
"value": "0",
"data_type": "dropdown"
},
"erp_MalGrupAdi": {
"label": "CONCEPT",
"value": "CONCEPT",
"data_type": "dropdown"
},
"erp_UretimYeri": {
"label": "TÜRKİYE",
"value": "TÜRKİYE",
"data_type": "dropdown"
},
"erp_MalDetayAdi": {
"label": "SAKSILI ÇİÇEK",
"value": "SAKSILI ÇİÇEK",
"data_type": "dropdown"
},
"erp_MalSinifAdi": {
"label": "BİTKİ GRUBU",
"value": "BİTKİ GRUBU",
"data_type": "dropdown"
},
"erp_MalAltGrupAdi": {
"label": "DEKORATIF",
"value": "DEKORATIF",
"data_type": "dropdown"
},
"erp_MalAltSinifAdi": {
"label": "ÇİÇEK GRUBU",
"value": "ÇİÇEK GRUBU",
"data_type": "dropdown"
}
},
"remote_modified_date": "2021-06-13T22:07:08.316236Z"
},
"tax_rate": "18.00",
"attributes": {},
"net_amount": "100.00",
"price_list": {
"pk": 1,
"code": null,
"name": "Demo Price List",
"created_date": "2019-05-22T14:59:02.904438Z",
"is_auto_sync": false,
"modified_date": "2019-05-22T14:59:02.904461Z"
},
"stock_list": {
"pk": 1,
"code": null,
"name": "Demo Stock List",
"created_date": "2019-05-22T14:59:20.055271Z",
"is_auto_sync": false,
"modified_date": "2019-05-22T14:59:20.055292Z"
},
"tax_amount": null,
"extra_field": {
"price_extra_field": {},
"stock_extra_field": {}
},
"omnitron_id": 5909,
"created_date": "2021-06-21T14:10:22.034062Z",
"retail_price": "200.00",
"modified_date": "2021-06-21T14:10:22.034092Z",
"price_currency": "try",
"discount_amount": "20.00",
"attributes_kwargs": {},
"parent_omnitron_id": null,
"without_net_amount": null,
"installment_interest_amount": null
},
"unit_weight": null,
"created_date": "2022-10-05T14:07:53.518391Z",
"denial_reason": null,
"modified_date": "2022-10-05T14:07:53.518407Z",
"transfer_order": null,
"selected_barcode": null,
"discrepancy_reason": null
}
],
"tracking_number": null,
"shipping_address": {
"id": 39,
"city": {
"pk": 2,
"name": "MILANO",
"country": 1,
"latitude": "37.76365000",
"is_active": true,
"longitude": "38.27725920"
},
"line": "Viale Edoardo Jenner",
"email": "example@mail.com",
"notes": null,
"title": "dolor sit amet",
"tax_no": "",
"country": {
"pk": 1,
"code": "it",
"name": "Italy",
"latitude": "38.96374500",
"is_active": true,
"longitude": "35.24332200"
},
"mapping": null,
"customer": {
"pk": 335,
"email": "example@mail.com",
"channel": 1,
"erp_code": null,
"last_name": "Doe",
"first_name": "John",
"phone_number": "+90 555XXX0000"
},
"district": {
"pk": 1605,
"city": 2,
"name": "Lorem Ipsum",
"latitude": "37.84640000",
"township": 21,
"is_active": true,
"longitude": "37.69180000"
},
"postcode": "11111",
"township": {
"pk": 21,
"city": 2,
"name": "20158 Milano MI",
"latitude": "37.77087630",
"is_active": true,
"longitude": "37.59607040"
},
"is_active": true,
"last_name": "Doe",
"first_name": "John",
"tax_office": "",
"omnitron_id": 34,
"address_type": "customer",
"company_name": "",
"created_date": "2019-09-19T07:32:47.514656Z",
"phone_number": "+90 555XXX0000",
"modified_date": "2021-06-29T12:16:02.586289Z",
"e_bill_taxpayer": false
},
"extra_information": {
"parent_package": {
"id": 162404,
"number": "1690624566214332P3"
},
"distance_to_shipping_address": 824
},
"omnitron_order_id": 106640,
"order_has_gift_box": false,
"channel_omnitron_id": 1,
"order_gift_box_note": null,
"target_packing_date": "2021-06-26T14:07:59.205955Z",
"is_click_and_collect": false,
"order_retail_store_id": null
}
},
"response_content": "b'<html>\\r\\n<head><title>405 Not Allowed</title></head>\\r\\n<body bgcolor=\"white\">\\r\\n<center><h1>405 Not Allowed</h1></center>\\r\\n<hr><center>nginx</center>\\r\\n</body>\\r\\n</html>\\r\\n'",
"response_http_status": 405,
"delivered": false,
"request_datetimes": [
"2022-10-08T15:00:00.036481Z",
"2022-10-07T02:45:00.042397Z",
"2022-10-06T08:30:00.064332Z",
"2022-10-05T23:15:00.028042Z",
"2022-10-05T18:45:00.038698Z",
"2022-10-05T16:30:00.050483Z",
"2022-10-05T15:30:00.051336Z",
"2022-10-05T14:45:00.036220Z",
"2022-10-05T14:25:01.734838Z",
"2022-10-05T14:16:28.934978Z",
"2022-10-05T14:12:12.714984Z",
"2022-10-05T14:10:03.844798Z",
"2022-10-05T14:08:59.494742Z",
"2022-10-05T14:08:27.320826Z",
"2022-10-05T14:08:11.286489Z",
"2022-10-05T14:08:02.854894Z",
"2022-10-05T14:07:58.045821Z",
"2022-10-05T14:07:54.843321Z",
"2022-10-05T14:07:53.749194Z"
],
"retry_count": 19,
"object_id": 162406,
"content_type": 25
},
{
"id": 3114,
"webhook": {
"id": 68,
"retry_countdown_config": {
"choice": "exponential",
"kwargs": {
"base": 2,
"factor": 1
}
},
"created_date": "2020-08-21T11:03:57.180663Z",
"modified_date": "2022-04-28T10:02:08.916776Z",
"target_url": "https://postb.in/1598007567170-1180096510797",
"is_active": true,
"secret_key": "",
"event_type": "package.created",
"callback": "{}",
"additional_headers": {},
"config": {}
},
"created_date": "2022-10-05T14:07:54.403433Z",
"modified_date": "2022-10-05T14:07:54.403455Z",
"uuid": "c56f92db-230e-45b6-b3e1-13ba79fdccff",
"request_payload": {
"event": {
"type": "package.created",
"uuid": "c56f92db230e45b6b3e113ba79fdccff"
},
"payload": {
"id": 162406,
"city": "MILANO",
"state": {
"id": 33,
"name": "Bekliyor",
"config": {},
"enum_class": "PackageStatus",
"enum_value": "100",
"content_type": 25,
"created_date": "2019-07-04T15:14:52.354690Z",
"translations": {
"en-us": {
"name": "Waiting"
},
"tr-tr": {
"name": "Bekliyor"
}
},
"modified_date": "2022-05-26T13:20:05.613791Z"
},
"number": "1690624566214332P4",
"commands": [
{
"id": 1512,
"label": "Refuse Package",
"command": "REFUSE_PACKAGE",
"source_state": 33,
"translations": null,
"configuration": {},
"ui_visibility": [
"oms_web"
],
"destination_state": 85,
"is_packageitem_parameter_required": false
},
{
"id": 1313,
"label": "ipsum",
"command": "PREPARE_PACKAGE_COMMAND",
"source_state": 33,
"translations": {
"en-us": {
"label": "lorem"
},
"tr-tr": {
"label": "lorem"
}
},
"configuration": {},
"ui_visibility": [
"oms_web"
],
"destination_state": 34,
"is_packageitem_parameter_required": false
},
{
"id": 1346,
"label": "Test Yeni",
"command": "PKG_STATE_TRANSITION",
"source_state": 33,
"translations": null,
"configuration": {},
"ui_visibility": [
"oms_web",
"instore"
],
"destination_state": 142,
"is_packageitem_parameter_required": false
},
{
"id": 1049,
"label": "hazırla",
"command": "PKG_STATE_TRANSITION",
"source_state": 33,
"translations": {
"en-us": {
"label": "preparing"
},
"tr-tr": {
"label": "hazırla"
}
},
"configuration": {},
"ui_visibility": [
"oms_web"
],
"destination_state": 34,
"is_packageitem_parameter_required": false
},
{
"id": 125,
"label": "Ürün Bulunamadı / Hatalı Ürün",
"command": "DETECTED_OUT_OF_STOCK_ITEM",
"source_state": 33,
"translations": null,
"configuration": {},
"ui_visibility": [
"oms_web",
"instore",
"third_party"
],
"destination_state": 46,
"is_packageitem_parameter_required": true
},
{
"id": 786,
"label": "kargolamadan paketle",
"command": "COMPLETE_PACKAGING_WITHOUT_SHIPMENT",
"source_state": 33,
"translations": null,
"configuration": {},
"ui_visibility": [
"oms_web",
"instore",
"third_party"
],
"destination_state": 37,
"is_packageitem_parameter_required": false
},
{
"id": 2,
"label": "Paketle",
"command": "COMPLETE_PACKAGING",
"source_state": 33,
"translations": null,
"configuration": {},
"ui_visibility": [
"oms_web",
"instore",
"third_party"
],
"destination_state": 37,
"is_packageitem_parameter_required": false
},
{
"id": 917,
"label": "Paketle (Marketplace)",
"command": "CHANNEL_BASED_COMPLETE_PACKAGING",
"source_state": 33,
"translations": null,
"configuration": {},
"ui_visibility": [
"oms_web",
"third_party",
"instore"
],
"destination_state": 37,
"is_packageitem_parameter_required": false
},
{
"id": 1511,
"label": "Assign package items manually",
"command": "ASSIGN_PACKAGE_ITEMS_MANUALLY",
"source_state": 33,
"translations": null,
"configuration": {},
"ui_visibility": [
"oms_web"
],
"destination_state": 44,
"is_packageitem_parameter_required": false
}
],
"order_id": 4423,
"shipment": null,
"remote_id": null,
"date_placed": "2021-06-21T14:07:59.205955Z",
"order_notes": null,
"channel_name": "E-Commerce",
"created_date": "2022-10-05T14:07:53.514014Z",
"order_number": "1690624566214332",
"payment_type": "credit_card",
"delivery_type": null,
"modified_date": "2022-10-05T14:07:53.568956Z",
"shipment_date": null,
"delivery_range": null,
"invoice_number": null,
"shipping_label": null,
"stock_location": {
"id": 5,
"conf": {},
"name": "Beşiktaş Istanbul Mağaza B (Demo)",
"tags": [],
"email": "",
"engine": 605,
"address": {
"id": 5,
"city": {
"pk": 40,
"name": "MILANO",
"country": 1,
"latitude": "41.00823760",
"is_active": true,
"longitude": "28.97835890"
},
"line": "Viale Edoardo Jenner",
"notes": null,
"title": "dolor sit amet",
"country": {
"pk": 1,
"code": "it",
"name": "Italy",
"latitude": "38.96374500",
"is_active": true,
"longitude": "35.24332200"
},
"mapping": null,
"district": {
"pk": 36194,
"city": 40,
"name": "Lorem Ipsum",
"latitude": "41.05397030",
"township": 477,
"is_active": true,
"longitude": "29.02708060"
},
"latitude": "41.05244600",
"postcode": null,
"township": {
"pk": 477,
"city": 40,
"name": "20158 Milano MI",
"latitude": "41.04220660",
"is_active": true,
"longitude": "29.00670370"
},
"is_active": true,
"longitude": "29.02982600"
},
"erp_code": "S0001",
"priority": 1,
"is_active": true,
"fax_number": "",
"omnitron_id": null,
"created_date": "2019-07-04T15:14:51.039101Z",
"daytime_phone": "",
"evening_phone": "",
"modified_date": "2021-06-03T11:41:21.258018Z",
"is_pickup_location": false,
"is_return_available": false,
"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": true
},
"packageitem_set": [
{
"id": 277270,
"state": {
"id": 47,
"name": "Bekliyor",
"config": {},
"enum_class": "PackageItemStatus",
"enum_value": "100",
"content_type": 26,
"created_date": "2019-07-04T15:14:52.508854Z",
"translations": {
"en-us": {
"name": "Waiting"
},
"tr-tr": {
"name": "Bekliyor"
}
},
"modified_date": "2022-05-26T13:20:05.547034Z"
},
"package": 162406,
"serial_no": null,
"order_item": {
"id": 3609,
"image": null,
"order": 4423,
"price": "100.00",
"state": {
"id": 22,
"name": "Onaylanmış",
"config": {},
"enum_class": "OrderStatus",
"enum_value": "400",
"content_type": 20,
"created_date": "2019-07-04T15:14:51.986693Z",
"translations": {
"en-us": {
"name": "Approved"
},
"tr-tr": {
"name": "Onaylanmış"
}
},
"modified_date": "2022-05-26T13:20:05.670181Z"
},
"product": {
"id": 84,
"sku": "1185177001",
"name": "YAPAY SUKULENT CAM TERARYUM 8 CM",
"barcode": null,
"base_code": "1185177",
"attributes": {
"renk": "RENKSİZ",
"beden": "Standart",
"ebat_en": "8.0",
"erp_Msb": "False",
"erp_Yil": "2017",
"cinsiyet": "Genel",
"ebat_boy": "8.0",
"erp_Beden": "000",
"erp_Sezon": "Devamlı",
"erp_EbatEn": "8.0",
"erp_Outlet": "False",
"erp_AnaRenk": "X",
"erp_EbatBoy": "8.0",
"ebat_agirlik": "0.0",
"erp_AsilRenk": "RENKSİZ",
"erp_Cinsiyet": "Genel",
"variant_renk": "RENKSİZ",
"erp_AnaMalTip": "0",
"erp_VaryantNo": "1185177-000",
"ebat_yukseklik": "1.0",
"erp_MalGrupAdi": "CONCEPT",
"erp_UretimYeri": "TÜRKİYE",
"erp_EbatAgirlik": "0.0",
"erp_MalDetayAdi": "SAKSILI ÇİÇEK",
"erp_MalSinifAdi": "BİTKİ GRUBU",
"integration_Msb": "False",
"integration_Yil": "2017",
"erp_EbatYukseklik": "1.0",
"erp_MalAltGrupAdi": "DEKORATIF",
"integration_Beden": "000",
"integration_Sezon": "Devamlı",
"erp_MalAltSinifAdi": "ÇİÇEK GRUBU",
"integration_EbatEn": "8.0",
"integration_Outlet": "False",
"erp_AciklayiciBilgi": "<p> </p><p>En: 8</p><p>Boy: 8</p><p>Yükseklik: 1</p><p>Menşei: TÜRKİYE</p>",
"integration_AnaRenk": "X",
"integration_EbatBoy": "8.0",
"integration_AsilRenk": "RENKSİZ",
"integration_Cinsiyet": "Genel",
"integration_AnaMalTip": "0",
"integration_VaryantNo": "1185177-000",
"integration_MalGrupAdi": "CONCEPT",
"integration_UretimYeri": "TÜRKİYE",
"integration_EbatAgirlik": "0.0",
"integration_MalDetayAdi": "SAKSILI ÇİÇEK",
"integration_MalSinifAdi": "BİTKİ GRUBU",
"integration_EbatYukseklik": "1.0",
"integration_MalAltGrupAdi": "DEKORATIF",
"integration_MalAltSinifAdi": "ÇİÇEK GRUBU",
"integration_AciklayiciBilgi": "<p> </p><p>En: 8</p><p>Boy: 8</p><p>Yükseklik: 1</p><p>Menşei: TÜRKİYE</p>"
},
"omnitron_id": 68,
"created_date": "2020-02-14T14:28:13.795823Z",
"modified_date": "2021-06-21T14:10:21.572603Z",
"extra_attributes": {},
"productimage_set": [
{
"id": 1134,
"url": "{cdn_url}/products/2019/03/17/68/9c7bd616-98f6-499c-b58f-c7f56f042180.jpg",
"order": 11,
"product": 84
},
{
"id": 1135,
"url": "{cdn_url}/products/2019/03/17/68/04936e2c-050a-4a15-abc8-58b16cfc3d73.jpg",
"order": 42,
"product": 84
},
{
"id": 1136,
"url": "{cdn_url}/products/2019/03/17/68/18742616-b244-46fd-a51c-05de483f3866.jpg",
"order": 63,
"product": 84
}
],
"attributes_kwargs": {
"renk": {
"label": "RENKSİZ",
"value": "RENKSİZ",
"data_type": "dropdown"
},
"beden": {
"label": "Standart",
"value": "Standart",
"data_type": "dropdown"
},
"erp_Msb": {
"label": "False",
"value": "False",
"data_type": "dropdown"
},
"cinsiyet": {
"label": "Genel",
"value": "Genel",
"data_type": "dropdown"
},
"erp_Beden": {
"label": "000",
"value": "000",
"data_type": "dropdown"
},
"erp_Outlet": {
"label": "False",
"value": "False",
"data_type": "dropdown"
},
"erp_AnaRenk": {
"label": "X",
"value": "X",
"data_type": "dropdown"
},
"erp_AsilRenk": {
"label": "RENKSİZ",
"value": "RENKSİZ",
"data_type": "dropdown"
},
"erp_Cinsiyet": {
"label": "Genel",
"value": "Genel",
"data_type": "dropdown"
},
"variant_renk": {
"label": "RENKSİZ",
"value": "RENKSİZ",
"data_type": "dropdown"
},
"erp_AnaMalTip": {
"label": "0",
"value": "0",
"data_type": "dropdown"
},
"erp_MalGrupAdi": {
"label": "CONCEPT",
"value": "CONCEPT",
"data_type": "dropdown"
},
"erp_UretimYeri": {
"label": "TÜRKİYE",
"value": "TÜRKİYE",
"data_type": "dropdown"
},
"erp_MalDetayAdi": {
"label": "SAKSILI ÇİÇEK",
"value": "SAKSILI ÇİÇEK",
"data_type": "dropdown"
},
"erp_MalSinifAdi": {
"label": "BİTKİ GRUBU",
"value": "BİTKİ GRUBU",
"data_type": "dropdown"
},
"erp_MalAltGrupAdi": {
"label": "DEKORATIF",
"value": "DEKORATIF",
"data_type": "dropdown"
},
"erp_MalAltSinifAdi": {
"label": "ÇİÇEK GRUBU",
"value": "ÇİÇEK GRUBU",
"data_type": "dropdown"
}
},
"remote_modified_date": "2021-06-13T22:07:08.316236Z"
},
"tax_rate": "18.00",
"attributes": {},
"net_amount": "100.00",
"price_list": {
"pk": 1,
"code": null,
"name": "Demo Price List",
"created_date": "2019-05-22T14:59:02.904438Z",
"is_auto_sync": false,
"modified_date": "2019-05-22T14:59:02.904461Z"
},
"stock_list": {
"pk": 1,
"code": null,
"name": "Demo Stock List",
"created_date": "2019-05-22T14:59:20.055271Z",
"is_auto_sync": false,
"modified_date": "2019-05-22T14:59:20.055292Z"
},
"tax_amount": null,
"extra_field": {
"price_extra_field": {},
"stock_extra_field": {}
},
"omnitron_id": 5909,
"created_date": "2021-06-21T14:10:22.034062Z",
"retail_price": "200.00",
"modified_date": "2021-06-21T14:10:22.034092Z",
"price_currency": "try",
"discount_amount": "20.00",
"attributes_kwargs": {},
"parent_omnitron_id": null,
"without_net_amount": null,
"installment_interest_amount": null
},
"unit_weight": null,
"created_date": "2022-10-05T14:07:53.518391Z",
"denial_reason": null,
"modified_date": "2022-10-05T14:07:53.518407Z",
"transfer_order": null,
"selected_barcode": null,
"discrepancy_reason": null
}
],
"tracking_number": null,
"shipping_address": {
"id": 39,
"city": {
"pk": 2,
"name": "MILANO",
"country": 1,
"latitude": "37.76365000",
"is_active": true,
"longitude": "38.27725920"
},
"line": "Viale Edoardo Jenner",
"email": "example@mail.com",
"notes": null,
"title": "dolor sit amet",
"tax_no": "",
"country": {
"pk": 1,
"code": "it",
"name": "Italy",
"latitude": "38.96374500",
"is_active": true,
"longitude": "35.24332200"
},
"mapping": null,
"customer": {
"pk": 335,
"email": "example@mail.com",
"channel": 1,
"erp_code": null,
"last_name": "Doe",
"first_name": "John",
"phone_number": "+90 555XXX0000"
},
"district": {
"pk": 1605,
"city": 2,
"name": "Lorem Ipsum",
"latitude": "37.84640000",
"township": 21,
"is_active": true,
"longitude": "37.69180000"
},
"postcode": "11111",
"township": {
"pk": 21,
"city": 2,
"name": "20158 Milano MI",
"latitude": "37.77087630",
"is_active": true,
"longitude": "37.59607040"
},
"is_active": true,
"last_name": "Doe",
"first_name": "John",
"tax_office": "",
"omnitron_id": 34,
"address_type": "customer",
"company_name": "",
"created_date": "2019-09-19T07:32:47.514656Z",
"phone_number": "+90 555XXX0000",
"modified_date": "2021-06-29T12:16:02.586289Z",
"e_bill_taxpayer": false
},
"extra_information": {
"parent_package": {
"id": 162404,
"number": "1690624566214332P3"
},
"distance_to_shipping_address": 824
},
"omnitron_order_id": 106640,
"order_has_gift_box": false,
"channel_omnitron_id": 1,
"order_gift_box_note": null,
"target_packing_date": "2021-06-26T14:07:59.205955Z",
"is_click_and_collect": false,
"order_retail_store_id": null
}
},
"response_content": "b'404 - Not Found\\n'",
"response_http_status": 404,
"delivered": false,
"request_datetimes": [
"2022-10-05T14:07:53.783539Z"
],
"retry_count": 1,
"object_id": 162406,
"content_type": 25
}
]
}
Response Description:
Detailed information about the webhook along with the entire payload is transmitted in the message body.
GET Package Webhook Event Short List
Returns less detailed list of webhook events belonging to the package specified with the pk (ID). Compared to Package Webhook Event List less information about the webhook is transmitted and payload is excluded from the response to reduce the size of the response.
Path: /api/v1/oms/packages/pk/webhook_events/short/
Request
- Headers: -
- Authorization: Token
- Body Parameters: None
- Request Body: None
Response (200 OK)
{
"count": 2,
"next": null,
"previous": null,
"results": [
{
"id": 3113,
"webhook": {
"id": 67,
"target_url": "{domain_url}",
"is_active": true,
"event_type": "package.created"
},
"created_date": "2022-10-05T14:07:53.785643Z",
"modified_date": "2022-10-08T15:00:00.067697Z",
"delivered": false
},
{
"id": 3114,
"webhook": {
"id": 68,
"target_url": "https://postb.in/1598007567170-1180096510797",
"is_active": true,
"event_type": "package.created"
},
"created_date": "2022-10-05T14:07:54.403433Z",
"modified_date": "2022-10-05T14:07:54.403455Z",
"delivered": false
}
]
}
Response Description:
Only the required parameters on the OMS Package Detail Webhook Events page are transmitted in the message body.
GET Package Webhook Event Details
Returns the details of a webhook event with the webhook_event_id of the package specified with the pk (ID).
Path: /api/v1/oms/packages/pk/webhook_events/webhook_event_id/
Request
- Headers: -
- Authorization: Token
- Body Parameters: None
- Request Body: None
Response (200 OK)
{
"id": 3113,
"webhook": {
"id": 67,
"retry_countdown_config": {
"choice": "exponential",
"kwargs": {
"base": 2,
"factor": 1
}
},
"created_date": "2020-08-21T11:03:38.463786Z",
"modified_date": "2022-04-23T13:11:56.314897Z",
"target_url": "{domain_url}",
"is_active": true,
"secret_key": "",
"event_type": "package.created",
"callback": "",
"additional_headers": {},
"config": {}
},
"created_date": "2022-10-05T14:07:53.785643Z",
"modified_date": "2022-10-08T15:00:00.067697Z",
"uuid": "7181da21-dcc8-4921-a1f1-3740fb51b73e",
"request_payload": {
"event": {
"type": "package.created",
"uuid": "7181da21dcc84921a1f13740fb51b73e"
},
"payload": {
"id": 162406,
"city": "MILANO",
"state": {
"id": 33,
"name": "Bekliyor",
"config": {},
"enum_class": "PackageStatus",
"enum_value": "100",
"content_type": 25,
"created_date": "2019-07-04T15:14:52.354690Z",
"translations": {
"en-us": {
"name": "Waiting"
},
"tr-tr": {
"name": "Bekliyor"
}
},
"modified_date": "2022-05-26T13:20:05.613791Z"
},
"number": "1690624566214332P4",
"commands": [
{
"id": 1512,
"label": "Refuse Package",
"command": "REFUSE_PACKAGE",
"source_state": 33,
"translations": null,
"configuration": {},
"ui_visibility": [
"oms_web"
],
"destination_state": 85,
"is_packageitem_parameter_required": false
},
{
"id": 1313,
"label": "ipsum",
"command": "PREPARE_PACKAGE_COMMAND",
"source_state": 33,
"translations": {
"en-us": {
"label": "lorem"
},
"tr-tr": {
"label": "lorem"
}
},
"configuration": {},
"ui_visibility": [
"oms_web"
],
"destination_state": 34,
"is_packageitem_parameter_required": false
},
{
"id": 1346,
"label": "Test Yeni",
"command": "PKG_STATE_TRANSITION",
"source_state": 33,
"translations": null,
"configuration": {},
"ui_visibility": [
"oms_web",
"instore"
],
"destination_state": 142,
"is_packageitem_parameter_required": false
},
{
"id": 1049,
"label": "hazırla",
"command": "PKG_STATE_TRANSITION",
"source_state": 33,
"translations": {
"en-us": {
"label": "preparing"
},
"tr-tr": {
"label": "hazırla"
}
},
"configuration": {},
"ui_visibility": [
"oms_web"
],
"destination_state": 34,
"is_packageitem_parameter_required": false
},
{
"id": 125,
"label": "Ürün Bulunamadı / Hatalı Ürün",
"command": "DETECTED_OUT_OF_STOCK_ITEM",
"source_state": 33,
"translations": null,
"configuration": {},
"ui_visibility": [
"oms_web",
"instore",
"third_party"
],
"destination_state": 46,
"is_packageitem_parameter_required": true
},
{
"id": 786,
"label": "kargolamadan paketle",
"command": "COMPLETE_PACKAGING_WITHOUT_SHIPMENT",
"source_state": 33,
"translations": null,
"configuration": {},
"ui_visibility": [
"oms_web",
"instore",
"third_party"
],
"destination_state": 37,
"is_packageitem_parameter_required": false
},
{
"id": 2,
"label": "Paketle",
"command": "COMPLETE_PACKAGING",
"source_state": 33,
"translations": null,
"configuration": {},
"ui_visibility": [
"oms_web",
"instore",
"third_party"
],
"destination_state": 37,
"is_packageitem_parameter_required": false
},
{
"id": 917,
"label": "Paketle (Marketplace)",
"command": "CHANNEL_BASED_COMPLETE_PACKAGING",
"source_state": 33,
"translations": null,
"configuration": {},
"ui_visibility": [
"oms_web",
"third_party",
"instore"
],
"destination_state": 37,
"is_packageitem_parameter_required": false
},
{
"id": 1511,
"label": "Assign package items manually",
"command": "ASSIGN_PACKAGE_ITEMS_MANUALLY",
"source_state": 33,
"translations": null,
"configuration": {},
"ui_visibility": [
"oms_web"
],
"destination_state": 44,
"is_packageitem_parameter_required": false
}
],
"order_id": 4423,
"shipment": null,
"remote_id": null,
"date_placed": "2021-06-21T14:07:59.205955Z",
"order_notes": null,
"channel_name": "E-Commerce",
"created_date": "2022-10-05T14:07:53.514014Z",
"order_number": "1690624566214332",
"payment_type": "credit_card",
"delivery_type": null,
"modified_date": "2022-10-05T14:07:53.568956Z",
"shipment_date": null,
"delivery_range": null,
"invoice_number": null,
"shipping_label": null,
"stock_location": {
"id": 5,
"conf": {},
"name": "Beşiktaş Istanbul Mağaza B (Demo)",
"tags": [],
"email": "",
"engine": 605,
"address": {
"id": 5,
"city": {
"pk": 40,
"name": "MILANO",
"country": 1,
"latitude": "41.00823760",
"is_active": true,
"longitude": "28.97835890"
},
"line": "Viale Edoardo Jenner",
"notes": null,
"title": "dolor sit amet",
"country": {
"pk": 1,
"code": "it",
"name": "Italy",
"latitude": "38.96374500",
"is_active": true,
"longitude": "35.24332200"
},
"mapping": null,
"district": {
"pk": 36194,
"city": 40,
"name": "Lorem Ipsum",
"latitude": "41.05397030",
"township": 477,
"is_active": true,
"longitude": "29.02708060"
},
"latitude": "41.05244600",
"postcode": null,
"township": {
"pk": 477,
"city": 40,
"name": "20158 Milano MI",
"latitude": "41.04220660",
"is_active": true,
"longitude": "29.00670370"
},
"is_active": true,
"longitude": "29.02982600"
},
"erp_code": "S0001",
"priority": 1,
"is_active": true,
"fax_number": "",
"omnitron_id": null,
"created_date": "2019-07-04T15:14:51.039101Z",
"daytime_phone": "",
"evening_phone": "",
"modified_date": "2021-06-03T11:41:21.258018Z",
"is_pickup_location": false,
"is_return_available": false,
"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": true
},
"packageitem_set": [
{
"id": 277270,
"state": {
"id": 47,
"name": "Bekliyor",
"config": {},
"enum_class": "PackageItemStatus",
"enum_value": "100",
"content_type": 26,
"created_date": "2019-07-04T15:14:52.508854Z",
"translations": {
"en-us": {
"name": "Waiting"
},
"tr-tr": {
"name": "Bekliyor"
}
},
"modified_date": "2022-05-26T13:20:05.547034Z"
},
"package": 162406,
"serial_no": null,
"order_item": {
"id": 3609,
"image": null,
"order": 4423,
"price": "100.00",
"state": {
"id": 22,
"name": "Onaylanmış",
"config": {},
"enum_class": "OrderStatus",
"enum_value": "400",
"content_type": 20,
"created_date": "2019-07-04T15:14:51.986693Z",
"translations": {
"en-us": {
"name": "Approved"
},
"tr-tr": {
"name": "Onaylanmış"
}
},
"modified_date": "2022-05-26T13:20:05.670181Z"
},
"product": {
"id": 84,
"sku": "1185177001",
"name": "YAPAY SUKULENT CAM TERARYUM 8 CM",
"barcode": null,
"base_code": "1185177",
"attributes": {
"renk": "RENKSİZ",
"beden": "Standart",
"ebat_en": "8.0",
"erp_Msb": "False",
"erp_Yil": "2017",
"cinsiyet": "Genel",
"ebat_boy": "8.0",
"erp_Beden": "000",
"erp_Sezon": "Devamlı",
"erp_EbatEn": "8.0",
"erp_Outlet": "False",
"erp_AnaRenk": "X",
"erp_EbatBoy": "8.0",
"ebat_agirlik": "0.0",
"erp_AsilRenk": "RENKSİZ",
"erp_Cinsiyet": "Genel",
"variant_renk": "RENKSİZ",
"erp_AnaMalTip": "0",
"erp_VaryantNo": "1185177-000",
"ebat_yukseklik": "1.0",
"erp_MalGrupAdi": "CONCEPT",
"erp_UretimYeri": "TÜRKİYE",
"erp_EbatAgirlik": "0.0",
"erp_MalDetayAdi": "SAKSILI ÇİÇEK",
"erp_MalSinifAdi": "BİTKİ GRUBU",
"integration_Msb": "False",
"integration_Yil": "2017",
"erp_EbatYukseklik": "1.0",
"erp_MalAltGrupAdi": "DEKORATIF",
"integration_Beden": "000",
"integration_Sezon": "Devamlı",
"erp_MalAltSinifAdi": "ÇİÇEK GRUBU",
"integration_EbatEn": "8.0",
"integration_Outlet": "False",
"erp_AciklayiciBilgi": "<p> </p><p>En: 8</p><p>Boy: 8</p><p>Yükseklik: 1</p><p>Menşei: TÜRKİYE</p>",
"integration_AnaRenk": "X",
"integration_EbatBoy": "8.0",
"integration_AsilRenk": "RENKSİZ",
"integration_Cinsiyet": "Genel",
"integration_AnaMalTip": "0",
"integration_VaryantNo": "1185177-000",
"integration_MalGrupAdi": "CONCEPT",
"integration_UretimYeri": "TÜRKİYE",
"integration_EbatAgirlik": "0.0",
"integration_MalDetayAdi": "SAKSILI ÇİÇEK",
"integration_MalSinifAdi": "BİTKİ GRUBU",
"integration_EbatYukseklik": "1.0",
"integration_MalAltGrupAdi": "DEKORATIF",
"integration_MalAltSinifAdi": "ÇİÇEK GRUBU",
"integration_AciklayiciBilgi": "<p> </p><p>En: 8</p><p>Boy: 8</p><p>Yükseklik: 1</p><p>Menşei: TÜRKİYE</p>"
},
"omnitron_id": 68,
"created_date": "2020-02-14T14:28:13.795823Z",
"modified_date": "2021-06-21T14:10:21.572603Z",
"extra_attributes": {},
"productimage_set": [
{
"id": 1134,
"url": "{cdn_url}/products/2019/03/17/68/9c7bd616-98f6-499c-b58f-c7f56f042180.jpg",
"order": 11,
"product": 84
},
{
"id": 1135,
"url": "{cdn_url}/products/2019/03/17/68/04936e2c-050a-4a15-abc8-58b16cfc3d73.jpg",
"order": 42,
"product": 84
},
{
"id": 1136,
"url": "{cdn_url}/products/2019/03/17/68/18742616-b244-46fd-a51c-05de483f3866.jpg",
"order": 63,
"product": 84
}
],
"attributes_kwargs": {
"renk": {
"label": "RENKSİZ",
"value": "RENKSİZ",
"data_type": "dropdown"
},
"beden": {
"label": "Standart",
"value": "Standart",
"data_type": "dropdown"
},
"erp_Msb": {
"label": "False",
"value": "False",
"data_type": "dropdown"
},
"cinsiyet": {
"label": "Genel",
"value": "Genel",
"data_type": "dropdown"
},
"erp_Beden": {
"label": "000",
"value": "000",
"data_type": "dropdown"
},
"erp_Outlet": {
"label": "False",
"value": "False",
"data_type": "dropdown"
},
"erp_AnaRenk": {
"label": "X",
"value": "X",
"data_type": "dropdown"
},
"erp_AsilRenk": {
"label": "RENKSİZ",
"value": "RENKSİZ",
"data_type": "dropdown"
},
"erp_Cinsiyet": {
"label": "Genel",
"value": "Genel",
"data_type": "dropdown"
},
"variant_renk": {
"label": "RENKSİZ",
"value": "RENKSİZ",
"data_type": "dropdown"
},
"erp_AnaMalTip": {
"label": "0",
"value": "0",
"data_type": "dropdown"
},
"erp_MalGrupAdi": {
"label": "CONCEPT",
"value": "CONCEPT",
"data_type": "dropdown"
},
"erp_UretimYeri": {
"label": "TÜRKİYE",
"value": "TÜRKİYE",
"data_type": "dropdown"
},
"erp_MalDetayAdi": {
"label": "SAKSILI ÇİÇEK",
"value": "SAKSILI ÇİÇEK",
"data_type": "dropdown"
},
"erp_MalSinifAdi": {
"label": "BİTKİ GRUBU",
"value": "BİTKİ GRUBU",
"data_type": "dropdown"
},
"erp_MalAltGrupAdi": {
"label": "DEKORATIF",
"value": "DEKORATIF",
"data_type": "dropdown"
},
"erp_MalAltSinifAdi": {
"label": "ÇİÇEK GRUBU",
"value": "ÇİÇEK GRUBU",
"data_type": "dropdown"
}
},
"remote_modified_date": "2021-06-13T22:07:08.316236Z"
},
"tax_rate": "18.00",
"attributes": {},
"net_amount": "100.00",
"price_list": {
"pk": 1,
"code": null,
"name": "Demo Price List",
"created_date": "2019-05-22T14:59:02.904438Z",
"is_auto_sync": false,
"modified_date": "2019-05-22T14:59:02.904461Z"
},
"stock_list": {
"pk": 1,
"code": null,
"name": "Demo Stock List",
"created_date": "2019-05-22T14:59:20.055271Z",
"is_auto_sync": false,
"modified_date": "2019-05-22T14:59:20.055292Z"
},
"tax_amount": null,
"extra_field": {
"price_extra_field": {},
"stock_extra_field": {}
},
"omnitron_id": 5909,
"created_date": "2021-06-21T14:10:22.034062Z",
"retail_price": "200.00",
"modified_date": "2021-06-21T14:10:22.034092Z",
"price_currency": "try",
"discount_amount": "20.00",
"attributes_kwargs": {},
"parent_omnitron_id": null,
"without_net_amount": null,
"installment_interest_amount": null
},
"unit_weight": null,
"created_date": "2022-10-05T14:07:53.518391Z",
"denial_reason": null,
"modified_date": "2022-10-05T14:07:53.518407Z",
"transfer_order": null,
"selected_barcode": null,
"discrepancy_reason": null
}
],
"tracking_number": null,
"shipping_address": {
"id": 39,
"city": {
"pk": 2,
"name": "MILANO",
"country": 1,
"latitude": "37.76365000",
"is_active": true,
"longitude": "38.27725920"
},
"line": "Viale Edoardo Jenner",
"email": "example@mail.com",
"notes": null,
"title": "dolor sit amet",
"tax_no": "",
"country": {
"pk": 1,
"code": "it",
"name": "Italy",
"latitude": "38.96374500",
"is_active": true,
"longitude": "35.24332200"
},
"mapping": null,
"customer": {
"pk": 335,
"email": "example@mail.com",
"channel": 1,
"erp_code": null,
"last_name": "Doe",
"first_name": "John",
"phone_number": "+90 555XXX0000"
},
"district": {
"pk": 1605,
"city": 2,
"name": "Lorem Ipsum",
"latitude": "37.84640000",
"township": 21,
"is_active": true,
"longitude": "37.69180000"
},
"postcode": "11111",
"township": {
"pk": 21,
"city": 2,
"name": "20158 Milano MI",
"latitude": "37.77087630",
"is_active": true,
"longitude": "37.59607040"
},
"is_active": true,
"last_name": "Doe",
"first_name": "John",
"tax_office": "",
"omnitron_id": 34,
"address_type": "customer",
"company_name": "",
"created_date": "2019-09-19T07:32:47.514656Z",
"phone_number": "+90 555XXX0000",
"modified_date": "2021-06-29T12:16:02.586289Z",
"e_bill_taxpayer": false
},
"extra_information": {
"parent_package": {
"id": 162404,
"number": "1690624566214332P3"
},
"distance_to_shipping_address": 824
},
"omnitron_order_id": 106640,
"order_has_gift_box": false,
"channel_omnitron_id": 1,
"order_gift_box_note": null,
"target_packing_date": "2021-06-26T14:07:59.205955Z",
"is_click_and_collect": false,
"order_retail_store_id": null
}
},
"response_content": "b'<html>\\r\\n<head><title>405 Not Allowed</title></head>\\r\\n<body bgcolor=\"white\">\\r\\n<center><h1>405 Not Allowed</h1></center>\\r\\n<hr><center>nginx</center>\\r\\n</body>\\r\\n</html>\\r\\n'",
"response_http_status": 405,
"delivered": false,
"request_datetimes": [
"2022-10-08T15:00:00.036481Z",
"2022-10-07T02:45:00.042397Z",
"2022-10-06T08:30:00.064332Z",
"2022-10-05T23:15:00.028042Z",
"2022-10-05T18:45:00.038698Z",
"2022-10-05T16:30:00.050483Z",
"2022-10-05T15:30:00.051336Z",
"2022-10-05T14:45:00.036220Z",
"2022-10-05T14:25:01.734838Z",
"2022-10-05T14:16:28.934978Z",
"2022-10-05T14:12:12.714984Z",
"2022-10-05T14:10:03.844798Z",
"2022-10-05T14:08:59.494742Z",
"2022-10-05T14:08:27.320826Z",
"2022-10-05T14:08:11.286489Z",
"2022-10-05T14:08:02.854894Z",
"2022-10-05T14:07:58.045821Z",
"2022-10-05T14:07:54.843321Z",
"2022-10-05T14:07:53.749194Z"
],
"retry_count": 19,
"object_id": 162406,
"content_type": 25
}
Response Description:
Detailed information about the webhook event with the entire payload is transmitted in the message body.
GET Package Delivery Ranges
Returns the distinct available delivery ranges.
Path: /api/v1/oms/packages/delivery-ranges/
Request
- Headers: -
- Authorization: Token
- Body Parameters: None
- Request Body: None
Response (200 OK)
{
"count": 427,
"next": "{domain_url}/api/v1/oms/packages/delivery-ranges/?page=4",
"previous": "{domain_url}/api/v1/oms/packages/delivery-ranges/?page=2",
"results": [
{
"lower": "2021-10-26T06:00:00+0000",
"upper": "2021-10-26T15:00:00+0000",
"bounds": "[)"
},
{
"lower": "2021-10-27T06:00:00+0000",
"upper": "2021-10-27T15:00:00+0000",
"bounds": "[)"
},
{
"lower": "2021-10-28T06:00:00+0000",
"upper": "2021-10-28T15:00:00+0000",
"bounds": "[)"
},
{
"lower": "2021-11-01T06:00:00+0000",
"upper": "2021-11-01T15:00:00+0000",
"bounds": "[)"
},
{
"lower": "2021-11-02T06:00:00+0000",
"upper": "2021-11-02T15:00:00+0000",
"bounds": "[)"
},
{
"lower": "2021-11-03T06:00:00+0000",
"upper": "2021-11-03T15:00:00+0000",
"bounds": "[)"
},
{
"lower": "2021-11-04T06:00:00+0000",
"upper": "2021-11-04T15:00:00+0000",
"bounds": "[)"
},
{
"lower": "2021-11-05T06:00:00+0000",
"upper": "2021-11-05T15:00:00+0000",
"bounds": "[)"
},
{
"lower": "2021-11-08T06:00:00+0000",
"upper": "2021-11-08T15:00:00+0000",
"bounds": "[)"
},
{
"lower": "2021-11-09T06:00:00+0000",
"upper": "2021-11-09T15:00:00+0000",
"bounds": "[)"
}
]
}
Response Description:
The lower, upper and bounds values of the delivery ranges are transmitted in the message body.
POST Package Command
Runs the command given in the request body for the package specified with the pk (ID).
Instructions for the commands may be found in Commands article.
Path: /api/v1/oms/packages/pk/command/
Request
- Headers: -
- Authorization: Token
- Body Parameters: None
Body Parameters
| Property | Data Type | Required | Descriptions |
|---|---|---|---|
| transition | int | false* | Transition ID |
| slug | str | false* | Unique slug of the transition |
| input_parameters | dict | true | Parameters ( {} is entered if there are no parameters) |
*Either slug or transition is required.
Request Body Example
{
"transition": 25,
"slug": "package__detected_out_of_stock_item__waiting__contains-out-of-stock-products",
"input_parameters": {
"package_items": [
2,
1
]
}
}
Response (204 No Content)
No Content
Response (200 OK)
{
"package__id": 2,
"package__number": "530154142780104",
"package__stock_location__id": 2,
"package__stock_location__name": "SL_vYBFFLEx",
"is_same_location": false
}
Response 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 Package Invoice
Creates a purchase invoice for the package specified with the pk (ID) using the provided ID (from the URL). The request is sent without a body.
Path: /api/v1/oms/packages/pk/invoice/
Request
- Headers: -
- Authorization: Token
- Body Parameters: None
- Request Body: None
Response (201 CREATED)
{
"id": 6,
"invoice_type": "purchased",
"status": "waiting",
"channel": {
"id": 2,
"channel_type": "web",
"created_date": "2019-03-25T08:22:49.663798Z",
"modified_date": "2019-03-25T08:22:49.663848Z",
"omnitron_id": 1,
"name": "Shop",
"configuration": {},
"is_active": false
},
"address": {
"pk": 3,
"email": "example@mail.com",
"phone_number": "+90 555XXX0000",
"first_name": "John",
"last_name": "Doe",
"country": 2,
"city": 2,
"line": "Viale Edoardo Jenner",
"title": "dolor sit amet",
"township": 2,
"district": null,
"postcode": "11613",
"notes": null,
"company_name": "",
"tax_office": "",
"tax_no": "",
"e_bill_taxpayer": false,
"is_corporate": false
},
"invoiceitem_set": [
{
"id": 20,
"created_date": "2019-03-25T09:00:55.340787Z",
"modified_date": "2019-03-25T09:00:55.340824Z",
"tax_rate": "14.00",
"tax_amount": "7.98",
"discount_rate": "0.00",
"discount_amount": "0.00",
"interest_rate": "0.00",
"interest_amount": null,
"total_amount": "65.00",
"net_amount": "65.00",
"order_item": 9
}
],
"order": {
"id": 2,
"state": {
"id": 1,
"created_date": "2019-03-25T07:59:45.267277Z",
"modified_date": "2019-03-25T07:59:45.267370Z",
"name": "Waiting",
"config": {},
"enum_class": "OrderStatus",
"enum_value": "100",
"content_type": 17
},
"payment_type": "pay_on_delivery",
"created_date": "2019-03-25T08:22:49.713086Z",
"modified_date": "2019-03-25T08:22:49.713114Z",
"omnitron_id": 155323,
"number": "1021653181107",
"date_placed": "2018-11-07T14:53:54.030204Z",
"channel": 2,
"customer": 2,
"shipping_address": 3,
"billing_address": 3
},
"package_number": "Package_2019_03_25",
"created_date": "2019-03-25T09:00:55.329539Z",
"modified_date": "2019-03-25T09:00:55.329570Z",
"number": "4747615176"
}
Response Description:
Detailed information about the created invoice is transmitted in the message body.
POST Package Set Invoice Number
Assigns the invoice number specified in the request body to the package specified with the pk (ID).
Path: /api/v1/oms/packages/pk/set_invoice_number/
Request
- Headers: -
- Authorization: Token
- Body Parameters: None
Body Parameters
| Property | Data Type | Required | Descriptions |
|---|---|---|---|
| invoice_number | string | true | New invoice number to be assigned to the package |
Request Body Example
{
"invoice_number": "123456789"
}
Response (204 No Content)
No Content
Response Description:
There is no content to send for this request.
POST Package Set Remote ID
Updates the remote_id parameter of the package specified with the pk (ID).
Path: /api/v1/oms/packages/pk/set_remote_id/
Request
- Headers: -
- Authorization: Token
- Body Parameters: None
- Request Body: None
Body Parameters
| Property | Data Type | Required | Descriptions |
|---|---|---|---|
| remote_id | string | true | Remote ID to be assigned to the package |
Request Body Example
{
"remote_id": "99"
}
Response (204 No Content)
No Content
Response Description:
There is no content to send for this request.