Skip to content

Latest commit

 

History

History
122 lines (86 loc) · 4.27 KB

OrderLoadProgramApi.md

File metadata and controls

122 lines (86 loc) · 4.27 KB
Raw

Infoplus.OrderLoadProgramApi

All URIs are relative to https://kingsrook.localhost-testsubdomain1.infopluswms.com:8443/infoplus-wms/api

Method HTTP request Description
get_order_load_program_by_search_text GET /beta/orderLoadProgram/search Search orderLoadPrograms
get_req_load_program_by_id GET /beta/orderLoadProgram/{orderLoadProgramId} Get an orderLoadProgram by id

get_order_load_program_by_search_text

list[OrderLoadProgram] get_order_load_program_by_search_text(search_text=search_text, page=page, limit=limit)

Search orderLoadPrograms

Returns the list of orderLoadPrograms that match the given searchText.

Example

from __future__ import print_function
import time
import Infoplus
from Infoplus.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
configuration = Infoplus.Configuration()
configuration.api_key['API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['API-Key'] = 'Bearer'

# create an instance of the API class
api_instance = Infoplus.OrderLoadProgramApi(Infoplus.ApiClient(configuration))
search_text = 'search_text_example' # str | Search text, used to filter results. (optional)
page = 56 # int | Result page number.  Defaults to 1. (optional)
limit = 56 # int | Maximum results per page.  Defaults to 20.  Max allowed value is 250. (optional)

try:
    # Search orderLoadPrograms
    api_response = api_instance.get_order_load_program_by_search_text(search_text=search_text, page=page, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OrderLoadProgramApi->get_order_load_program_by_search_text: %s\n" % e)

Parameters

Name Type Description Notes
search_text str Search text, used to filter results. [optional]
page int Result page number. Defaults to 1. [optional]
limit int Maximum results per page. Defaults to 20. Max allowed value is 250. [optional]

Return type

list[OrderLoadProgram]

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_req_load_program_by_id

OrderLoadProgram get_req_load_program_by_id(order_load_program_id)

Get an orderLoadProgram by id

Returns the orderLoadProgram identified by the specified id.

Example

from __future__ import print_function
import time
import Infoplus
from Infoplus.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
configuration = Infoplus.Configuration()
configuration.api_key['API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['API-Key'] = 'Bearer'

# create an instance of the API class
api_instance = Infoplus.OrderLoadProgramApi(Infoplus.ApiClient(configuration))
order_load_program_id = 'order_load_program_id_example' # str | Id of orderLoadProgram to be returned.

try:
    # Get an orderLoadProgram by id
    api_response = api_instance.get_req_load_program_by_id(order_load_program_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OrderLoadProgramApi->get_req_load_program_by_id: %s\n" % e)

Parameters

Name Type Description Notes
order_load_program_id str Id of orderLoadProgram to be returned.

Return type

OrderLoadProgram

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]