# Transfer Orders Transfer order operations and management ## List transfer orders > Returns a paginated list of transfer orders with comprehensive filtering options. ```json {"openapi":"3.0.3","info":{"title":"OMS Transfers Module API","version":"1.0.0"},"tags":[{"name":"transfer-orders","description":"Transfer order operations and management"}],"servers":[{"url":"https://{domain}/api/v1/oms","variables":{"domain":{"default":"domain.akinon.com"}}}],"security":[{"tokenAuth":[]}],"components":{"securitySchemes":{"tokenAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"Use format: `Token `"}},"parameters":{"format":{"name":"format","in":"query","description":"Response format","schema":{"type":"string","enum":["json","html","csv","xls"],"default":"json"}},"page":{"name":"page","in":"query","description":"Page number","schema":{"type":"integer","default":1}},"limit":{"name":"limit","in":"query","description":"Number of items per page","schema":{"type":"integer","default":20}},"sort":{"name":"sort","in":"query","description":"Sorting field","schema":{"type":"string","enum":["id","-id","modified_date","-modified_date","created_date","-created_date","order_id","-order_id"]}},"state":{"name":"state","in":"query","description":"Filter by state ID","schema":{"type":"integer"}},"state_enum_value":{"name":"state__enum_value","in":"query","description":"Filter by state enum value","schema":{"type":"string"}},"order":{"name":"order","in":"query","description":"Filter by order ID","schema":{"type":"integer"}},"order_number":{"name":"order__number","in":"query","description":"Filter by order number","schema":{"type":"string"}},"package":{"name":"package","in":"query","description":"Filter by package ID","schema":{"type":"integer"}},"package_number":{"name":"package_number","in":"query","description":"Filter by package number","schema":{"type":"string"}},"product_sku":{"name":"product_sku","in":"query","description":"Filter by product SKU","schema":{"type":"string"}},"product_barcode":{"name":"product_barcode","in":"query","description":"Filter by product barcode","schema":{"type":"string"}},"source_erp_code":{"name":"source__erp_code","in":"query","description":"Filter by source stock location ERP code","schema":{"type":"string"}},"destination__erp_code":{"name":"destination__erp_code","in":"query","description":"Filter by destination stock location ERP code","schema":{"type":"string"}},"retail_store_erp_code":{"name":"retail_store__erp_code","in":"query","description":"Filter by retail store ERP code","schema":{"type":"string"}},"erp_code":{"name":"erp_code","in":"query","description":"Filter by ERP code","schema":{"type":"string"}},"customer_first_name":{"name":"order__customer__first_name","in":"query","description":"Filter by customer first name","schema":{"type":"string"}},"customer_last_name":{"name":"order__customer__last_name","in":"query","description":"Filter by customer last name","schema":{"type":"string"}},"order_date":{"name":"order__date_placed","in":"query","description":"Filter by order date","schema":{"type":"string","format":"date"}},"id_gt":{"name":"id__gt","in":"query","description":"Filter IDs greater than this value","schema":{"type":"integer"}},"id_gte":{"name":"id__gte","in":"query","description":"Filter IDs greater than or equal to this value","schema":{"type":"integer"}},"id_lt":{"name":"id__lt","in":"query","description":"Filter IDs less than this value","schema":{"type":"integer"}},"id_lte":{"name":"id__lte","in":"query","description":"Filter IDs less than or equal to this value","schema":{"type":"integer"}},"pk_in":{"name":"pk__in","in":"query","description":"Filter by primary keys (comma-separated)","schema":{"type":"string"}},"channel":{"name":"order__channel","in":"query","description":"Filter by channel ID","schema":{"type":"integer"}},"shipment_cargo_company":{"name":"package__shipment__cargo_company","in":"query","description":"Filter by shipment cargo company","schema":{"type":"integer"}},"country":{"name":"destination__country","in":"query","description":"Filter by destination country","schema":{"type":"string"}}},"schemas":{"TransferOrder":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"number":{"type":"string","description":"Transfer order number"},"state":{"type":"object","description":"Transfer order state information"},"order":{"type":"object","description":"Associated order information"},"package":{"type":"object","description":"Associated package information"},"source":{"type":"object","description":"Source stock location information"},"destination":{"type":"object","description":"Destination stock location information"},"created_date":{"type":"string","format":"date-time","description":"Creation timestamp"},"modified_date":{"type":"string","format":"date-time","description":"Last modification timestamp"},"extra_information":{"type":"object","description":"Additional transfer order information"}}}}},"paths":{"/transfer_orders/":{"get":{"tags":["transfer-orders"],"summary":"List transfer orders","description":"Returns a paginated list of transfer orders with comprehensive filtering options.","parameters":[{"$ref":"#/components/parameters/format"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/sort"},{"$ref":"#/components/parameters/state"},{"$ref":"#/components/parameters/state_enum_value"},{"$ref":"#/components/parameters/order"},{"$ref":"#/components/parameters/order_number"},{"$ref":"#/components/parameters/package"},{"$ref":"#/components/parameters/package_number"},{"$ref":"#/components/parameters/product_sku"},{"$ref":"#/components/parameters/product_barcode"},{"$ref":"#/components/parameters/source_erp_code"},{"$ref":"#/components/parameters/destination__erp_code"},{"$ref":"#/components/parameters/retail_store_erp_code"},{"$ref":"#/components/parameters/erp_code"},{"$ref":"#/components/parameters/customer_first_name"},{"$ref":"#/components/parameters/customer_last_name"},{"$ref":"#/components/parameters/order_date"},{"$ref":"#/components/parameters/id_gt"},{"$ref":"#/components/parameters/id_gte"},{"$ref":"#/components/parameters/id_lt"},{"$ref":"#/components/parameters/id_lte"},{"$ref":"#/components/parameters/pk_in"},{"$ref":"#/components/parameters/channel"},{"$ref":"#/components/parameters/shipment_cargo_company"},{"$ref":"#/components/parameters/country"}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true},"previous":{"type":"string","nullable":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/TransferOrder"}}}}}}}}}}}} ``` ## Get transfer order by ID > Retrieve a specific transfer order by its ID ```json {"openapi":"3.0.3","info":{"title":"OMS Transfers Module API","version":"1.0.0"},"tags":[{"name":"transfer-orders","description":"Transfer order operations and management"}],"servers":[{"url":"https://{domain}/api/v1/oms","variables":{"domain":{"default":"domain.akinon.com"}}}],"security":[{"tokenAuth":[]}],"components":{"securitySchemes":{"tokenAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"Use format: `Token `"}},"schemas":{"TransferOrder":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"number":{"type":"string","description":"Transfer order number"},"state":{"type":"object","description":"Transfer order state information"},"order":{"type":"object","description":"Associated order information"},"package":{"type":"object","description":"Associated package information"},"source":{"type":"object","description":"Source stock location information"},"destination":{"type":"object","description":"Destination stock location information"},"created_date":{"type":"string","format":"date-time","description":"Creation timestamp"},"modified_date":{"type":"string","format":"date-time","description":"Last modification timestamp"},"extra_information":{"type":"object","description":"Additional transfer order information"}}}}},"paths":{"/transfer_orders/{id}/":{"get":{"tags":["transfer-orders"],"summary":"Get transfer order by ID","description":"Retrieve a specific transfer order by its ID","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Transfer order details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransferOrder"}}}}}}}}} ``` ## List transfer orders with short format > Get a list of transfer orders with minimal information ```json {"openapi":"3.0.3","info":{"title":"OMS Transfers Module API","version":"1.0.0"},"tags":[{"name":"transfer-orders","description":"Transfer order operations and management"}],"servers":[{"url":"https://{domain}/api/v1/oms","variables":{"domain":{"default":"domain.akinon.com"}}}],"security":[{"tokenAuth":[]}],"components":{"securitySchemes":{"tokenAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"Use format: `Token `"}},"parameters":{"format":{"name":"format","in":"query","description":"Response format","schema":{"type":"string","enum":["json","html","csv","xls"],"default":"json"}},"page":{"name":"page","in":"query","description":"Page number","schema":{"type":"integer","default":1}},"limit":{"name":"limit","in":"query","description":"Number of items per page","schema":{"type":"integer","default":20}},"sort":{"name":"sort","in":"query","description":"Sorting field","schema":{"type":"string","enum":["id","-id","modified_date","-modified_date","created_date","-created_date","order_id","-order_id"]}},"state":{"name":"state","in":"query","description":"Filter by state ID","schema":{"type":"integer"}},"state_enum_value":{"name":"state__enum_value","in":"query","description":"Filter by state enum value","schema":{"type":"string"}},"order":{"name":"order","in":"query","description":"Filter by order ID","schema":{"type":"integer"}},"order_number":{"name":"order__number","in":"query","description":"Filter by order number","schema":{"type":"string"}},"package":{"name":"package","in":"query","description":"Filter by package ID","schema":{"type":"integer"}},"package_number":{"name":"package_number","in":"query","description":"Filter by package number","schema":{"type":"string"}}},"schemas":{"TransferOrderShort":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"number":{"type":"string","description":"Transfer order number"},"state":{"type":"string","description":"Transfer order state enum value"},"source_erp_code":{"type":"string","description":"Source stock location ERP code"},"destination_erp_code":{"type":"string","description":"Destination stock location ERP code"}}}}},"paths":{"/transfer_orders/short/":{"get":{"tags":["transfer-orders"],"summary":"List transfer orders with short format","description":"Get a list of transfer orders with minimal information","parameters":[{"$ref":"#/components/parameters/format"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/sort"},{"$ref":"#/components/parameters/state"},{"$ref":"#/components/parameters/state_enum_value"},{"$ref":"#/components/parameters/order"},{"$ref":"#/components/parameters/order_number"},{"$ref":"#/components/parameters/package"},{"$ref":"#/components/parameters/package_number"}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer"},"results":{"type":"array","items":{"$ref":"#/components/schemas/TransferOrderShort"}}}}}}}}}}}} ``` ## Get transfer order with short format > Get a single transfer order with minimal information ```json {"openapi":"3.0.3","info":{"title":"OMS Transfers Module API","version":"1.0.0"},"tags":[{"name":"transfer-orders","description":"Transfer order operations and management"}],"servers":[{"url":"https://{domain}/api/v1/oms","variables":{"domain":{"default":"domain.akinon.com"}}}],"security":[{"tokenAuth":[]}],"components":{"securitySchemes":{"tokenAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"Use format: `Token `"}},"schemas":{"TransferOrderShort":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"number":{"type":"string","description":"Transfer order number"},"state":{"type":"string","description":"Transfer order state enum value"},"source_erp_code":{"type":"string","description":"Source stock location ERP code"},"destination_erp_code":{"type":"string","description":"Destination stock location ERP code"}}}}},"paths":{"/transfer_orders/{id}/short/":{"get":{"tags":["transfer-orders"],"summary":"Get transfer order with short format","description":"Get a single transfer order with minimal information","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransferOrderShort"}}}}}}}}} ``` ## Execute transfer order command > Execute a command on a specific transfer order ```json {"openapi":"3.0.3","info":{"title":"OMS Transfers Module API","version":"1.0.0"},"tags":[{"name":"transfer-orders","description":"Transfer order operations and management"}],"servers":[{"url":"https://{domain}/api/v1/oms","variables":{"domain":{"default":"domain.akinon.com"}}}],"security":[{"tokenAuth":[]}],"components":{"securitySchemes":{"tokenAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"Use format: `Token `"}}},"paths":{"/transfer_orders/{id}/command/":{"post":{"tags":["transfer-orders"],"summary":"Execute transfer order command","description":"Execute a command on a specific transfer order","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"command":{"type":"string","description":"Command to execute"},"params":{"type":"object","description":"Command parameters"}}}}}},"responses":{"200":{"description":"Command executed successfully"},"400":{"description":"Invalid command or parameters"}}}}}} ``` ## Get transfer order extra information > Retrieve extra information for a specific transfer order ```json {"openapi":"3.0.3","info":{"title":"OMS Transfers Module API","version":"1.0.0"},"tags":[{"name":"transfer-orders","description":"Transfer order operations and management"}],"servers":[{"url":"https://{domain}/api/v1/oms","variables":{"domain":{"default":"domain.akinon.com"}}}],"security":[{"tokenAuth":[]}],"components":{"securitySchemes":{"tokenAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"Use format: `Token `"}}},"paths":{"/transfer_orders/{id}/extra_information/":{"get":{"tags":["transfer-orders"],"summary":"Get transfer order extra information","description":"Retrieve extra information for a specific transfer order","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Extra information retrieved successfully","content":{"application/json":{"schema":{"type":"object"}}}}}}}}} ``` ## Set invoice number for transfer order > Set or update the invoice number for a specific transfer order ```json {"openapi":"3.0.3","info":{"title":"OMS Transfers Module API","version":"1.0.0"},"tags":[{"name":"transfer-orders","description":"Transfer order operations and management"}],"servers":[{"url":"https://{domain}/api/v1/oms","variables":{"domain":{"default":"domain.akinon.com"}}}],"security":[{"tokenAuth":[]}],"components":{"securitySchemes":{"tokenAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"Use format: `Token `"}}},"paths":{"/transfer_orders/{id}/set_invoice_number/":{"patch":{"tags":["transfer-orders"],"summary":"Set invoice number for transfer order","description":"Set or update the invoice number for a specific transfer order","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"invoice_number":{"type":"string","description":"Invoice number to set"}}}}}},"responses":{"200":{"description":"Invoice number updated successfully"}}}}}} ``` ## Set remote ID for transfer order > Set or update the remote ID for a specific transfer order ```json {"openapi":"3.0.3","info":{"title":"OMS Transfers Module API","version":"1.0.0"},"tags":[{"name":"transfer-orders","description":"Transfer order operations and management"}],"servers":[{"url":"https://{domain}/api/v1/oms","variables":{"domain":{"default":"domain.akinon.com"}}}],"security":[{"tokenAuth":[]}],"components":{"securitySchemes":{"tokenAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"Use format: `Token `"}}},"paths":{"/transfer_orders/{id}/set_remote_id/":{"patch":{"tags":["transfer-orders"],"summary":"Set remote ID for transfer order","description":"Set or update the remote ID for a specific transfer order","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"remote_id":{"type":"string","description":"Remote ID to set"}}}}}},"responses":{"200":{"description":"Remote ID updated successfully"}}}}}} ``` ## Get transfer order transition logs > Retrieve state transition logs for a specific transfer order ```json {"openapi":"3.0.3","info":{"title":"OMS Transfers Module API","version":"1.0.0"},"tags":[{"name":"transfer-orders","description":"Transfer order operations and management"}],"servers":[{"url":"https://{domain}/api/v1/oms","variables":{"domain":{"default":"domain.akinon.com"}}}],"security":[{"tokenAuth":[]}],"components":{"securitySchemes":{"tokenAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"Use format: `Token `"}},"parameters":{"page":{"name":"page","in":"query","description":"Page number","schema":{"type":"integer","default":1}},"limit":{"name":"limit","in":"query","description":"Number of items per page","schema":{"type":"integer","default":20}}},"schemas":{"TransitionLog":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"content_object":{"type":"object","description":"Related object information"},"old_state":{"type":"object","description":"Previous state information"},"new_state":{"type":"object","description":"New state information"},"created_date":{"type":"string","format":"date-time","description":"When the transition occurred"},"extra_data":{"type":"object","description":"Additional transition data"}}}}},"paths":{"/transfer_orders/{id}/transition_logs/":{"get":{"tags":["transfer-orders"],"summary":"Get transfer order transition logs","description":"Retrieve state transition logs for a specific transfer order","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/limit"}],"responses":{"200":{"description":"Transition logs retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer"},"results":{"type":"array","items":{"$ref":"#/components/schemas/TransitionLog"}}}}}}}}}}}} ``` ## Get specific transition log > Retrieve a specific transition log by ID ```json {"openapi":"3.0.3","info":{"title":"OMS Transfers Module API","version":"1.0.0"},"tags":[{"name":"transfer-orders","description":"Transfer order operations and management"}],"servers":[{"url":"https://{domain}/api/v1/oms","variables":{"domain":{"default":"domain.akinon.com"}}}],"security":[{"tokenAuth":[]}],"components":{"securitySchemes":{"tokenAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"Use format: `Token `"}},"schemas":{"TransitionLog":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"content_object":{"type":"object","description":"Related object information"},"old_state":{"type":"object","description":"Previous state information"},"new_state":{"type":"object","description":"New state information"},"created_date":{"type":"string","format":"date-time","description":"When the transition occurred"},"extra_data":{"type":"object","description":"Additional transition data"}}}}},"paths":{"/transfer_orders/{id}/transition_logs/{log_id}/":{"get":{"tags":["transfer-orders"],"summary":"Get specific transition log","description":"Retrieve a specific transition log by ID","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}},{"name":"log_id","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Transition log retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransitionLog"}}}}}}}}} ``` ## List transfer orders (simplified) > Returns a simplified list of transfer orders with basic model fields ```json {"openapi":"3.0.3","info":{"title":"OMS Transfers Module API","version":"1.0.0"},"tags":[{"name":"transfer-orders","description":"Transfer order operations and management"}],"servers":[{"url":"https://{domain}/api/v1/oms","variables":{"domain":{"default":"domain.akinon.com"}}}],"security":[{"tokenAuth":[]}],"components":{"securitySchemes":{"tokenAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"Use format: `Token `"}},"parameters":{"page":{"name":"page","in":"query","description":"Page number","schema":{"type":"integer","default":1}},"limit":{"name":"limit","in":"query","description":"Number of items per page","schema":{"type":"integer","default":20}},"sort":{"name":"sort","in":"query","description":"Sorting field","schema":{"type":"string","enum":["id","-id","modified_date","-modified_date","created_date","-created_date","order_id","-order_id"]}}},"schemas":{"TransferOrderSimple":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"number":{"type":"string","description":"Transfer order number"},"state":{"type":"integer","description":"State ID"},"order":{"type":"integer","description":"Order ID"},"package":{"type":"integer","description":"Package ID"},"source":{"type":"integer","description":"Source stock location ID"},"destination":{"type":"integer","description":"Destination stock location ID"},"created_date":{"type":"string","format":"date-time","description":"Creation timestamp"},"modified_date":{"type":"string","format":"date-time","description":"Last modification timestamp"}}}}},"paths":{"/transfer_orders/list-simple/":{"get":{"tags":["transfer-orders"],"summary":"List transfer orders (simplified)","description":"Returns a simplified list of transfer orders with basic model fields","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/sort"}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer"},"results":{"type":"array","items":{"$ref":"#/components/schemas/TransferOrderSimple"}}}}}}}}}}}} ```