Jump to

• Request
• Response

Create customer, addresses, and contacts for usage on sales orders

post

/fscmRestApi/fom/11.13.18.05/customerForSalesOrders/createCustomer

Create customer, addresses, and contacts for usage on sales orders.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Values that describe the create customer service.

Show Source

• billTo: object billTo
  Values that describe the Bill-to-account. It is applicable when billing accounts or invoice recipients are being created or managed separately. For schema, refer section BillToRequest.
• caseSensitiveSearch: boolean
  Searches are case-insensitive by default (false). To enable a case-sensitive search, set this option to true.
• considerNulls: boolean
  This option, applicable to Person, Contact, and Address fields, controls whether null values are included in searches. By default (false), they are not; set it to true to enable their inclusion.
• createCustomerRelationships: boolean
  This flag, enables the creation of relationships between sold-to and ship-to parties. By default (false), relationship is not created; set it to true to enable relationship creation.
• manualCustomerNumberingFlag: boolean
  To enable custom numbering for parties, party sites, and accounts, set it to true. By default (false), the system will auto-generate these numbers for you.
• shipTo: object shipTo
  Values that describe the Ship-to-party. It is useful in cases where shipping destinations need to be defined independently of the primary customer record. For schema, refer section ShipToRequest.
• soldTo: object soldTo
  Values that describe the Sold-to-party. It is typically used when establishing a primary customer entity without immediate need for billing or shipping details or contact detail. For schema, refer section SoldToRequest.

{
    "type":"object",
    "description":"Values that describe the create customer service.",
    "properties":{
        "caseSensitiveSearch":{
            "type":"boolean",
            "description":"Searches are case-insensitive by default (false). To enable a case-sensitive search, set this option to true."
        },
        "considerNulls":{
            "type":"boolean",
            "description":"This option, applicable to Person, Contact, and Address fields, controls whether null values are included in searches. By default (false), they are not; set it to true to enable their inclusion."
        },
        "manualCustomerNumberingFlag":{
            "type":"boolean",
            "description":"To enable custom numbering for parties, party sites, and accounts, set it to true. By default (false), the system will auto-generate these numbers for you."
        },
        "createCustomerRelationships":{
            "type":"boolean",
            "description":"This flag, enables the creation of relationships between sold-to and ship-to parties. By default (false), relationship is not created; set it to true to enable relationship creation."
        },
        "soldTo":{
            "type":"object",
            "items":{
                "$ref":"#/components/schemas/SoldToRequest"
            },
            "description":"Values that describe the Sold-to-party. It is typically used when establishing a primary customer entity without immediate need for billing or shipping details or contact detail. For schema, refer section SoldToRequest."
        },
        "shipTo":{
            "type":"object",
            "items":{
                "$ref":"#/components/schemas/ShipToRequest"
            },
            "description":"Values that describe the Ship-to-party. It is useful in cases where shipping destinations need to be defined independently of the primary customer record. For schema, refer section ShipToRequest."
        },
        "billTo":{
            "type":"object",
            "items":{
                "$ref":"#/components/schemas/BillToRequest"
            },
            "description":"Values that describe the Bill-to-account. It is applicable when billing accounts or invoice recipients are being created or managed separately. For schema, refer section BillToRequest."
        }
    },
    "xml":{
        "name":"CustomerRequest"
    }
}

Nested Schema : billTo

Type: object

Values that describe the Bill-to-account. It is applicable when billing accounts or invoice recipients are being created or managed separately. For schema, refer section BillToRequest.

Show Source

• Array of: object BillToRequest
  Values that describe the bill-to-account.

{
    "type":"object",
    "items":{
        "$ref":"#/components/schemas/BillToRequest"
    },
    "description":"Values that describe the Bill-to-account. It is applicable when billing accounts or invoice recipients are being created or managed separately. For schema, refer section BillToRequest."
}

Nested Schema : shipTo

Type: object

Values that describe the Ship-to-party. It is useful in cases where shipping destinations need to be defined independently of the primary customer record. For schema, refer section ShipToRequest.

Show Source

• Array of: object ShipToRequest
  Values that describe the ship-to-party.

{
    "type":"object",
    "items":{
        "$ref":"#/components/schemas/ShipToRequest"
    },
    "description":"Values that describe the Ship-to-party. It is useful in cases where shipping destinations need to be defined independently of the primary customer record. For schema, refer section ShipToRequest."
}

Nested Schema : soldTo

Type: object

Values that describe the Sold-to-party. It is typically used when establishing a primary customer entity without immediate need for billing or shipping details or contact detail. For schema, refer section SoldToRequest.

Show Source

• Array of: object SoldToRequest
  Values that describe the sold-to-party.

{
    "type":"object",
    "items":{
        "$ref":"#/components/schemas/SoldToRequest"
    },
    "description":"Values that describe the Sold-to-party. It is typically used when establishing a primary customer entity without immediate need for billing or shipping details or contact detail. For schema, refer section SoldToRequest."
}

Nested Schema : BillToRequest

Type: object

Values that describe the bill-to-account.

Show Source

• address: object address
  Address of the party. For schema, refer section AddressRequest.
• contact: object contact
  Contact of the party. For schema, refer section PersonRequest.
• organizationAccount: object organizationAccount
  Organization account details. For schema, refer section OrganizationAccountRequest.
• partyType: string
  The type of party account being created. It can only be ORGANIZATION or PERSON.
• personAccount: object personAccount
  Person account details. For schema, refer section PersonAccountRequest.

