Shop Configuration

The in and out's of setting up your shop's configuration.

Billing From Address

  • line_1

  • line_2

  • city

  • stateProvinceRegion

  • zipPostalCode

  • country

The billing from address is the headquartered location for the shop. This address is required to be valid and updated to gain access to processing payments or maintaining access to processing payments for your shop.

Dispute Contact

  • name

  • email

  • phone

The dispute contact information is our first go-to in the event of fraud detection or legal issues that may arise. This information is required to be valid and updated to gain access to processing payments or maintaining access to processing payments for your shop.

Shipping From Address

The shipping from address is the default location to which your shop is shipping physical product to your customers. This information is currently not required, and not being used. Shipping rate calculation has not been fully integrated into the platform yet.

Options

The options is designed to allow flexibility and remove opinionated design from eCommerce. You may expand on your shop's configuration by enabling options and submitting an array of further options for your shop. These are only stored and not processed on our platform, and is up to you to maintain the options field.

Managing Inventory

This field is defaulted to true, setting this to false will not adjust product quantity at checkout. This field is intended for digital products or if you already have a inventory management system in place and integrating our resources into your existing system.

Default Currency

This field is defaulted to USD and used by the Gateway Resource during the transaction process to charge for an order that was created at checkout. This default value can be overridden at checkout.

Note - Dynamic checkout currency is currently disabled and defaulted to USD.

Currencies

This is a fail safe for the shop's transaction process. A cart can be checked out with overridden currency value, however the currency must be within the currencies array.

get
Get Your Shops Configuration

https://shop.yordadev.network/v1/config
This endpoint allows you to fetch your shops configuration.
Request
Response
Request
Headers
Authorization
required
string
Your Personal Access Token
Query Parameters
shop_id
required
string
The shop_id to which the shop you desire
Response
200: OK
Cake successfully retrieved.
{ "name": "Cake's name", "recipe": "Cake's recipe name", "cake": "Binary cake"}
404: Not Found
Could not find a cake matching this query.
{ "message": "Ain't no cake like that."}

put
Updating your Shops Configuration

https://shop.yordadev.network/v1/config
This endpoint allows you to update your shops configuration. Please note that the only field that is required is the shop_id. The fields in dispute_contact, billing_from, and shipping_from array's are only required if the array is included.
Request
Response
Request
Headers
Authorization
required
string
Your Personal Access Token
Query Parameters
shop_id
required
string
The desired shops shop_id to be updated
default_currency
optional
string
The default currency that will be used to process payments with. Defaults to USD
currencies
optional
array
Available currencies to allow to process transaction payments with.
enable_options
optional
boolean
Enable options array to expand the shops configuration with your own settings. Defaults to False
manage_inventory
optional
boolean
Manage the shops inventory quantities Defaults to False
dispute_contact
optional
array
Array of dispute contact information.
name
required
string
dispute_contact[name]
email
required
string
dispute_contact[email]
phone
required
string
dispute_contact[phone]
billing_from
optional
array
Address of the shop's headquarters location.
line_1
required
string
billing_from[line_1]
line_2
optional
string
billing_from[line_2]
city
required
string
billing_from[city]
country
required
string
billing_from[country]
zipPostalCode
required
string
billing_from[zipPostalCode]
shipping_from
optional
array
Address to which shipments are coming from.
line_1
required
string
shipping_from[line_1]
line_2
required
string
shipping_from[line_2]
city
required
string
shipping_from[city]
stateProvinceRegion
required
string
shipping_from[StateProvinceRegion]
country
required
string
shipping_from[country]
zipPostalCode
required
string
shipping_from[zipPostalCode]
options
optional
array
An array of additional, expandable, flexiable options for your shop.
Response
200: OK