floriday_supplier_client.BlanketOrdersApi

All URIs are relative to https://api.staging.floriday.io/suppliers-api-2024v1

Method	HTTP request	Description
add_blanket_order	POST /blanket-orders	contract:write - Creates a blanket order
delete_blanket_order	DELETE /blanket-orders/{blanketOrderId}	contract:write - Deletes a blanket order.
edit_blanket_order	PUT /blanket-orders/{blanketOrderId}	contract:write - Modifies an existing blanket order.
get_blanket_order_by_id	GET /blanket-orders/{blanketOrderId}	contract:read - Returns a blanket order by id.
get_blanket_orders_by_sequence_number	GET /blanket-orders/sync/{sequenceNumber}	contract:read - rate limit: 3.4 per second - burst limit: 1000 - Returns a list of max 1000 contracts starting from a specified sequence number.
get_blanket_orders_max_sequence	GET /blanket-orders/current-max-sequence	contract:read - rate limit: 3.4 per second - burst limit: 1000 - Returns the maximum sequence number found in blanket orders.
set_blanket_order_approved	PATCH /blanket-orders/{blanketOrderId}/approve	contract:write - Approves a blanket order

add_blanket_order

add_blanket_order(body)

contract:write - Creates a blanket order

Example

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

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

# create an instance of the API class
api_instance = floriday_supplier_client.BlanketOrdersApi(floriday_supplier_client.ApiClient(configuration))
body = floriday_supplier_client.AddBlanketOrder() # AddBlanketOrder | 

try:
    # contract:write - Creates a blanket order
    api_instance.add_blanket_order(body)