{
    "type":"object",
    "description":"Values that describe the bill-to-account.",
    "properties":{
        "partyType":{
            "type":"string",
            "description":"The type of party account being created. It can only be ORGANIZATION or PERSON."
        },
        "organizationAccount":{
            "type":"object",
            "items":{
                "$ref":"#/components/schemas/OrganizationAccountRequest"
            },
            "description":"Organization account details. For schema, refer section OrganizationAccountRequest."
        },
        "personAccount":{
            "type":"object",
            "items":{
                "$ref":"#/components/schemas/PersonAccountRequest"
            },
            "description":"Person account details. For schema, refer section PersonAccountRequest."
        },
        "contact":{
            "type":"object",
            "items":{
                "$ref":"#/components/schemas/PersonRequest"
            },
            "description":"Contact of the party. For schema, refer section PersonRequest."
        },
        "address":{
            "type":"object",
            "items":{
                "$ref":"#/components/schemas/AddressRequest"
            },
            "description":"Address of the party. For schema, refer section AddressRequest."
        }
    },
    "xml":{
        "name":"BillToRequest"
    }
}

Nested Schema : address

Type: object

Address of the party. For schema, refer section AddressRequest.

Show Source

• Array of: object AddressRequest
  Values that describe the address.

{
    "type":"object",
    "items":{
        "$ref":"#/components/schemas/AddressRequest"
    },
    "description":"Address of the party. For schema, refer section AddressRequest."
}

Nested Schema : contact

Type: object

Contact of the party. For schema, refer section PersonRequest.

Show Source

• Array of: object PersonRequest
  Values that describe the person.

{
    "type":"object",
    "items":{
        "$ref":"#/components/schemas/PersonRequest"
    },
    "description":"Contact of the party. For schema, refer section PersonRequest."
}

Nested Schema : organizationAccount

Type: object

Organization account details. For schema, refer section OrganizationAccountRequest.

Show Source

• Array of: object OrganizationAccountRequest
  Values that describe the organization account.

{
    "type":"object",
    "items":{
        "$ref":"#/components/schemas/OrganizationAccountRequest"
    },
    "description":"Organization account details. For schema, refer section OrganizationAccountRequest."
}

Nested Schema : personAccount

Type: object

Person account details. For schema, refer section PersonAccountRequest.

Show Source

• Array of: object PersonAccountRequest
  Values that describe the Person

{
    "type":"object",
    "items":{
        "$ref":"#/components/schemas/PersonAccountRequest"
    },
    "description":"Person account details. For schema, refer section PersonAccountRequest."
}

Nested Schema : AddressRequest

Type: object

Values that describe the address.

Show Source

• addressLine1: string
  First line for address.
• addressLine2: string
  Second line for address.
• addressLine3: string
  Third line for address.
• addressLine4: string
  Fourth line for address.
• city: string
  The name of the city or locality in which the address is located.
• country: string
  The name or ISO code of the country. This is a required field and drives address validation logic and country-specific formatting rules.
• county: string
  A sub-region within a state or province, applicable in some countries for more granular geographic segmentation. This field may be optional depending on the country.
• partySiteNumber: string
  Party site number of the associated address.
• province: string
  Used primarily for countries where the term province is used instead of or in addition to state (e.g., Canada, China). This can be used in conjunction with or instead of the State field depending on the country.
• state: string
  The state, province, or region applicable to the address. This field is typically used in countries where states are standard (e.g., the United States, India, Australia).
• zipCode: string
  A postal or zip code used for mail sorting and delivery. This is often required for validating the address and enabling accurate shipping and billing.

{
    "type":"object",
    "description":"Values that describe the address.",
    "properties":{
        "partySiteNumber":{
            "type":"string",
            "description":"Party site number of the associated address."
        },
        "addressLine1":{
            "type":"string",
            "description":"First line for address."
        },
        "addressLine2":{
            "type":"string",
            "description":"Second line for address."
        },
        "addressLine3":{
            "type":"string",
            "description":"Third line for address."
        },
        "addressLine4":{
            "type":"string",
            "description":"Fourth line for address."
        },
        "city":{
            "type":"string",
            "description":"The name of the city or locality in which the address is located."
        },
        "state":{
            "type":"string",
            "description":"The state, province, or region applicable to the address. This field is typically used in countries where states are standard (e.g., the United States, India, Australia)."
        },
        "zipCode":{
            "type":"string",
            "description":"A postal or zip code used for mail sorting and delivery. This is often required for validating the address and enabling accurate shipping and billing."
        },
        "province":{
            "type":"string",
            "description":"Used primarily for countries where the term province is used instead of or in addition to state (e.g., Canada, China). This can be used in conjunction with or instead of the State field depending on the country."
        },
        "county":{
            "type":"string",
            "description":"A sub-region within a state or province, applicable in some countries for more granular geographic segmentation. This field may be optional depending on the country."
        },
        "country":{
            "type":"string",
            "description":"The name or ISO code of the country. This is a required field and drives address validation logic and country-specific formatting rules."
        }
    },
    "xml":{
        "name":"AddressRequest"
    }
}

Nested Schema : PersonRequest

Type: object

Values that describe the person.

Show Source

• email: string
  Email address of the person party.
• firstName: string
  The first name of the individual.
• lastName: string
  The last name (or surname) of the individual.
• middleName: string
  The middle name of the individual.
• nameSuffix: string
  Indicates the place in a family structure. Any suffix that might follow the individual???s name, such as Jr. or III.
• partyNumber: string
  Unique identification number for the person party.
• title: string
  A professional or family title of the individual, such as Mr., Dr., or Ms.

{
    "type":"object",
    "description":"Values that describe the person.",
    "properties":{
        "partyNumber":{
            "type":"string",
            "description":"Unique identification number for the person party."
        },
        "email":{
            "type":"string",
            "description":"Email address of the person party."
        },
        "firstName":{
            "type":"string",
            "description":"The first name of the individual."
        },
        "lastName":{
            "type":"string",
            "description":"The last name (or surname) of the individual."
        },
        "middleName":{
            "type":"string",
            "description":"The middle name of the individual."
        },
        "nameSuffix":{
            "type":"string",
            "description":"Indicates the place in a family structure. Any suffix that might follow the individual???s name, such as Jr. or III."
        },
        "title":{
            "type":"string",
            "description":"A professional or family title of the individual, such as Mr., Dr., or Ms."
        }
    },
    "xml":{
        "name":"PersonRequest"
    }
}

