godaddy.orders
Module godaddy.orders
![](https://bcentral-packageicons.azureedge.net/images/ballerinax_godaddy.orders_1.2.0.png)
ballerinax/godaddy.orders Ballerina library
Overview
This is a generated connector for GoDaddy Orders API v1 OpenAPI specification.
The GoDaddy Orders API provides capability to access GoDaddy operations related to orders.
Prerequisites
Before using this connector in your Ballerina application, complete the following:
- Create an GoDaddy account
- Obtain tokens
- Follow this link to obtain tokens
Clients![](/images/permalink.svg)
godaddy.orders: Client![](/images/permalink.svg)
This is a generated connector for GoDaddy Orders API v1 OpenAPI specification. The GoDaddy Orders API provides capability to access GoDaddy operations related to orders.
Constructor![](/images/permalink.svg)
Gets invoked to initialize the connector
.
The connector initialization requires setting the API credentials.
Create a GoDaddy and obtain tokens by following this guide.
init (ApiKeysConfig apiKeyConfig, ClientConfiguration clientConfig, string serviceUrl)
- apiKeyConfig ApiKeysConfig - API keys for authorization
- clientConfig ClientConfiguration {} - The configurations to be used when initializing the
connector
- serviceUrl string "https://api.ote-godaddy.com/" - URL of the target service
listOrders![](/images/permalink.svg)
function listOrders(string? periodStart, string? periodEnd, string? domain, int? productGroupId, int? paymentProfileId, string? parentOrderId, int offset, int 'limit, string sort, string? xShopperId, string xMarketId) returns OrderList|error
Retrieve a list of orders for the authenticated shopper. Only one filter may be used at a time
Parameters
- periodStart string? (default ()) - Start of range indicating what time-frame should be returned. Inclusive
- periodEnd string? (default ()) - End of range indicating what time-frame should be returned. Inclusive
- domain string? (default ()) - Domain name to use as the filter of results
- productGroupId int? (default ()) - Product group id to use as the filter of results
- paymentProfileId int? (default ()) - Payment profile id to use as the filter of results
- parentOrderId string? (default ()) - Parent order id to use as the filter of results
- offset int (default 0) - Number of results to skip for pagination
- 'limit int (default 25) - Maximum number of items to return
- sort string (default "-createdAt") - Property name that will be used to sort results. '-' indicates descending
- xShopperId string? (default ()) - Shopper ID to be operated on, if different from JWT<br/><b>Reseller subaccounts are not supported</b>
- xMarketId string (default "en-US") - Unique identifier of the Market in which the request is happening
getOrderByID![](/images/permalink.svg)
Retrieve details for specified order
Parameters
- orderId string - Order id whose details are to be retrieved
- xShopperId string? (default ()) - Shopper ID to be operated on, if different from JWT<br/><b>Reseller subaccounts are not supported</b>
- xMarketId string (default "en-US") - Unique identifier of the Market in which the request is happening
Records![](/images/permalink.svg)
godaddy.orders: Address![](/images/permalink.svg)
Fields
- address1 string -
- address2 string? -
- city string -
- country string - Two-letter ISO country code to be used as a hint for target region<br/><br/> NOTE: These are sample values, there are many <a href='http://www.iso.org/iso/country_codes.htm'>more</a>
- postalCode string - Postal or zip code
- state string - State or province or territory
godaddy.orders: ApiKeysConfig![](/images/permalink.svg)
Provides API key configurations needed when communicating with a remote HTTP endpoint.
Fields
- authorization string - Represents API Key 'Authorization'
godaddy.orders: BillTo![](/images/permalink.svg)
Fields
- contact Contact -
- taxId string? - Tax id used for calculating the tax the customer is required to pay
godaddy.orders: Contact![](/images/permalink.svg)
Fields
- addressMailing Address -
- email string -
- fax string? -
- jobTitle string? -
- nameFirst string -
- nameLast string -
- nameMiddle string? -
- organization string? -
- phone string -
godaddy.orders: Error![](/images/permalink.svg)
Fields
- code string - Short identifier for the error, suitable for indicating the specific error within client code
- fields ErrorField[]? - List of the specific fields, and the errors found with their contents
- message string? - Human-readable, English description of the error
godaddy.orders: ErrorField![](/images/permalink.svg)
Fields
- code string - Short identifier for the error, suitable for indicating the specific error within client code
- message string? - Human-readable, English description of the problem with the contents of the field
- path string - <ul> <li style='margin-left: 12px;'>JSONPath referring to a field containing an error</li> <strong style='margin-left: 12px;'>OR</strong> <li style='margin-left: 12px;'>JSONPath referring to a field that refers to an object containing an error, with more detail in `pathRelated`</li> </ul>
- pathRelated string? - JSONPath referring to a field containing an error, which is referenced by
path
godaddy.orders: ErrorLimit![](/images/permalink.svg)
Fields
- code string - Short identifier for the error, suitable for indicating the specific error within client code
- fields ErrorField[]? - List of the specific fields, and the errors found with their contents
- message string? - Human-readable, English description of the error
- retryAfterSec int - Number of seconds to wait before attempting a similar request
godaddy.orders: LineItem![](/images/permalink.svg)
Fields
- domains string[]? - A collection of domain names purchased if the current product is domain
- label string - Human readable description of the current product
- period float? -
- periodUnit string? - The unit of time that periodCount is measured in
- pfid int? - Unique identifier of the current product
- pricing LineItemPricing -
- quantity int - Number of the current product included in the specified order
- taxCollector LineItemTaxCollector? -
godaddy.orders: LineItemPricing![](/images/permalink.svg)
Fields
- discount int - Discount off of sale price for given
quantity
andperiod
<pre>discount
=sale
-subtotal
</pre>
- fees OrderFee -
- list int - List price for given
quantity
andperiod
- sale int - Actual price for the current product
- savings int - Savings off of list price for given
quantity
andperiod
<pre>savings
=list
-subtotal
</pre>
- subtotal int - Price with any discounts and without taxes or fees for given
quantity
andperiod
- taxes int - Taxes for given
quantity
andperiod
- unit record {} - Pricing for a single unit of the given item
godaddy.orders: LineItemPricingTaxDetail![](/images/permalink.svg)
Fields
- amount int? - Tax amount
- rate float? -
godaddy.orders: LineItemSummary![](/images/permalink.svg)
Fields
- label string - Product label of the current line item
godaddy.orders: LineItemTaxCollector![](/images/permalink.svg)
Fields
- taxCollectorId int - Unique identifier for the company
godaddy.orders: LineItemUnitPricing![](/images/permalink.svg)
Fields
- discount int - Discount without consideration of
quantity
andperiod
- fees OrderFee -
- list int - List price without consideration of
quantity
andperiod
- sale int - Sale price without consideration of
quantity
andperiod
- savings int - Savings without consideration of
quantity
andperiod
- taxes int - Taxes without consideration of
quantity
andperiod
godaddy.orders: Order![](/images/permalink.svg)
Fields
- billTo BillTo -
- createdAt string - Date and time when the current order is created on
- currency string - Currency in which the order has been placed
- items LineItem[] -
- orderId string - Unique identifier of current order
- parentOrderId string? - Unique identifier of the parent order. All refund/chargeback orders are tied to the original order.
The orginal order's
orderId
is theparentOrderId
of refund/chargeback orders
- payments Payment[] -
- pricing OrderPricing -
godaddy.orders: OrderFee![](/images/permalink.svg)
Fields
- icann int? - Domain registration transaction fee charged by ICANN
- total int - Sum of all fees
godaddy.orders: OrderList![](/images/permalink.svg)
Fields
- orders OrderSummary[] - A collection of orders
- pagination Pagination -
godaddy.orders: OrderPricing![](/images/permalink.svg)
Fields
- discount int - Discount from promotional pricing
- fees OrderFee -
- id float? -
- list int - Sum of list prices for the entire cart
- savings int - Savings off of list price <pre>
savings
=list
-subtotal
</pre>
- subtotal int - Price with
discount
and without taxes or fees
- taxes int - Taxes for the entire cart
- taxDetails LineItemPricingTaxDetail[]? - A collection of line item tax details
- total int - Price the customer pays <pre>
total
=subtotal
+taxes
+fees.total
</pre>
godaddy.orders: OrderSummary![](/images/permalink.svg)
Fields
- createdAt string - Date and time when the current order was created
- currency string - Currency in which the order was placed
- items LineItemSummary[] - Sets of two or more line items in current order
- orderId int - Unique identifier of the current order
- parentOrderId string? - Unique identifier of the parent order. All refund/chargeback orders are tied to the original order.
The orginal order's
orderId
is theparentOrderId
of refund/chargeback orders
- pricing OrderSummaryPricing -
godaddy.orders: OrderSummaryPricing![](/images/permalink.svg)
Fields
- total string - Total amount charged for the current order. Negative for Refund and Chargeback
godaddy.orders: Pagination![](/images/permalink.svg)
Fields
- first string? - URI to access the first page
- last string? - URI to access the last page
- next string? - URI to access the next page
- previous string? - URI to access the previous page
- total int? - Number of records available
godaddy.orders: Payment![](/images/permalink.svg)
Fields
- amount int - Amount paid by the current payment
- category string - The category of payment method used at the time of purchase. Most common values are listed in the enum.
- paymentProfileId string - Unique identifier of the payment profile used by current payment
- subcategory string? - The subcategory of payment method used at the time of purchase. This field is only set for certain payment categories, such as ACH and CREDIT_CARD. Most common values are listed in the enum.
Import
import ballerinax/godaddy.orders;
Metadata
Released date: over 2 years ago
Version: 1.2.0
License: Apache-2.0
Compatibility
Platform: any
Ballerina version: 2201.0.0
GraalVM compatible: Yes
Pull count
Total: 1
Current verison: 0
Weekly downloads
Keywords
Website & App Building/Website Builders
Cost/Paid
Contributors
Dependencies