except ApiException as e:
    print("Exception when calling BlanketOrdersApi->add_blanket_order: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	AddBlanketOrder

Return type

void (empty response body)

Authorization

[JWT Token](../README.md#JWT Token), X-Api-Key

HTTP request headers

Content-Type: application/json-patch+json, application/json, text/json, application/*+json
Accept: text/plain, application/json, text/json

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

delete_blanket_order

delete_blanket_order(blanket_order_id)

contract:write - Deletes a blanket order.

Example

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

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

# create an instance of the API class
api_instance = floriday_supplier_client.BlanketOrdersApi(floriday_supplier_client.ApiClient(configuration))
blanket_order_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | 

try:
    # contract:write - Deletes a blanket order.
    api_instance.delete_blanket_order(blanket_order_id)
except ApiException as e:
    print("Exception when calling BlanketOrdersApi->delete_blanket_order: %s\n" % e)

Parameters

Name	Type	Description	Notes
blanket_order_id	str

Return type

void (empty response body)

Authorization

[JWT Token](../README.md#JWT Token), X-Api-Key

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

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

edit_blanket_order

edit_blanket_order(body, blanket_order_id)

contract:write - Modifies an existing blanket order.

Example

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

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

# create an instance of the API class
api_instance = floriday_supplier_client.BlanketOrdersApi(floriday_supplier_client.ApiClient(configuration))
body = floriday_supplier_client.EditBlanketOrder() # EditBlanketOrder | 
blanket_order_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | 

try:
    # contract:write - Modifies an existing blanket order.
    api_instance.edit_blanket_order(body, blanket_order_id)
except ApiException as e:
    print("Exception when calling BlanketOrdersApi->edit_blanket_order: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	EditBlanketOrder
blanket_order_id	str

Return type

void (empty response body)

Authorization

[JWT Token](../README.md#JWT Token), X-Api-Key

HTTP request headers

Content-Type: application/json-patch+json, application/json, text/json, application/*+json
Accept: text/plain, application/json, text/json

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

get_blanket_order_by_id

BlanketOrder get_blanket_order_by_id(blanket_order_id)

contract:read - Returns a blanket order by id.

Example

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

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

# create an instance of the API class
api_instance = floriday_supplier_client.BlanketOrdersApi(floriday_supplier_client.ApiClient(configuration))
blanket_order_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | 

try:
    # contract:read - Returns a blanket order by id.
    api_response = api_instance.get_blanket_order_by_id(blanket_order_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BlanketOrdersApi->get_blanket_order_by_id: %s\n" % e)

Parameters

Name	Type	Description	Notes
blanket_order_id	str

Return type

BlanketOrder

Authorization

[JWT Token](../README.md#JWT Token), X-Api-Key

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

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

get_blanket_orders_by_sequence_number

SyncResultOfBlanketOrder get_blanket_orders_by_sequence_number(sequence_number, limit_result=limit_result)

contract:read - rate limit: 3.4 per second - burst limit: 1000 - Returns a list of max 1000 contracts starting from a specified sequence number.

Synchronization endpoint Fetches the succeeding modified records (including deleted records) based on Limit and the given SequenceNumber. Note Your data is up to date when your given SequenceNumber is equal to the received MaximumSequenceNumber.

Example

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

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

# create an instance of the API class
api_instance = floriday_supplier_client.BlanketOrdersApi(floriday_supplier_client.ApiClient(configuration))
sequence_number = 789 # int | 
limit_result = 1000 # int |  (optional) (default to 1000)

try:
    # contract:read - rate limit: 3.4 per second - burst limit: 1000 - Returns a list of max 1000 contracts starting from a specified sequence number.
    api_response = api_instance.get_blanket_orders_by_sequence_number(sequence_number, limit_result=limit_result)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BlanketOrdersApi->get_blanket_orders_by_sequence_number: %s\n" % e)

Parameters

Name	Type	Description	Notes
sequence_number	int
limit_result	int		[optional] [default to 1000]

Return type

SyncResultOfBlanketOrder

Authorization

[JWT Token](../README.md#JWT Token), X-Api-Key

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

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

get_blanket_orders_max_sequence

int get_blanket_orders_max_sequence()

contract:read - rate limit: 3.4 per second - burst limit: 1000 - Returns the maximum sequence number found in blanket orders.

Example

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

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

# create an instance of the API class
api_instance = floriday_supplier_client.BlanketOrdersApi(floriday_supplier_client.ApiClient(configuration))

try:
    # contract:read - rate limit: 3.4 per second - burst limit: 1000 - Returns the maximum sequence number found in blanket orders.
    api_response = api_instance.get_blanket_orders_max_sequence()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BlanketOrdersApi->get_blanket_orders_max_sequence: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

int

Authorization

[JWT Token](../README.md#JWT Token), X-Api-Key

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

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

set_blanket_order_approved

set_blanket_order_approved(blanket_order_id)

contract:write - Approves a blanket order

Example

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

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

# create an instance of the API class
api_instance = floriday_supplier_client.BlanketOrdersApi(floriday_supplier_client.ApiClient(configuration))
blanket_order_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | 

try:
    # contract:write - Approves a blanket order
    api_instance.set_blanket_order_approved(blanket_order_id)
except ApiException as e:
    print("Exception when calling BlanketOrdersApi->set_blanket_order_approved: %s\n" % e)

Parameters

Name	Type	Description	Notes
blanket_order_id	str

Return type

void (empty response body)

Authorization

[JWT Token](../README.md#JWT Token), X-Api-Key

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

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

Files

BlanketOrdersApi.md

Latest commit

History

BlanketOrdersApi.md

File metadata and controls

floriday_supplier_client.BlanketOrdersApi

add_blanket_order

Example

Parameters

Return type

Authorization

HTTP request headers

delete_blanket_order

Example

Parameters

Return type

Authorization

HTTP request headers

edit_blanket_order

Example

Parameters

Return type

Authorization

HTTP request headers

get_blanket_order_by_id

Example

Parameters

Return type

Authorization

HTTP request headers

get_blanket_orders_by_sequence_number

Example

Parameters

Return type

Authorization

HTTP request headers

get_blanket_orders_max_sequence

Example

Parameters

Return type

Authorization

HTTP request headers

set_blanket_order_approved

Example

Parameters

Return type

Authorization

HTTP request headers