Nested Schema : OrganizationAccountRequest

Type: object

Values that describe the organization account.

Show Source

• accountDescription: string
  Account description chosen for the organization party.
• accountNumber: string
  Account number of the organization party.
• email: string
  E-mail address of the organization party.
• name: string
  Name of the organization.
• partyNumber: string
  Unique identification number for the organization party.

{
    "type":"object",
    "description":"Values that describe the organization account.",
    "properties":{
        "partyNumber":{
            "type":"string",
            "description":"Unique identification number for the organization party."
        },
        "email":{
            "type":"string",
            "description":"E-mail address of the organization party."
        },
        "name":{
            "type":"string",
            "description":"Name of the organization."
        },
        "accountNumber":{
            "type":"string",
            "description":"Account number of the organization party."
        },
        "accountDescription":{
            "type":"string",
            "description":"Account description chosen for the organization party."
        }
    },
    "xml":{
        "name":"OrganizationAccountRequest"
    }
}

Nested Schema : PersonAccountRequest

Type: object

Values that describe the Person

Show Source

• accountDescription: string
  Account description chosen for the person party.
• accountNumber: string
  Account Number of the organization party.
• email: string
  E-mail address of the person party.
• firstName: string
  The first name of the individual.
• lastName: string
  The last name (or surname) of the individual.
• middleName: string
  The middle name of the individual.
• nameSuffix: string
  Indicates the place in a family structure. Any suffix that might follow the individual???s name, such as Jr. or III.
• partyNumber: string
  Unique identification number for the person party.
• title: string
  A professional or family title of the individual, such as Mr., Dr., or Ms.

{
    "type":"object",
    "description":"Values that describe the Person",
    "properties":{
        "partyNumber":{
            "type":"string",
            "description":"Unique identification number for the person party."
        },
        "email":{
            "type":"string",
            "description":"E-mail address of the person party."
        },
        "firstName":{
            "type":"string",
            "description":"The first name of the individual."
        },
        "lastName":{
            "type":"string",
            "description":"The last name (or surname) of the individual."
        },
        "middleName":{
            "type":"string",
            "description":"The middle name of the individual."
        },
        "nameSuffix":{
            "type":"string",
            "description":"Indicates the place in a family structure. Any suffix that might follow the individual???s name, such as Jr. or III."
        },
        "title":{
            "type":"string",
            "description":"A professional or family title of the individual, such as Mr., Dr., or Ms."
        },
        "accountNumber":{
            "type":"string",
            "description":"Account Number of the organization party."
        },
        "accountDescription":{
            "type":"string",
            "description":"Account description chosen for the person party."
        }
    },
    "xml":{
        "name":"PersonAccountRequest"
    }
}

Nested Schema : ShipToRequest

Type: object

Values that describe the ship-to-party.

Show Source

• address: object address
  Address of the party. For schema, refer section AddressRequest.
• contact: object contact
  Contact of the party. For schema, refer section PersonRequest.
• organizationParty: object organizationParty
  Organization party details. For schema, refer section OrganizationRequest.
• partyType: string
  The type of party being created. It can only be ORGANIZATION or PERSON.
• personParty: object personParty
  Person party details. For schema, refer section PersonRequest.

{
    "type":"object",
    "description":"Values that describe the ship-to-party.",
    "properties":{
        "partyType":{
            "type":"string",
            "description":"The type of party being created. It can only be ORGANIZATION or PERSON."
        },
        "organizationParty":{
            "type":"object",
            "items":{
                "$ref":"#/components/schemas/OrganizationRequest"
            },
            "description":"Organization party details. For schema, refer section OrganizationRequest."
        },
        "personParty":{
            "type":"object",
            "items":{
                "$ref":"#/components/schemas/PersonRequest"
            },
            "description":"Person party details. For schema, refer section PersonRequest."
        },
        "contact":{
            "type":"object",
            "items":{
                "$ref":"#/components/schemas/PersonRequest"
            },
            "description":"Contact of the party. For schema, refer section PersonRequest."
        },
        "address":{
            "type":"object",
            "items":{
                "$ref":"#/components/schemas/AddressRequest"
            },
            "description":"Address of the party. For schema, refer section AddressRequest."
        }
    },
    "xml":{
        "name":"ShipToRequest"
    }
}

Nested Schema : address

Type: object

Address of the party. For schema, refer section AddressRequest.

Show Source

• Array of: object AddressRequest
  Values that describe the address.

{
    "type":"object",
    "items":{
        "$ref":"#/components/schemas/AddressRequest"
    },
    "description":"Address of the party. For schema, refer section AddressRequest."
}

Nested Schema : contact

Type: object

Contact of the party. For schema, refer section PersonRequest.

Show Source

• Array of: object PersonRequest
  Values that describe the person.

{
    "type":"object",
    "items":{
        "$ref":"#/components/schemas/PersonRequest"
    },
    "description":"Contact of the party. For schema, refer section PersonRequest."
}

Nested Schema : organizationParty

Type: object

Organization party details. For schema, refer section OrganizationRequest.

Show Source

• Array of: object OrganizationRequest
  Values that describe the organization.

{
    "type":"object",
    "items":{
        "$ref":"#/components/schemas/OrganizationRequest"
    },
    "description":"Organization party details. For schema, refer section OrganizationRequest."
}

Nested Schema : personParty

Type: object

Person party details. For schema, refer section PersonRequest.

Show Source

• Array of: object PersonRequest
  Values that describe the person.

{
    "type":"object",
    "items":{
        "$ref":"#/components/schemas/PersonRequest"
    },
    "description":"Person party details. For schema, refer section PersonRequest."
}

Nested Schema : OrganizationRequest

Type: object

Values that describe the organization.

Show Source

• email: string
  E-mail address of the organization party
• name: string
  Name of the organization.
• partyNumber: string
  Unique identification number for the organization party.

