Yaksa.OrckestraCommerce.Client.Api.AddressesApi

All URIs are relative to https://dev-ocs-cm.develop.orckestra.cloud/api

Method	HTTP request	Description
GetAddressRequestAddressIdGet	GET /addresses/{AddressId}	Retrieve an address using its Id - {GetAddressRequest}
GetAddressesByIdsRequestbyIdsIdsGet	GET /addresses/byIds/{Ids}	Retrieve a list of addresses by Ids - {GetAddressesByIdsRequest}
GetCustomerAddressRequestcustomerCustomerIdAddressIdGet	GET /addresses/customer/{CustomerId}/{AddressId}	Retrieve an address of a customer using its Id - {GetCustomerAddressRequest}
RemoveAddressRequestAddressIdDelete	DELETE /addresses/{AddressId}	Remove an address - {RemoveAddressRequest}
RemoveCustomerAddressRequestcustomerCustomerIdAddressIdDelete	DELETE /addresses/customer/{CustomerId}/{AddressId}	Remove an address of a customer - {RemoveCustomerAddressRequest}
UpdateAddressRequestAddressIdCreate	PUT /addresses/{AddressId}	Updates an address - {UpdateAddressRequest}
UpdateCustomerAddressRequestcustomerCustomerIdAddressIdCreate	PUT /addresses/customer/{CustomerId}/{AddressId}	Updates a customer address - {UpdateCustomerAddressRequest}

GetAddressRequestAddressIdGet

Address GetAddressRequestAddressIdGet (string accept, string addressId)

Retrieve an address using its Id - {GetAddressRequest}

Retrieve an address using its Id.

Example

using System.Collections.Generic;
using System.Diagnostics;
using Yaksa.OrckestraCommerce.Client.Api;
using Yaksa.OrckestraCommerce.Client.Client;
using Yaksa.OrckestraCommerce.Client.Model;

namespace Example
{
    public class GetAddressRequestAddressIdGetExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://dev-ocs-cm.develop.orckestra.cloud/api";
            var apiInstance = new AddressesApi(config);
            var accept = accept_example;  // string | Accept Header
            var addressId = addressId_example;  // string | The unique identifier of the address.

