Order Services
All services related to orders are listed in this document.
GET Order List
GET Order ListThis method is used to get a detailed list of orders.
Path: /api/v1/oms/orders/
Request
Headers:
Authorization: Token
Body Parameters: None
Request Body: None
Response 200 OK
{
"count": 722,
"next": "{domain_url}/api/v1/oms/orders/?limit=2&page=2",
"previous": null,
"results": [
{
"id": 6998,
"state": {
"id": 6,
"created_date": "2021-06-30T14:43:26.601899Z",
"modified_date": "2022-10-14T10:39:33.629710Z",
"translations": {
"en-us": {
"name": "Approved"
},
"tr-tr": {
"name": "Onaylanmış"
}
},
"name": "Approved",
"config": {},
"enum_class": "OrderStatus",
"enum_value": "400",
"content_type": 2
},
"commands": [],
"orderitem_set": [
{
"id": 6899,
"state": {
"id": 27,
"created_date": "2021-06-30T14:43:26.792596Z",
"modified_date": "2022-10-14T10:39:33.571042Z",
"translations": {
"en-us": {
"name": "Inactive"
},
"tr-tr": {
"name": "Aktif Olmayan"
}
},
"name": "Inactive",
"config": {},
"enum_class": "OrderStatus",
"enum_value": "425",
"content_type": 3
},
"product": {
"id": 365,
"productimage_set": [
{
"order": 0,
"id": 465,
"url": "{cdn_url}/products/2022/09/07/8362/38f3cfef-d582-489e-bcc2-324cd0455c72.jpg",
"product": 365
}
],
"created_date": "2022-11-10T06:57:37.198392Z",
"modified_date": "2022-11-10T06:57:37.198402Z",
"omnitron_id": 8362,
"name": "Ultimate Organic Cotton T Shirt With Crew Neck",
"base_code": "AKN-008",
"sku": "AKN-008",
"barcode": null,
"attributes": {
"hallo": "Voorbeeld",
"integration_kol_boyu": "kısa"
},
"attributes_kwargs": {
"hallo": {
"label": "Voorbeeld",
"value": "Voorbeeld",
"data_type": "valuelabel"
},
"integration_kol_boyu": {
"label": "kısa",
"value": "kısa",
"data_type": "dropdown"
}
},
"extra_attributes": {},
"remote_modified_date": "2022-09-07T11:49:23.777608Z"
},
"created_date": "2023-05-17T13:45:55.677011Z",
"modified_date": "2023-05-17T13:45:55.677031Z",
"omnitron_id": 70193,
"net_amount": "250.00",
"price": "250.00",
"price_currency": "try",
"retail_price": "1000.00",
"tax_rate": "8.00",
"tax_amount": null,
"discount_amount": "125.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": 6998
}
],
"customer": {
"email": "[email protected]",
"first_name": "John",
"last_name": "Doe",
"phone_number": null,
"erp_code": null,
"pk": 3433,
"channel": 1
},
"shipping_address": {
"id": 5908,
"city": {
"pk": 7,
"name": "MILANO",
"country": 1,
"is_active": true,
"longitude": "32.85404900",
"latitude": "39.92076300"
},
"country": {
"pk": 1,
"name": "Italy",
"code": "it",
"is_active": true,
"longitude": "35.30207500",
"latitude": "39.05625600"
},
"township": {
"pk": 84,
"name": "20158 Milano MI",
"city": 7,
"is_active": true,
"longitude": "32.85342000",
"latitude": "39.92003000"
},
"district": {
"pk": 6245,
"name": "Lorem Ipsum",
"city": 7,
"township": 84,
"is_active": true,
"longitude": "32.87055100",
"latitude": "39.90130400"
},
"customer": {
"email": "[email protected]",
"first_name": "John",
"last_name": "Doe",
"phone_number": null,
"erp_code": null,
"pk": 3433,
"channel": 1
},
"address_type": "customer",
"created_date": "2023-05-17T13:37:44.752820Z",
"modified_date": "2023-05-17T13:45:55.646535Z",
"omnitron_id": 10033,
"mapping": null,
"title": "dolor sit amet",
"is_active": true,
"line": "Viale Edoardo Jenner",
"postcode": "06290",
"notes": null,
"email": "[email protected]",
"phone_number": "+90 555XXX0000",
"first_name": "John",
"last_name": "Doe",
"company_name": "",
"tax_office": "",
"tax_no": "",
"e_bill_taxpayer": false
},
"billing_address": {
"id": 5908,
"city": {
"pk": 7,
"name": "MILANO",
"country": 1,
"is_active": true,
"longitude": "32.85404900",
"latitude": "39.92076300"
},
"country": {
"pk": 1,
"name": "Italy",
"code": "it",
"is_active": true,
"longitude": "35.30207500",
"latitude": "39.05625600"
},
"township": {
"pk": 84,
"name": "20158 Milano MI",
"city": 7,
"is_active": true,
"longitude": "32.85342000",
"latitude": "39.92003000"
},
"district": {
"pk": 6245,
"name": "Lorem Ipsum",
"city": 7,
"township": 84,
"is_active": true,
"longitude": "32.87055100",
"latitude": "39.90130400"
},
"customer": {
"email": "[email protected]",
"first_name": "John",
"last_name": "Doe",
"phone_number": null,
"erp_code": null,
"pk": 3433,
"channel": 1
},
"address_type": "customer",
"created_date": "2023-05-17T13:37:44.752820Z",
"modified_date": "2023-05-17T13:45:55.646535Z",
"omnitron_id": 10033,
"mapping": null,
"title": "dolor sit amet",
"is_active": true,
"line": "Viale Edoardo Jenner",
"postcode": "06290",
"notes": null,
"email": "[email protected]",
"phone_number": "+90 555XXX0000",
"first_name": "John",
"last_name": "Doe",
"company_name": "",
"tax_office": "",
"tax_no": "",
"e_bill_taxpayer": false
},
"channel": {
"id": 1,
"channel_type": "web",
"created_date": "2021-07-06T09:49:30.220001Z",
"modified_date": "2023-02-16T15:16:54.433413Z",
"omnitron_id": 1,
"name": "PZ Shop",
"configuration": {
"server": "{domain_url}/api/v1",
"password": "c44a3qSzp56TRwEu",
"username": "omnitron",
"sales_url": "{domain_url}/",
"auth_token": "e8f9971734a0878e4359e9e57d3af3a4172d6e28",
"feature_flags": {},
"cancel_mail_subject": "{}",
"cancel_mail_template_url": "{}",
"localized_cancel_mail_subject": {},
"direct_cancel_mail_template_url": "{}"
},
"is_active": true
},
"payment_type": "credit_card",
"retail_store": null,
"delivery_range": null,
"client_type": "default",
"delivery_type": "standard",
"created_date": "2023-05-17T13:45:55.657199Z",
"modified_date": "2023-05-17T13:45:55.657222Z",
"omnitron_id": 63461,
"number": "2291090711512921",
"date_placed": "2023-05-17T13:45:20.568681Z",
"tracking_number": null,
"has_gift_box": false,
"gift_box_note": null,
"notes": null,
"segment": null,
"cargo_company": 34
},
{
"id": 6997,
"state": {
"id": 6,
"created_date": "2021-06-30T14:43:26.601899Z",
"modified_date": "2022-10-14T10:39:33.629710Z",
"translations": {
"en-us": {
"name": "Approved"
},
"tr-tr": {
"name": "Onaylanmış"
}
},
"name": "Approved",
"config": {},
"enum_class": "OrderStatus",
"enum_value": "400",
"content_type": 2
},
"commands": [],
"orderitem_set": [
{
"id": 6898,
"state": {
"id": 27,
"created_date": "2021-06-30T14:43:26.792596Z",
"modified_date": "2022-10-14T10:39:33.571042Z",
"translations": {
"en-us": {
"name": "Inactive"
},
"tr-tr": {
"name": "Aktif Olmayan"
}
},
"name": "Inactive",
"config": {},
"enum_class": "OrderStatus",
"enum_value": "425",
"content_type": 3
},
"product": {
"id": 365,
"productimage_set": [
{
"order": 0,
"id": 465,
"url": "{cdn_url}/products/2022/09/07/8362/38f3cfef-d582-489e-bcc2-324cd0455c72.jpg",
"product": 365
}
],
"created_date": "2022-11-10T06:57:37.198392Z",
"modified_date": "2022-11-10T06:57:37.198402Z",
"omnitron_id": 8362,
"name": "Ultimate Organic Cotton T Shirt With Crew Neck",
"base_code": "AKN-008",
"sku": "AKN-008",
"barcode": null,
"attributes": {
"hallo": "Voorbeeld",
"integration_kol_boyu": "kısa"
},
"attributes_kwargs": {
"hallo": {
"label": "Voorbeeld",
"value": "Voorbeeld",
"data_type": "valuelabel"
},
"integration_kol_boyu": {
"label": "kısa",
"value": "kısa",
"data_type": "dropdown"
}
},
"extra_attributes": {},
"remote_modified_date": "2022-09-07T11:49:23.777608Z"
},
"created_date": "2023-05-17T13:37:45.074792Z",
"modified_date": "2023-05-17T13:37:45.074813Z",
"omnitron_id": 70192,
"net_amount": "250.00",
"price": "250.00",
"price_currency": "try",
"retail_price": "1000.00",
"tax_rate": "8.00",
"tax_amount": null,
"discount_amount": "125.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": 6997
}
],
"customer": {
"email": "[email protected]",
"first_name": "John",
"last_name": "Doe",
"phone_number": null,
"erp_code": null,
"pk": 3433,
"channel": 1
},
"shipping_address": {
"id": 5908,
"city": {
"pk": 7,
"name": "MILANO",
"country": 1,
"is_active": true,
"longitude": "32.85404900",
"latitude": "39.92076300"
},
"country": {
"pk": 1,
"name": "Italy",
"code": "it",
"is_active": true,
"longitude": "35.30207500",
"latitude": "39.05625600"
},
"township": {
"pk": 84,
"name": "20158 Milano MI",
"city": 7,
"is_active": true,
"longitude": "32.85342000",
"latitude": "39.92003000"
},
"district": {
"pk": 6245,
"name": "Lorem Ipsum",
"city": 7,
"township": 84,
"is_active": true,
"longitude": "32.87055100",
"latitude": "39.90130400"
},
"customer": {
"email": "[email protected]",
"first_name": "John",
"last_name": "Doe",
"phone_number": null,
"erp_code": null,
"pk": 3433,
"channel": 1
},
"address_type": "customer",
"created_date": "2023-05-17T13:37:44.752820Z",
"modified_date": "2023-05-17T13:45:55.646535Z",
"omnitron_id": 10033,
"mapping": null,
"title": "dolor sit amet",
"is_active": true,
"line": "Viale Edoardo Jenner",
"postcode": "06290",
"notes": null,
"email": "[email protected]",
"phone_number": "+90 555XXX0000",
"first_name": "John",
"last_name": "Doe",
"company_name": "",
"tax_office": "",
"tax_no": "",
"e_bill_taxpayer": false
},
"billing_address": {
"id": 5908,
"city": {
"pk": 7,
"name": "MILANO",
"country": 1,
"is_active": true,
"longitude": "32.85404900",
"latitude": "39.92076300"
},
"country": {
"pk": 1,
"name": "Italy",
"code": "it",
"is_active": true,
"longitude": "35.30207500",
"latitude": "39.05625600"
},
"township": {
"pk": 84,
"name": "20158 Milano MI",
"city": 7,
"is_active": true,
"longitude": "32.85342000",
"latitude": "39.92003000"
},
"district": {
"pk": 6245,
"name": "Lorem Ipsum",
"city": 7,
"township": 84,
"is_active": true,
"longitude": "32.87055100",
"latitude": "39.90130400"
},
"customer": {
"email": "[email protected]",
"first_name": "John",
"last_name": "Doe",
"phone_number": null,
"erp_code": null,
"pk": 3433,
"channel": 1
},
"address_type": "customer",
"created_date": "2023-05-17T13:37:44.752820Z",
"modified_date": "2023-05-17T13:45:55.646535Z",
"omnitron_id": 10033,
"mapping": null,
"title": "dolor sit amet",
"is_active": true,
"line": "Viale Edoardo Jenner",
"postcode": "06290",
"notes": null,
"email": "[email protected]",
"phone_number": "+90 555XXX0000",
"first_name": "John",
"last_name": "Doe",
"company_name": "",
"tax_office": "",
"tax_no": "",
"e_bill_taxpayer": false
},
"channel": {
"id": 1,
"channel_type": "web",
"created_date": "2021-07-06T09:49:30.220001Z",
"modified_date": "2023-02-16T15:16:54.433413Z",
"omnitron_id": 1,
"name": "PZ Shop",
"configuration": {
"server": "{domain_url}/api/v1",
"password": "c44a3qSzp56TRwEu",
"username": "omnitron",
"sales_url": "{domain_url}/",
"auth_token": "e8f9971734a0878e4359e9e57d3af3a4172d6e28",
"feature_flags": {},
"cancel_mail_subject": "{}",
"cancel_mail_template_url": "{}",
"localized_cancel_mail_subject": {},
"direct_cancel_mail_template_url": "{}"
},
"is_active": true
},
"payment_type": "credit_card",
"retail_store": null,
"delivery_range": null,
"client_type": "default",
"delivery_type": "standard",
"created_date": "2023-05-17T13:37:44.851795Z",
"modified_date": "2023-05-17T13:37:44.851827Z",
"omnitron_id": 63460,
"number": "2291086068212691",
"date_placed": "2023-05-17T13:37:37.930719Z",
"tracking_number": null,
"has_gift_box": false,
"gift_box_note": null,
"notes": null,
"segment": null,
"cargo_company": 34
}
]
}Response Description
This API provides a comprehensive list of orders, including their states, shipping and billing addresses, order items, available commands, channels, and customer details.
Response Status Codes
200 OK: The request was successful and the requested resource is returned in the response.
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.
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 Order List - Short
GET Order List - ShortThis method is used to get a less detailed list of orders.
In comparison to the "Order List" method, several fields may be omitted, and instead of providing the detailed orderitem_set, the response includes an attribute called order_item_count for each order.
Path: /api/v1/oms/orders/short/
Request
Headers:
Authorization: Token
Body Parameters: None
Request Body: None
Response 200 OK
Response Description
The API response for the orders list page in OMS is optimized to include only the necessary fields. Instead of recursively providing detailed information for all related objects, the response contains keys or references to these objects.
Response Status Codes
200 OK: The request was successful and the requested resource is returned in the response.
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.
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 Order List - Simple
GET Order List - SimpleThis method is used to get a less detailed list of orders.
Path: /api/v1/oms/orders/list-simple/
Request
Headers:
Authorization: Token
Body Parameters: None
Request Body: None
Response 200 OK
Response Description
This endpoint was specifically designed for the BI tool. Consequently, it includes essential data such as created_date and modified_date fields, but it does not include many other fields commonly found in other endpoints.
Response Status Codes
200 OK: The request was successful and the requested resource is returned in the response.
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.
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 Order Detail
GET Order DetailThis method is used to get a detailed view of a single order based on its ID of the pk.
Path: /api/v1/oms/orders/pk/
Request
Headers:
Authorization: Token
Body Parameters: None
Request Body: None
Response 200 OK
Response Description
The API response includes comprehensive information about the order, including its associated channel, customer, order items, current state, available commands, shipping and billing addresses.
Response Status Codes
200 OK: The request was successful and the requested resource is returned in the response.
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.
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 Order Detail - Short
GET Order Detail - ShortThis method is used to get a less detailed view of a single order based on its ID of the pk. In comparison to the "Order Detail" method, the response for this request provides fewer details about the order.
Path: /api/v1/oms/orders/pk/short/
Request
Headers:
Authorization: Token
Body Parameters: None
Request Body: None
Response 200 OK
Response Description
The API response includes only the fields that are required for the OMS Order Detail page.
Response Status Codes
200 OK: The request was successful and the requested resource is returned in the response.
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.
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 Order Webhook Event List
GET Order Webhook Event ListThis method is used to get a detailed list of webhook events associated with a single order based on its ID of the pk.
Path: /api/v1/oms/orders/pk/webhook_events/
Request
Headers:
Authorization: Token
Body Parameters: None
Request Body: None
Response 200 OK
Response Description
The response includes comprehensive details about the webhook, including the complete payload.
Response Status Codes
200 OK: The request was successful and the requested resource is returned in the response.
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.
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 Order Webhook Event List - Short
GET Order Webhook Event List - ShortThis method is used to get a less detailed list of webhook events associated with a specific order, identified by its ID of the pk. In contrast to the "Order Webhook Event List" method, this response provides fewer details about each webhook event, and the payload associated with each event is omitted to reduce the size of the response.
Path: /api/v1/oms/orders/pk/webhook_events/short/
Request
Headers:
Authorization: Token
Body Parameters: None
Request Body: None
Response 200 OK
Response Description
The response includes only the fields that are required for the OMS Order Detail page's webhook events list.
Response Status Codes
200 OK: The request was successful and the requested resource is returned in the response.
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.
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 Order Webhook Event Details
GET Order Webhook Event DetailsThis method is used to get the details of a specific webhook event based on its webhook_event_id that is associated with a particular order identified by its ID of the pk.
Path: /api/v1/oms/orders/pk/webhook_events/webhook_event_id/
Request
Headers:
Authorization: Token
Body Parameters: None
Request Body: None
Response 200 OK
Response Description
The response includes comprehensive information about the webhook, including the complete payload.
Response Status Codes
200 OK: The request was successful and the requested resource is returned in the response.
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.
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 Order Delivery Type Enums
GET Order Delivery Type EnumsThis method provides a static list of available delivery types for orders.
Path: /api/v1/oms/orders/delivery_type_enums/
Request
Headers:
Authorization: Token
Body Parameters: None
Request Body: None
Response 200 OK
Response Description
The response for this particular request remains constant and does not change based on the specific request made. Instead, the response contains hardcoded values that are defined in the backend of the OMS project.
Response Status Codes
200 OK: The request was successful and the requested resource is returned in the response.
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.
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 Order Payment Type Enums
GET Order Payment Type EnumsThis method provides a static list of available payment types for orders.
Path: /api/v1/oms/orders/payment_type_enums/
Request
Headers:
Authorization: Token
Body Parameters: None
Request Body: None
Response 200 OK
Response Description
The response for this particular request remains constant and does not change based on the specific request made. Instead, the response contains hardcoded values that are defined in the backend of the OMS project.
Response Status Codes
200 OK: The request was successful and the requested resource is returned in the response.
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.
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.
POST Order Pull From Omnitron
POST Order Pull From OmnitronThis method is used to initiate a process of pulling specific orders from Omnitron to OMS. The response for this operation typically provides details about the result of the pull operation for each order.
Path: /api/v1/oms/orders/pull_from_omnitron/
Request
Headers:
Authorization: Token
Body Parameters: None
Request Body: None
Body Parameters
order_numbers
list of string
true
Order numbers to be pulled from omnitron
Response 200 OK
Response Description
If the order was successfully pulled:
successis set totrue.errorsis empty or not included in the response.
If the order was not successfully pulled:
successis set tofalse.errorscontains one or more error messages, indicating the reason(s) for the failure. These error messages can include:"Order number: {0} already exists in {1} channel!"
"Order not found with Order number:{0}"
"Order create operation does not allowed! Because of Order ID: {omnitron_id} lower than MIN_ORDER_OMNITRON_ID: {min_id} "
"Order create operation does not allowed! Because of Channel ID:{channel_id} provided with Order ID:{order_id} does not allowed in the system."
"Cargo company:{cargo_company} provided with order number:{number} does not exists in the system."
Response Status Codes
200 OK: The request was successful and the result of the operation is returned in the response.
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.
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.
Last updated
Was this helpful?