{
    "type":"object",
    "description":"Values that describe the organization.",
    "properties":{
        "partyNumber":{
            "type":"string",
            "description":"Unique identification number for the organization party."
        },
        "email":{
            "type":"string",
            "description":"E-mail address of the organization party"
        },
        "name":{
            "type":"string",
            "description":"Name of the organization."
        }
    },
    "xml":{
        "name":"OrganizationRequest"
    }
}

Nested Schema : SoldToRequest

Type: object

Values that describe the sold-to-party.

Show Source

• contact: object contact
  Contact of the party. For schema, refer section PersonRequest.
• organizationParty: object organizationParty
  Organization party details. For schema, refer section OrganizationRequest.
• partyType: string
  The type of party being created. It can only be ORGANIZATION or PERSON.
• personParty: object personParty
  Person party details. For schema, refer section PersonRequest.

{
    "type":"object",
    "description":"Values that describe the sold-to-party.",
    "properties":{
        "partyType":{
            "type":"string",
            "description":"The type of party being created. It can only be ORGANIZATION or PERSON."
        },
        "organizationParty":{
            "type":"object",
            "items":{
                "$ref":"#/components/schemas/OrganizationRequest"
            },
            "description":"Organization party details. For schema, refer section OrganizationRequest."
        },
        "personParty":{
            "type":"object",
            "items":{
                "$ref":"#/components/schemas/PersonRequest"
            },
            "description":"Person party details. For schema, refer section PersonRequest."
        },
        "contact":{
            "type":"object",
            "items":{
                "$ref":"#/components/schemas/PersonRequest"
            },
            "description":"Contact of the party. For schema, refer section PersonRequest."
        }
    },
    "xml":{
        "name":"SoldToRequest"
    }
}

Nested Schema : contact

Type: object

Contact of the party. For schema, refer section PersonRequest.

Show Source

• Array of: object PersonRequest
  Values that describe the person.

{
    "type":"object",
    "items":{
        "$ref":"#/components/schemas/PersonRequest"
    },
    "description":"Contact of the party. For schema, refer section PersonRequest."
}

Nested Schema : organizationParty

Type: object

Organization party details. For schema, refer section OrganizationRequest.

Show Source

• Array of: object OrganizationRequest
  Values that describe the organization.

{
    "type":"object",
    "items":{
        "$ref":"#/components/schemas/OrganizationRequest"
    },
    "description":"Organization party details. For schema, refer section OrganizationRequest."
}

Nested Schema : personParty

Type: object

Person party details. For schema, refer section PersonRequest.

Show Source

• Array of: object PersonRequest
  Values that describe the person.

{
    "type":"object",
    "items":{
        "$ref":"#/components/schemas/PersonRequest"
    },
    "description":"Person party details. For schema, refer section PersonRequest."
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Customer information successfully.

Body ()

Root Schema : CustomerResponse

Type: object

Values that describe the create customer service.

Show Source

• billTo: object billTo
  Values that describe the Bill-to-account. It is applicable when billing accounts or invoice recipients are being created or managed separately. For schema, refer section BillToResponse.
• caseSensitiveSearch: boolean
  Searches are case-insensitive by default (false). To enable a case-sensitive search, set this option to true.
• considerNulls: boolean
  This option, applicable to Person, Contact, and Address fields, controls whether null values are included in searches. By default (false), they are not; set it to true to enable their inclusion.
• createCustomerRelationships: boolean
  This flag, enables the creation of relationships between sold-to and ship-to parties. By default (false), relationship is not created; set it to true to enable relationship creation.
• errors: array errors
  List of errors.
• manualCustomerNumberingFlag: boolean
  To enable custom numbering for parties, party sites, and accounts, set it to true. By default (false), the system will auto-generate these numbers for you.
• shipTo: object shipTo
  Values that describe the Ship-to-party. It is useful in cases where shipping destinations need to be defined independently of the primary customer record. For schema, refer section ShipToResponse.
• soldTo: object soldTo
  Values that describe the Sold-to-party. It is typically used when establishing a primary customer entity without immediate need for billing or shipping details or contact detail. For schema, refer section SoldToResponse.

{
    "type":"object",
    "description":"Values that describe the create customer service.",
    "properties":{
        "errors":{
            "type":"array",
            "items":{
                "type":"string"
            },
            "description":"List of errors."
        },
        "caseSensitiveSearch":{
            "type":"boolean",
            "description":"Searches are case-insensitive by default (false). To enable a case-sensitive search, set this option to true."
        },
        "considerNulls":{
            "type":"boolean",
            "description":"This option, applicable to Person, Contact, and Address fields, controls whether null values are included in searches. By default (false), they are not; set it to true to enable their inclusion."
        },
        "manualCustomerNumberingFlag":{
            "type":"boolean",
            "description":"To enable custom numbering for parties, party sites, and accounts, set it to true. By default (false), the system will auto-generate these numbers for you."
        },
        "createCustomerRelationships":{
            "type":"boolean",
            "description":"This flag, enables the creation of relationships between sold-to and ship-to parties. By default (false), relationship is not created; set it to true to enable relationship creation."
        },
        "soldTo":{
            "type":"object",
            "items":{
                "$ref":"#/components/schemas/SoldToResponse"
            },
            "description":"Values that describe the Sold-to-party. It is typically used when establishing a primary customer entity without immediate need for billing or shipping details or contact detail. For schema, refer section SoldToResponse."
        },
        "shipTo":{
            "type":"object",
            "items":{
                "$ref":"#/components/schemas/ShipToResponse"
            },
            "description":"Values that describe the Ship-to-party. It is useful in cases where shipping destinations need to be defined independently of the primary customer record. For schema, refer section ShipToResponse."
        },
        "billTo":{
            "type":"object",
            "items":{
                "$ref":"#/components/schemas/BillToResponse"
            },
            "description":"Values that describe the Bill-to-account. It is applicable when billing accounts or invoice recipients are being created or managed separately. For schema, refer section BillToResponse."
        }
    },
    "xml":{
        "name":"CustomerResponse"
    }
}

Nested Schema : billTo

Type: object

Values that describe the Bill-to-account. It is applicable when billing accounts or invoice recipients are being created or managed separately. For schema, refer section BillToResponse.

Show Source

• Array of: object BillToResponse
  Values that describe the bill-to-account.

{
    "type":"object",
    "items":{
        "$ref":"#/components/schemas/BillToResponse"
    },
    "description":"Values that describe the Bill-to-account. It is applicable when billing accounts or invoice recipients are being created or managed separately. For schema, refer section BillToResponse."
}

Nested Schema : errors

Type: array

List of errors.

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    },
    "description":"List of errors."
}

