OMS DOCUMENTATIONRESOURCE CENTER

These guides provide examples for many tasks that a developer will need to be familiar with during implementation.

KIBO OMS DEVELOPMENT

Documentation

Edit Billing Address

This API allows a payment method’s billing address to be changed after the payment case has been created.

Version2.0
Callhttps://integration.shopatron.com/api/v2/payment/action/editBillingAddress
Supported FormatsJSON
HTTP MethodPOST
Schemahttps://integration.shopatron.com/api/v2/schema/payment/action/editBillingAddress.json

The .json address above can be used to access the schema within Postman. An example use of the Edit Billing Address API follows below, or view the schema or the sample Postman Collection.

Example

The example case will make the following address change:

  • Order ID 543210 and Payment ID 012345
  • Set to a shipping address in California

Unlike changing the shipping address of an order, the full address details must be provided instead of merely an Address ID. All required address parameters must be included, even if they are not all being updated.

Required Parameters

The orderID and paymentID must be provided to identify which payment case is being updated.

ParameterTypeDescription
orderIDintegerA unique identifier for the order. The minimum value is “1”.
paymentIDintegerA unique identifier for the payment case. The minimum value is “0”.
billingAddressobjectThe address information being applied to this payment case.

Billing Address Parameters

The required and optional parameters for the billingAddress object are:

ParameterRequiredTypeDescription
firstNameOptionalstringThe first name of the contact at this address. The maximum length is 300 characters.
lastNameOptionalstringThe last name of the contact at this address. The maximum length is 300 characters.
phoneRequiredstringThe phone number of the contact. The minimum length is 1 character and the maximum length is 20 characters.
addressLine1RequiredstringThe first line of the street address. The minimum length is 1 character and the maximum length is 250 characters.
addressLine2OptionalstringThe second line of the street address. The maximum length is 250 characters.
addressLine3OptionalstringThe third line of the street address. The maximum length is 250 characters.
cityRequiredstringThe city that the street address is located in. The minimum length is 1 character and the maximum length is 50 characters.
stateOptionalstringThe state that the street address is located in.
postalCodeOptionalstringThe postal or zip code that the street address is located in. The minimum length is 1 character and the maximum length is 35 characters.
countryCodeRequiredstringThe two-letter code for the country that the street address is located in.
latitudeOptionalnumberThe latitude of the address location. This parameter is read-only and should be manually changed.
longitudeOptionalnumberThe longitude of the address location. This parameter is read-only and should be manually changed.
companyOptionalstringThe company or organization that the contact at this address is associated with. The maximum length is 100 characters.
taxIdOptionalstringA tax identifier primarily used for shipping abroad. The maximum length is 50 characters.

The Full Request

This is the entire request that will update a billing address.

{
    "orderID": 543210,
    "paymentID": 012345,
    "billingAddress": {
          "firstName": "Example",
          "lastName": "Contact",
          "phone": "111-222-3333",
          "addressLine1": "123 San Luis Obispo Ln.",
          "city": "San Luis Obispo",
          "state": "CA",
          "postalCode": "93405",
          "countryCode": "US"
        }
}

The returned response follows the same structure as the Get Payment API, providing information about the payment that was edited.