Skip to content

Latest commit

 

History

History
279 lines (200 loc) · 11.6 KB

ShippingContactsApi.md

File metadata and controls

279 lines (200 loc) · 11.6 KB
Raw

conekta.ShippingContactsApi

All URIs are relative to https://api.conekta.io

Method HTTP request Description
create_customer_shipping_contacts POST /customers/{id}/shipping_contacts Create a shipping contacts
delete_customer_shipping_contacts DELETE /customers/{id}/shipping_contacts/{shipping_contacts_id} Delete shipping contacts
update_customer_shipping_contacts PUT /customers/{id}/shipping_contacts/{shipping_contacts_id} Update shipping contacts

create_customer_shipping_contacts

CustomerShippingContactsResponse create_customer_shipping_contacts(id, customer_shipping_contacts, accept_language=accept_language, x_child_company_id=x_child_company_id)

Create a shipping contacts

Create a shipping contacts for a customer.

Example

  • Bearer Authentication (bearerAuth):
import conekta
from conekta.models.customer_shipping_contacts import CustomerShippingContacts
from conekta.models.customer_shipping_contacts_response import CustomerShippingContactsResponse
from conekta.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.conekta.io
# See configuration.py for a list of all supported configuration parameters.
configuration = conekta.Configuration(
    host = "https://api.conekta.io"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: bearerAuth
configuration = conekta.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with conekta.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = conekta.ShippingContactsApi(api_client)
    id = '6307a60c41de27127515a575' # str | Identifier of the resource
    customer_shipping_contacts = conekta.CustomerShippingContacts() # CustomerShippingContacts | requested field for customer shippings contacts
    accept_language = es # str | Use for knowing which language to use (optional) (default to es)
    x_child_company_id = '6441b6376b60c3a638da80af' # str | In the case of a holding company, the company id of the child company to which will process the request. (optional)

    try:
        # Create a shipping contacts
        api_response = api_instance.create_customer_shipping_contacts(id, customer_shipping_contacts, accept_language=accept_language, x_child_company_id=x_child_company_id)
        print("The response of ShippingContactsApi->create_customer_shipping_contacts:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ShippingContactsApi->create_customer_shipping_contacts: %s\n" % e)

Parameters

Name Type Description Notes
id str Identifier of the resource
customer_shipping_contacts CustomerShippingContacts requested field for customer shippings contacts
accept_language str Use for knowing which language to use [optional] [default to es]
x_child_company_id str In the case of a holding company, the company id of the child company to which will process the request. [optional]

Return type

CustomerShippingContactsResponse

Authorization

bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/vnd.conekta-v2.1.0+json

HTTP response details

Status code Description Response headers
200 successful operation -
401 authentication error -
404 not found entity -
422 parameter validation error -
500 internal server error -

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

delete_customer_shipping_contacts

CustomerShippingContactsResponse delete_customer_shipping_contacts(id, shipping_contacts_id, accept_language=accept_language, x_child_company_id=x_child_company_id)

Delete shipping contacts

Delete shipping contact that corresponds to a customer ID.

Example

  • Bearer Authentication (bearerAuth):
import conekta
from conekta.models.customer_shipping_contacts_response import CustomerShippingContactsResponse
from conekta.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.conekta.io
# See configuration.py for a list of all supported configuration parameters.
configuration = conekta.Configuration(
    host = "https://api.conekta.io"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: bearerAuth
configuration = conekta.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with conekta.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = conekta.ShippingContactsApi(api_client)
    id = '6307a60c41de27127515a575' # str | Identifier of the resource
    shipping_contacts_id = '6307a60c41de27127515a575' # str | identifier
    accept_language = es # str | Use for knowing which language to use (optional) (default to es)
    x_child_company_id = '6441b6376b60c3a638da80af' # str | In the case of a holding company, the company id of the child company to which will process the request. (optional)

    try:
        # Delete shipping contacts
        api_response = api_instance.delete_customer_shipping_contacts(id, shipping_contacts_id, accept_language=accept_language, x_child_company_id=x_child_company_id)
        print("The response of ShippingContactsApi->delete_customer_shipping_contacts:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ShippingContactsApi->delete_customer_shipping_contacts: %s\n" % e)

Parameters

Name Type Description Notes
id str Identifier of the resource
shipping_contacts_id str identifier
accept_language str Use for knowing which language to use [optional] [default to es]
x_child_company_id str In the case of a holding company, the company id of the child company to which will process the request. [optional]

Return type

CustomerShippingContactsResponse

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/vnd.conekta-v2.1.0+json

HTTP response details

Status code Description Response headers
200 successful operation -
401 authentication error -
404 not found entity -
422 parameter validation error -
500 internal server error -

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

update_customer_shipping_contacts

CustomerShippingContactsResponse update_customer_shipping_contacts(id, shipping_contacts_id, customer_update_shipping_contacts, accept_language=accept_language, x_child_company_id=x_child_company_id)

Update shipping contacts

Update shipping contact that corresponds to a customer ID.

Example

  • Bearer Authentication (bearerAuth):
import conekta
from conekta.models.customer_shipping_contacts_response import CustomerShippingContactsResponse
from conekta.models.customer_update_shipping_contacts import CustomerUpdateShippingContacts
from conekta.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.conekta.io
# See configuration.py for a list of all supported configuration parameters.
configuration = conekta.Configuration(
    host = "https://api.conekta.io"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: bearerAuth
configuration = conekta.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with conekta.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = conekta.ShippingContactsApi(api_client)
    id = '6307a60c41de27127515a575' # str | Identifier of the resource
    shipping_contacts_id = '6307a60c41de27127515a575' # str | identifier
    customer_update_shipping_contacts = conekta.CustomerUpdateShippingContacts() # CustomerUpdateShippingContacts | requested field for customer update shippings contacts
    accept_language = es # str | Use for knowing which language to use (optional) (default to es)
    x_child_company_id = '6441b6376b60c3a638da80af' # str | In the case of a holding company, the company id of the child company to which will process the request. (optional)

    try:
        # Update shipping contacts
        api_response = api_instance.update_customer_shipping_contacts(id, shipping_contacts_id, customer_update_shipping_contacts, accept_language=accept_language, x_child_company_id=x_child_company_id)
        print("The response of ShippingContactsApi->update_customer_shipping_contacts:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ShippingContactsApi->update_customer_shipping_contacts: %s\n" % e)

Parameters

Name Type Description Notes
id str Identifier of the resource
shipping_contacts_id str identifier
customer_update_shipping_contacts CustomerUpdateShippingContacts requested field for customer update shippings contacts
accept_language str Use for knowing which language to use [optional] [default to es]
x_child_company_id str In the case of a holding company, the company id of the child company to which will process the request. [optional]

Return type

CustomerShippingContactsResponse

Authorization

bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/vnd.conekta-v2.1.0+json

HTTP response details

Status code Description Response headers
200 successful operation -
401 authentication error -
404 not found entity -
422 parameter validation error -
500 internal server error -

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