Nested Schema : shipTo

Type: object

Values that describe the Ship-to-party. It is useful in cases where shipping destinations need to be defined independently of the primary customer record. For schema, refer section ShipToResponse.

Show Source

• Array of: object ShipToResponse
  Values that describe the ship-to-party.

{
    "type":"object",
    "items":{
        "$ref":"#/components/schemas/ShipToResponse"
    },
    "description":"Values that describe the Ship-to-party. It is useful in cases where shipping destinations need to be defined independently of the primary customer record. For schema, refer section ShipToResponse."
}

Nested Schema : soldTo

Type: object

Values that describe the Sold-to-party. It is typically used when establishing a primary customer entity without immediate need for billing or shipping details or contact detail. For schema, refer section SoldToResponse.

Show Source

• Array of: object SoldToResponse
  Values that describe the Sold-to-party.

{
    "type":"object",
    "items":{
        "$ref":"#/components/schemas/SoldToResponse"
    },
    "description":"Values that describe the Sold-to-party. It is typically used when establishing a primary customer entity without immediate need for billing or shipping details or contact detail. For schema, refer section SoldToResponse."
}

Nested Schema : BillToResponse

Type: object

Values that describe the bill-to-account.

Show Source

• address: object address
  Address of the party. For schema, refer section AddressResponse.
• contact: object contact
  Contact of the party. For schema, refer section ContactAccountResponse.
• organizationAccount: object organizationAccount
  Organization account details. For schema, refer section OrganizationAccountResponse.
• partyType: string
  The type of party account being created. It can only be ORGANIZATION or PERSON.
• personAccount: object personAccount
  Person account details. For schema, refer section PersonAccountResponse.

{
    "type":"object",
    "description":"Values that describe the bill-to-account.",
    "properties":{
        "partyType":{
            "type":"string",
            "description":"The type of party account being created. It can only be ORGANIZATION or PERSON."
        },
        "organizationAccount":{
            "type":"object",
            "items":{
                "$ref":"#/components/schemas/OrganizationAccountResponse"
            },
            "description":"Organization account details. For schema, refer section OrganizationAccountResponse."
        },
        "personAccount":{
            "type":"object",
            "items":{
                "$ref":"#/components/schemas/PersonAccountResponse"
            },
            "description":"Person account details. For schema, refer section PersonAccountResponse."
        },
        "contact":{
            "type":"object",
            "items":{
                "$ref":"#/components/schemas/ContactAccountResponse"
            },
            "description":"Contact of the party. For schema, refer section ContactAccountResponse."
        },
        "address":{
            "type":"object",
            "items":{
                "$ref":"#/components/schemas/AddressResponse"
            },
            "description":"Address of the party. For schema, refer section AddressResponse."
        }
    },
    "xml":{
        "name":"BillToResponse"
    }
}

Nested Schema : address

Type: object

Address of the party. For schema, refer section AddressResponse.

Show Source

• Array of: object AddressResponse
  Values that describe the Address

{
    "type":"object",
    "items":{
        "$ref":"#/components/schemas/AddressResponse"
    },
    "description":"Address of the party. For schema, refer section AddressResponse."
}

Nested Schema : contact

Type: object

Contact of the party. For schema, refer section ContactAccountResponse.

Show Source

• Array of: object ContactAccountResponse
  Values that describe the Person

{
    "type":"object",
    "items":{
        "$ref":"#/components/schemas/ContactAccountResponse"
    },
    "description":"Contact of the party. For schema, refer section ContactAccountResponse."
}

Nested Schema : organizationAccount

Type: object

Organization account details. For schema, refer section OrganizationAccountResponse.

Show Source

• Array of: object OrganizationAccountResponse
  Values that describe the organization account.

{
    "type":"object",
    "items":{
        "$ref":"#/components/schemas/OrganizationAccountResponse"
    },
    "description":"Organization account details. For schema, refer section OrganizationAccountResponse."
}

Nested Schema : personAccount

Type: object

Person account details. For schema, refer section PersonAccountResponse.

Show Source

• Array of: object PersonAccountResponse
  Values that describe the person.

{
    "type":"object",
    "items":{
        "$ref":"#/components/schemas/PersonAccountResponse"
    },
    "description":"Person account details. For schema, refer section PersonAccountResponse."
}

Nested Schema : AddressResponse

Type: object

Values that describe the Address

Show Source

• addressLine1: string
  First line for address.
• addressLine2: string
  Second line for address.
• addressLine3: string
  Third line for address.
• addressLine4: string
  Fourth line for address.
• city: string
  The name of the city or locality in which the address is located.
• country: string
  The name or ISO code of the country. This is a required field and drives address validation logic and country-specific formatting rules.
• county: string
  A sub-region within a state or province, applicable in some countries for more granular geographic segmentation. This field may be optional depending on the country.
• locationId: number
  Location identifier of the associated address.
• partySiteId: number
  Party site identifier of the associated address.
• partySiteNumber: string
  Party site number of the associated address.
• province: string
  Used primarily for countries where the term province is used instead of or in addition to state (e.g., Canada, China). This can be used in conjunction with or instead of the State field depending on the country.
• state: string
  The state, province, or region applicable to the address. This field is typically used in countries where states are standard (e.g., the United States, India, Australia).