            try
            {
                // Retrieve an address using its Id - {GetAddressRequest}
                Address result = apiInstance.GetAddressRequestAddressIdGet(accept, addressId);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AddressesApi.GetAddressRequestAddressIdGet: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
accept	string	Accept Header
addressId	string	The unique identifier of the address.

Return type

Address

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
401	You must be authenticated to use this request	-

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

GetAddressesByIdsRequestbyIdsIdsGet

List<Address> GetAddressesByIdsRequestbyIdsIdsGet (string accept, List ids)

Retrieve a list of addresses by Ids - {GetAddressesByIdsRequest}

Retrieve a list of addresses by Ids.

Example

using System.Collections.Generic;
using System.Diagnostics;
using Yaksa.OrckestraCommerce.Client.Api;
using Yaksa.OrckestraCommerce.Client.Client;
using Yaksa.OrckestraCommerce.Client.Model;

namespace Example
{
    public class GetAddressesByIdsRequestbyIdsIdsGetExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://dev-ocs-cm.develop.orckestra.cloud/api";
            var apiInstance = new AddressesApi(config);
            var accept = accept_example;  // string | Accept Header
            var ids = new List<string>(); // List<string> | The list of system-wide unique identifier for the Addresses to retrieve.

            try
            {
                // Retrieve a list of addresses by Ids - {GetAddressesByIdsRequest}
                List<Address> result = apiInstance.GetAddressesByIdsRequestbyIdsIdsGet(accept, ids);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AddressesApi.GetAddressesByIdsRequestbyIdsIdsGet: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
accept	string	Accept Header
ids	List<string>	The list of system-wide unique identifier for the Addresses to retrieve.

Return type

List<Address>

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
401	You must be authenticated to use this request	-

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

GetCustomerAddressRequestcustomerCustomerIdAddressIdGet

Address GetCustomerAddressRequestcustomerCustomerIdAddressIdGet (string accept, string customerId, string addressId)

Retrieve an address of a customer using its Id - {GetCustomerAddressRequest}

Retrieve an address of a customer using its Id

Example

using System.Collections.Generic;
using System.Diagnostics;
using Yaksa.OrckestraCommerce.Client.Api;
using Yaksa.OrckestraCommerce.Client.Client;
using Yaksa.OrckestraCommerce.Client.Model;

namespace Example
{
    public class GetCustomerAddressRequestcustomerCustomerIdAddressIdGetExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://dev-ocs-cm.develop.orckestra.cloud/api";
            var apiInstance = new AddressesApi(config);
            var accept = accept_example;  // string | Accept Header
            var customerId = customerId_example;  // string | The customer identifier.
            var addressId = addressId_example;  // string | The unique identifier of the address.

            try
            {
                // Retrieve an address of a customer using its Id - {GetCustomerAddressRequest}
                Address result = apiInstance.GetCustomerAddressRequestcustomerCustomerIdAddressIdGet(accept, customerId, addressId);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AddressesApi.GetCustomerAddressRequestcustomerCustomerIdAddressIdGet: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description
accept	string	Accept Header
customerId	string	The customer identifier.
addressId	string	The unique identifier of the address.

Return type

Address

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
401	You must be authenticated to use this request	-

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

RemoveAddressRequestAddressIdDelete

void RemoveAddressRequestAddressIdDelete (string accept, string addressId)

Remove an address - {RemoveAddressRequest}

Remove an address.

Example

using System.Collections.Generic;
using System.Diagnostics;
using Yaksa.OrckestraCommerce.Client.Api;
using Yaksa.OrckestraCommerce.Client.Client;
using Yaksa.OrckestraCommerce.Client.Model;

namespace Example
{
    public class RemoveAddressRequestAddressIdDeleteExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://dev-ocs-cm.develop.orckestra.cloud/api";
            var apiInstance = new AddressesApi(config);
            var accept = accept_example;  // string | Accept Header
            var addressId = addressId_example;  // string | The unique identifier of the address.

            try
            {
                // Remove an address - {RemoveAddressRequest}
                apiInstance.RemoveAddressRequestAddressIdDelete(accept, addressId);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AddressesApi.RemoveAddressRequestAddressIdDelete: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
accept	string	Accept Header
addressId	string	The unique identifier of the address.

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	No Content	-

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

RemoveCustomerAddressRequestcustomerCustomerIdAddressIdDelete

void RemoveCustomerAddressRequestcustomerCustomerIdAddressIdDelete (string accept, string customerId, string addressId)

Remove an address of a customer - {RemoveCustomerAddressRequest}

Remove an address of a customer.

Example

using System.Collections.Generic;
using System.Diagnostics;
using Yaksa.OrckestraCommerce.Client.Api;
using Yaksa.OrckestraCommerce.Client.Client;
using Yaksa.OrckestraCommerce.Client.Model;

namespace Example
{
    public class RemoveCustomerAddressRequestcustomerCustomerIdAddressIdDeleteExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://dev-ocs-cm.develop.orckestra.cloud/api";
            var apiInstance = new AddressesApi(config);
            var accept = accept_example;  // string | Accept Header
            var customerId = customerId_example;  // string | The customer identifier.
            var addressId = addressId_example;  // string | The unique identifier of the address.

            try
            {
                // Remove an address of a customer - {RemoveCustomerAddressRequest}
                apiInstance.RemoveCustomerAddressRequestcustomerCustomerIdAddressIdDelete(accept, customerId, addressId);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AddressesApi.RemoveCustomerAddressRequestcustomerCustomerIdAddressIdDelete: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description
accept	string	Accept Header
customerId	string	The customer identifier.
addressId	string	The unique identifier of the address.

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	No Content	-

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

UpdateAddressRequestAddressIdCreate

Address UpdateAddressRequestAddressIdCreate (string accept, string addressId, UpdateAddressRequest body = null)

Updates an address - {UpdateAddressRequest}

Updates an address

Example

using System.Collections.Generic;
using System.Diagnostics;
using Yaksa.OrckestraCommerce.Client.Api;
using Yaksa.OrckestraCommerce.Client.Client;
using Yaksa.OrckestraCommerce.Client.Model;

namespace Example
{
    public class UpdateAddressRequestAddressIdCreateExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://dev-ocs-cm.develop.orckestra.cloud/api";
            var apiInstance = new AddressesApi(config);
            var accept = accept_example;  // string | Accept Header
            var addressId = addressId_example;  // string | Unique identifier
            var body = new UpdateAddressRequest(); // UpdateAddressRequest |  (optional) 

            try
            {
                // Updates an address - {UpdateAddressRequest}
                Address result = apiInstance.UpdateAddressRequestAddressIdCreate(accept, addressId, body);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AddressesApi.UpdateAddressRequestAddressIdCreate: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
accept	string	Accept Header
addressId	string	Unique identifier
body	UpdateAddressRequest		[optional]

Return type

Address

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
401	You must be authenticated to use this request	-

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

UpdateCustomerAddressRequestcustomerCustomerIdAddressIdCreate

Address UpdateCustomerAddressRequestcustomerCustomerIdAddressIdCreate (string accept, string customerId, string addressId, UpdateCustomerAddressRequest body = null)

Updates a customer address - {UpdateCustomerAddressRequest}

Updates a customer address

Example

using System.Collections.Generic;
using System.Diagnostics;
using Yaksa.OrckestraCommerce.Client.Api;
using Yaksa.OrckestraCommerce.Client.Client;
using Yaksa.OrckestraCommerce.Client.Model;

namespace Example
{
    public class UpdateCustomerAddressRequestcustomerCustomerIdAddressIdCreateExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://dev-ocs-cm.develop.orckestra.cloud/api";
            var apiInstance = new AddressesApi(config);
            var accept = accept_example;  // string | Accept Header
            var customerId = customerId_example;  // string | The customer identifier.
            var addressId = addressId_example;  // string | Unique identifier
            var body = new UpdateCustomerAddressRequest(); // UpdateCustomerAddressRequest |  (optional) 

            try
            {
                // Updates a customer address - {UpdateCustomerAddressRequest}
                Address result = apiInstance.UpdateCustomerAddressRequestcustomerCustomerIdAddressIdCreate(accept, customerId, addressId, body);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AddressesApi.UpdateCustomerAddressRequestcustomerCustomerIdAddressIdCreate: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
accept	string	Accept Header
customerId	string	The customer identifier.
addressId	string	Unique identifier
body	UpdateCustomerAddressRequest		[optional]

Return type

Address

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
401	You must be authenticated to use this request	-

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

Files

AddressesApi.md

Latest commit

History

AddressesApi.md

File metadata and controls

Yaksa.OrckestraCommerce.Client.Api.AddressesApi

GetAddressRequestAddressIdGet

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

GetAddressesByIdsRequestbyIdsIdsGet

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

GetCustomerAddressRequestcustomerCustomerIdAddressIdGet

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

RemoveAddressRequestAddressIdDelete

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

RemoveCustomerAddressRequestcustomerCustomerIdAddressIdDelete

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

UpdateAddressRequestAddressIdCreate

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

UpdateCustomerAddressRequestcustomerCustomerIdAddressIdCreate

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details