• zipCode: string
  A postal or zip code used for mail sorting and delivery. This is often required for validating the address and enabling accurate shipping and billing.

{
    "type":"object",
    "description":"Values that describe the Address",
    "properties":{
        "partySiteId":{
            "type":"number",
            "description":"Party site identifier of the associated address."
        },
        "locationId":{
            "type":"number",
            "description":"Location identifier of the associated address."
        },
        "partySiteNumber":{
            "type":"string",
            "description":"Party site number of the associated address."
        },
        "addressLine1":{
            "type":"string",
            "description":"First line for address."
        },
        "addressLine2":{
            "type":"string",
            "description":"Second line for address."
        },
        "addressLine3":{
            "type":"string",
            "description":"Third line for address."
        },
        "addressLine4":{
            "type":"string",
            "description":"Fourth line for address."
        },
        "city":{
            "type":"string",
            "description":"The name of the city or locality in which the address is located."
        },
        "state":{
            "type":"string",
            "description":"The state, province, or region applicable to the address. This field is typically used in countries where states are standard (e.g., the United States, India, Australia)."
        },
        "zipCode":{
            "type":"string",
            "description":"A postal or zip code used for mail sorting and delivery. This is often required for validating the address and enabling accurate shipping and billing."
        },
        "province":{
            "type":"string",
            "description":"Used primarily for countries where the term province is used instead of or in addition to state (e.g., Canada, China). This can be used in conjunction with or instead of the State field depending on the country."
        },
        "county":{
            "type":"string",
            "description":"A sub-region within a state or province, applicable in some countries for more granular geographic segmentation. This field may be optional depending on the country."
        },
        "country":{
            "type":"string",
            "description":"The name or ISO code of the country. This is a required field and drives address validation logic and country-specific formatting rules."
        }
    },
    "xml":{
        "name":"AddressResponse"
    }
}

Nested Schema : ContactAccountResponse

Type: object

Values that describe the Person

Show Source

• accountDescription: string
  Account description chosen for the person party.
• accountId: number
  Account identifier of the person party.
• accountNumber: string
  Account Number of the organization party.
• accountRoleId: number
  Unique identifier for the role played by the party in the customer account.
• email: string
  Email address of the person party.
• emailContactPointId: number
  E-mail address contact point identifier of the person party.
• firstName: string
  The first name of the individual.
• lastName: string
  The last name (or surname) of the individual.
• middleName: string
  The middle name of the individual.
• nameSuffix: string
  Indicates the place in a family structure. Any suffix that might follow the individual???s name, such as Jr. or III.
• partyId: number
  Unique identifier for the person party.
• partyNumber: string
  Unique identification number for the person party.
• relationshipId: number
  Unique identifier of a relationship.
• title: string
  A professional or family title of the individual, such as Mr., Dr., or Ms.

{
    "type":"object",
    "description":"Values that describe the Person",
    "properties":{
        "accountRoleId":{
            "type":"number",
            "description":"Unique identifier for the role played by the party in the customer account."
        },
        "relationshipId":{
            "type":"number",
            "description":"Unique identifier of a relationship."
        },
        "accountId":{
            "type":"number",
            "description":"Account identifier of the person party."
        },
        "partyId":{
            "type":"number",
            "description":"Unique identifier for the person party."
        },
        "emailContactPointId":{
            "type":"number",
            "description":"E-mail address contact point identifier of the person party."
        },
        "partyNumber":{
            "type":"string",
            "description":"Unique identification number for the person party."
        },
        "email":{
            "type":"string",
            "description":"Email address of the person party."
        },
        "firstName":{
            "type":"string",
            "description":"The first name of the individual."
        },
        "lastName":{
            "type":"string",
            "description":"The last name (or surname) of the individual."
        },
        "middleName":{
            "type":"string",
            "description":"The middle name of the individual."
        },
        "nameSuffix":{
            "type":"string",
            "description":"Indicates the place in a family structure. Any suffix that might follow the individual???s name, such as Jr. or III."
        },
        "title":{
            "type":"string",
            "description":"A professional or family title of the individual, such as Mr., Dr., or Ms."
        },
        "accountNumber":{
            "type":"string",
            "description":"Account Number of the organization party."
        },
        "accountDescription":{
            "type":"string",
            "description":"Account description chosen for the person party."
        }
    },
    "xml":{
        "name":"ContactAccountResponse"
    }
}

Nested Schema : OrganizationAccountResponse

Type: object

Values that describe the organization account.

Show Source

• accountDescription: string
  Account description chosen for the organization party.
• accountId: number
  Account identifier of the organization party.
• accountNumber: string
  Account number of the organization party.
• email: string
  E-mail address of the organization party.
• emailContactPointId: number
  E-mail address contact point identifier of the organization party.
• name: string
  Name of the organization.
• partyId: number
  Unique identifier for the organization party.
• partyNumber: string
  Unique identification number for the organization party.

{
    "type":"object",
    "description":"Values that describe the organization account.",
    "properties":{
        "accountId":{
            "type":"number",
            "description":"Account identifier of the organization party."
        },
        "partyId":{
            "type":"number",
            "description":"Unique identifier for the organization party."
        },
        "emailContactPointId":{
            "type":"number",
            "description":"E-mail address contact point identifier of the organization party."
        },
        "partyNumber":{
            "type":"string",
            "description":"Unique identification number for the organization party."
        },
        "email":{
            "type":"string",
            "description":"E-mail address of the organization party."
        },
        "name":{
            "type":"string",
            "description":"Name of the organization."
        },
        "accountNumber":{
            "type":"string",
            "description":"Account number of the organization party."
        },
        "accountDescription":{
            "type":"string",
            "description":"Account description chosen for the organization party."
        }
    },
    "xml":{
        "name":"OrganizationAccountResponse"
    }
}

Nested Schema : PersonAccountResponse

Type: object

Values that describe the person.

Show Source

• accountDescription: string
  Account description chosen for the person party.
• accountId: number
  Account identifier of the person party.
• accountNumber: string
  Account Number of the organization party.
• email: string
  E-mail address of the person party.
• emailContactPointId: number
  E-mail address contact point identifier of the person party.
• firstName: string
  The first name of the individual.
• lastName: string
  The last name (or surname) of the individual.
• middleName: string
  The middle name of the individual.
• nameSuffix: string
  Indicates the place in a family structure. Any suffix that might follow the individual???s name, such as Jr. or III.
• partyId: number
  Unique identifier for the person party.
• partyNumber: string
  Unique identification number for the person party.
• title: string
  A professional or family title of the individual, such as Mr., Dr., or Ms.

{
    "type":"object",
    "description":"Values that describe the person.",
    "properties":{
        "accountId":{
            "type":"number",
            "description":"Account identifier of the person party."
        },
        "partyId":{
            "type":"number",
            "description":"Unique identifier for the person party."
        },
        "emailContactPointId":{
            "type":"number",
            "description":"E-mail address contact point identifier of the person party."
        },
        "partyNumber":{
            "type":"string",
            "description":"Unique identification number for the person party."
        },
        "email":{
            "type":"string",
            "description":"E-mail address of the person party."
        },
        "firstName":{
            "type":"string",
            "description":"The first name of the individual."
        },
        "lastName":{
            "type":"string",
            "description":"The last name (or surname) of the individual."
        },
        "middleName":{
            "type":"string",
            "description":"The middle name of the individual."
        },
        "nameSuffix":{
            "type":"string",
            "description":"Indicates the place in a family structure. Any suffix that might follow the individual???s name, such as Jr. or III."
        },
        "title":{
            "type":"string",
            "description":"A professional or family title of the individual, such as Mr., Dr., or Ms."
        },
        "accountNumber":{
            "type":"string",
            "description":"Account Number of the organization party."
        },
        "accountDescription":{
            "type":"string",
            "description":"Account description chosen for the person party."
        }
    },
    "xml":{
        "name":"PersonAccountResponse"
    }
}

Nested Schema : ShipToResponse

Type: object

Values that describe the ship-to-party.

Show Source

• address: object address
  Address of the party. For schema, refer section AddressResponse.
• contact: object contact
  Contact of the party. For schema, refer section ContactResponse.
• organizationParty: object organizationParty
  Organization party details. For schema, refer section OrganizationResponse.
• partyType: string
  The type of party being created. It can only be ORGANIZATION or PERSON.
• personParty: object personParty
  Person party details. For schema, refer section PersonResponse.

{
    "type":"object",
    "description":"Values that describe the ship-to-party.",
    "properties":{
        "partyType":{
            "type":"string",
            "description":"The type of party being created. It can only be ORGANIZATION or PERSON."
        },
        "organizationParty":{
            "type":"object",
            "items":{
                "$ref":"#/components/schemas/OrganizationResponse"
            },
            "description":"Organization party details. For schema, refer section OrganizationResponse."
        },
        "personParty":{
            "type":"object",
            "items":{
                "$ref":"#/components/schemas/PersonResponse"
            },
            "description":"Person party details. For schema, refer section PersonResponse."
        },
        "contact":{
            "type":"object",
            "items":{
                "$ref":"#/components/schemas/ContactResponse"
            },
            "description":"Contact of the party. For schema, refer section ContactResponse."
        },
        "address":{
            "type":"object",
            "items":{
                "$ref":"#/components/schemas/AddressResponse"
            },
            "description":"Address of the party. For schema, refer section AddressResponse."
        }
    },
    "xml":{
        "name":"ShipToResponse"
    }
}

Nested Schema : address

Type: object

Address of the party. For schema, refer section AddressResponse.

Show Source

• Array of: object AddressResponse
  Values that describe the Address

{
    "type":"object",
    "items":{
        "$ref":"#/components/schemas/AddressResponse"
    },
    "description":"Address of the party. For schema, refer section AddressResponse."
}

Nested Schema : contact

Type: object

Contact of the party. For schema, refer section ContactResponse.

Show Source

• Array of: object ContactResponse
  Values that describe the person.

{
    "type":"object",
    "items":{
        "$ref":"#/components/schemas/ContactResponse"
    },
    "description":"Contact of the party. For schema, refer section ContactResponse."
}

Nested Schema : organizationParty

Type: object

Organization party details. For schema, refer section OrganizationResponse.

Show Source

• Array of: object OrganizationResponse
  Values that describe the organization.

{
    "type":"object",
    "items":{
        "$ref":"#/components/schemas/OrganizationResponse"
    },
    "description":"Organization party details. For schema, refer section OrganizationResponse."
}

Nested Schema : personParty

Type: object

Person party details. For schema, refer section PersonResponse.

Show Source

• Array of: object PersonResponse
  Values that describe the person.

{
    "type":"object",
    "items":{
        "$ref":"#/components/schemas/PersonResponse"
    },
    "description":"Person party details. For schema, refer section PersonResponse."
}

Nested Schema : ContactResponse

Type: object

Values that describe the person.

Show Source

• email: string
  E-mail address of the person party.
• emailContactPointId: number
  E-mail address contact point identifier of the person party.
• firstName: string
  The first name of the individual.
• lastName: string
  The last name (or surname) of the individual.
• middleName: string
  The middle name of the individual.
• nameSuffix: string
  Indicates the place in a family structure. Any suffix that might follow the individual???s name, such as Jr. or III.
• partyId: number
  Unique identifier for the person party.
• partyNumber: string
  Unique identification number for the person party.
• relationshipId: number
  Unique identifier of a relationship.
• title: string
  A professional or family title of the individual, such as Mr., Dr., or Ms.

{
    "type":"object",
    "description":"Values that describe the person.",
    "properties":{
        "relationshipId":{
            "type":"number",
            "description":"Unique identifier of a relationship."
        },
        "partyId":{
            "type":"number",
            "description":"Unique identifier for the person party."
        },
        "emailContactPointId":{
            "type":"number",
            "description":"E-mail address contact point identifier of the person party."
        },
        "partyNumber":{
            "type":"string",
            "description":"Unique identification number for the person party."
        },
        "email":{
            "type":"string",
            "description":"E-mail address of the person party."
        },
        "firstName":{
            "type":"string",
            "description":"The first name of the individual."
        },
        "lastName":{
            "type":"string",
            "description":"The last name (or surname) of the individual."
        },
        "middleName":{
            "type":"string",
            "description":"The middle name of the individual."
        },
        "nameSuffix":{
            "type":"string",
            "description":"Indicates the place in a family structure. Any suffix that might follow the individual???s name, such as Jr. or III."
        },
        "title":{
            "type":"string",
            "description":"A professional or family title of the individual, such as Mr., Dr., or Ms."
        }
    },
    "xml":{
        "name":"ContactResponse"
    }
}

Nested Schema : OrganizationResponse

Type: object

Values that describe the organization.

Show Source

• email: string
  E-mail address of the organization party.
• emailContactPointId: number
  E-mail address contact point identifier of the organization party.
• name: string
  The official name of the organization.
• partyId: number
  Unique identifier for the organization party.
• partyNumber: string
  Unique identification number for the organization party.

{
    "type":"object",
    "description":"Values that describe the organization.",
    "properties":{
        "partyId":{
            "type":"number",
            "description":"Unique identifier for the organization party."
        },
        "emailContactPointId":{
            "type":"number",
            "description":"E-mail address contact point identifier of the organization party."
        },
        "partyNumber":{
            "type":"string",
            "description":"Unique identification number for the organization party."
        },
        "email":{
            "type":"string",
            "description":"E-mail address of the organization party."
        },
        "name":{
            "type":"string",
            "description":"The official name of the organization."
        }
    },
    "xml":{
        "name":"OrganizationResponse"
    }
}

Nested Schema : PersonResponse

Type: object

Values that describe the person.

Show Source

• email: string
  Email address of the person party.
• emailContactPointId: number
  E-mail address contact point identifier of the person party.
• firstName: string
  The first name of the individual.
• lastName: string
  The last name (or surname) of the individual.
• middleName: string
  The middle name of the individual.
• nameSuffix: string
  Indicates the place in a family structure. Any suffix that might follow the individual???s name, such as Jr. or III.
• partyId: number
  Unique identifier for the person party.
• partyNumber: string
  Unique identification number for the person party.
• title: string
  A professional or family title of the individual, such as Mr., Dr., or Ms.

{
    "type":"object",
    "description":"Values that describe the person.",
    "properties":{
        "partyId":{
            "type":"number",
            "description":"Unique identifier for the person party."
        },
        "emailContactPointId":{
            "type":"number",
            "description":"E-mail address contact point identifier of the person party."
        },
        "partyNumber":{
            "type":"string",
            "description":"Unique identification number for the person party."
        },
        "email":{
            "type":"string",
            "description":"Email address of the person party."
        },
        "firstName":{
            "type":"string",
            "description":"The first name of the individual."
        },
        "lastName":{
            "type":"string",
            "description":"The last name (or surname) of the individual."
        },
        "middleName":{
            "type":"string",
            "description":"The middle name of the individual."
        },
        "nameSuffix":{
            "type":"string",
            "description":"Indicates the place in a family structure. Any suffix that might follow the individual???s name, such as Jr. or III."
        },
        "title":{
            "type":"string",
            "description":"A professional or family title of the individual, such as Mr., Dr., or Ms."
        }
    },
    "xml":{
        "name":"PersonResponse"
    }
}

Nested Schema : SoldToResponse

Type: object

Values that describe the Sold-to-party.

Show Source

• contact: object contact
  Contact of the party. For schema, refer section ContactResponse.
• organizationParty: object organizationParty
  Organization party details. For schema, refer section OrganizationResponse.
• partyType: string
  The type of party being created. It can only be ORGANIZATION or PERSON.
• personParty: object personParty
  Person party details. For schema, refer section PersonResponse.

{
    "type":"object",
    "description":"Values that describe the Sold-to-party.",
    "properties":{
        "partyType":{
            "type":"string",
            "description":"The type of party being created. It can only be ORGANIZATION or PERSON."
        },
        "organizationParty":{
            "type":"object",
            "items":{
                "$ref":"#/components/schemas/OrganizationResponse"
            },
            "description":"Organization party details. For schema, refer section OrganizationResponse."
        },
        "personParty":{
            "type":"object",
            "items":{
                "$ref":"#/components/schemas/PersonResponse"
            },
            "description":"Person party details. For schema, refer section PersonResponse."
        },
        "contact":{
            "type":"object",
            "items":{
                "$ref":"#/components/schemas/ContactResponse"
            },
            "description":"Contact of the party. For schema, refer section ContactResponse."
        }
    },
    "xml":{
        "name":"SoldToResponse"
    }
}

Nested Schema : contact

Type: object

Contact of the party. For schema, refer section ContactResponse.

Show Source

• Array of: object ContactResponse
  Values that describe the person.

{
    "type":"object",
    "items":{
        "$ref":"#/components/schemas/ContactResponse"
    },
    "description":"Contact of the party. For schema, refer section ContactResponse."
}

Nested Schema : organizationParty

Type: object

Organization party details. For schema, refer section OrganizationResponse.

Show Source

• Array of: object OrganizationResponse
  Values that describe the organization.

{
    "type":"object",
    "items":{
        "$ref":"#/components/schemas/OrganizationResponse"
    },
    "description":"Organization party details. For schema, refer section OrganizationResponse."
}

Nested Schema : personParty

Type: object

Person party details. For schema, refer section PersonResponse.

Show Source

• Array of: object PersonResponse
  Values that describe the person.

{
    "type":"object",
    "items":{
        "$ref":"#/components/schemas/PersonResponse"
    },
    "description":"Person party details. For schema, refer section PersonResponse."
}

400 Response

Invalid input request.

Back to Top