Create Buyer

Create a new Buyer object for the client account.

post

/v1/accounts/buyers

Body

application/jsonmultipart/form-data

idstring

auditobject

$metaobject

hrefstring

contactobject

externalIdsobject

statusstring · enum

Options: Active, Enabled, Disabled, Deleted, Unassigned, Conflict, Mismatch

iconstring | nullable

addressobjectrequired

taxIdstring · max: 18 | nullable

accountobject

namestring · min: 1 · max: 500required

errorsobject[] | nullable

sellersobject[] | nullable

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/v1/accounts/buyers' \
  --header 'Content-Type: application/json' \
  --data '{"audit":{"created":{"by":{"audit":{"created":{"by":"[Circular Reference]"},"updated":{"by":"[Circular Reference]"}},"$meta":{"omitted":[null]}}},"updated":{"by":{"audit":{"created":{"by":"[Circular Reference]"},"updated":{"by":"[Circular Reference]"}},"$meta":{"omitted":[null]}}},"activated":{"by":{"audit":{"created":{"by":"[Circular Reference]"},"updated":{"by":"[Circular Reference]"}},"$meta":{"omitted":[null]}}},"unassigned":{"by":{"audit":{"created":{"by":"[Circular Reference]"},"updated":{"by":"[Circular Reference]"}},"$meta":{"omitted":[null]}}}},"$meta":{"omitted":[null]},"contact":{"phone":{},"user":{"audit":{"created":{"by":{"audit":{"created":{"by":"[Circular Reference]"},"updated":{"by":"[Circular Reference]"}},"$meta":{"omitted":[null]}}},"updated":{"by":{"audit":{"created":{"by":"[Circular Reference]"},"updated":{"by":"[Circular Reference]"}},"$meta":{"omitted":[null]}}}},"$meta":{"omitted":[null]},"phone":{},"settings":{},"currentAccount":{"audit":{"created":{"by":"[Circular Reference]"},"updated":{"by":"[Circular Reference]"}},"$meta":{"omitted":[null]},"externalIds":{},"type":"Client","status":"Active","serviceLevel":"Express","address":{"addressLine1":"text","postCode":"text","city":"text","state":"text","country":"text"},"name":"text","groups":[{"audit":"[Circular Reference]","$meta":{"omitted":[null]},"account":"[Circular Reference]","modules":"[Circular Reference]","users":"[Circular Reference]","buyers":"[Circular Reference]"}]},"accounts":[{"audit":{"created":{"by":"[Circular Reference]"},"updated":{"by":"[Circular Reference]"}},"$meta":{"omitted":[null]},"externalIds":{},"type":"Client","status":"Active","serviceLevel":"Express","address":{"addressLine1":"text","postCode":"text","city":"text","state":"text","country":"text"},"name":"text","groups":[{"audit":"[Circular Reference]","$meta":{"omitted":[null]},"account":"[Circular Reference]","modules":"[Circular Reference]","users":"[Circular Reference]","buyers":"[Circular Reference]"}]}]}},"externalIds":{},"status":"Active","address":{"addressLine1":"text","postCode":"text","city":"text","state":"text","country":"text"},"account":{"audit":{"created":{"by":"[Circular Reference]"},"updated":{"by":"[Circular Reference]"}},"$meta":{"omitted":[null]},"externalIds":{},"type":"Client","status":"Active","serviceLevel":"Express","address":{"addressLine1":"text","postCode":"text","city":"text","state":"text","country":"text"},"name":"text","groups":[{"audit":"[Circular Reference]","$meta":{"omitted":[null]},"account":"[Circular Reference]","modules":"[Circular Reference]","users":"[Circular Reference]","buyers":"[Circular Reference]"}]},"name":"text","errors":[{"message":"text"}],"sellers":[{"audit":{"created":{"by":"[Circular Reference]"},"updated":{"by":"[Circular Reference]"}},"$meta":{"omitted":[null]},"status":"Active","address":{"addressLine1":"text","postCode":"text","city":"text","state":"text","country":"text"},"currencies":[null]}]}'

201

400

201

{
  "id": "text",
  "audit": {
    "created": {
      "by": {
        "audit": {
          "created": {
            "by": "[Circular Reference]"
          },
          "updated": {
            "by": "[Circular Reference]"
          }
        },
        "$meta": {
          "omitted": [
            null
          ]
        }
      }
    },
    "updated": {
      "by": {
        "audit": {
          "created": {
            "by": "[Circular Reference]"
          },
          "updated": {
            "by": "[Circular Reference]"
          }
        },
        "$meta": {
          "omitted": [
            null
          ]
        }
      }
    },
    "activated": {
      "by": {
        "audit": {
          "created": {
            "by": "[Circular Reference]"
          },
          "updated": {
            "by": "[Circular Reference]"
          }
        },
        "$meta": {
          "omitted": [
            null
          ]
        }
      }
    },
    "unassigned": {
      "by": {
        "audit": {
          "created": {
            "by": "[Circular Reference]"
          },
          "updated": {
            "by": "[Circular Reference]"
          }
        },
        "$meta": {
          "omitted": [
            null
          ]
        }
      }
    }
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "href": "text",
  "contact": {
    "name": "text",
    "firstName": "text",
    "lastName": "text",
    "email": "[e-mail]",
    "phone": {},
    "user": {
      "audit": {
        "created": {
          "by": {
            "audit": {
              "created": {
                "by": "[Circular Reference]"
              },
              "updated": {
                "by": "[Circular Reference]"
              }
            },
            "$meta": {
              "omitted": [
                null
              ]
            }
          }
        },
        "updated": {
          "by": {
            "audit": {
              "created": {
                "by": "[Circular Reference]"
              },
              "updated": {
                "by": "[Circular Reference]"
              }
            },
            "$meta": {
              "omitted": [
                null
              ]
            }
          }
        }
      },
      "$meta": {
        "omitted": [
          null
        ]
      },
      "phone": {},
      "settings": {},
      "currentAccount": {
        "audit": {
          "created": {
            "by": "[Circular Reference]"
          },
          "updated": {
            "by": "[Circular Reference]"
          }
        },
        "$meta": {
          "omitted": [
            null
          ]
        },
        "externalIds": {},
        "type": "Client",
        "status": "Active",
        "serviceLevel": "Express",
        "address": {
          "addressLine1": "text",
          "postCode": "text",
          "city": "text",
          "state": "text",
          "country": "text"
        },
        "name": "text",
        "groups": [
          {
            "audit": "[Circular Reference]",
            "$meta": {
              "omitted": [
                null
              ]
            },
            "account": "[Circular Reference]",
            "modules": "[Circular Reference]",
            "users": "[Circular Reference]",
            "buyers": "[Circular Reference]"
          }
        ]
      },
      "accounts": [
        {
          "audit": {
            "created": {
              "by": "[Circular Reference]"
            },
            "updated": {
              "by": "[Circular Reference]"
            }
          },
          "$meta": {
            "omitted": [
              null
            ]
          },
          "externalIds": {},
          "type": "Client",
          "status": "Active",
          "serviceLevel": "Express",
          "address": {
            "addressLine1": "text",
            "postCode": "text",
            "city": "text",
            "state": "text",
            "country": "text"
          },
          "name": "text",
          "groups": [
            {
              "audit": "[Circular Reference]",
              "$meta": {
                "omitted": [
                  null
                ]
              },
              "account": "[Circular Reference]",
              "modules": "[Circular Reference]",
              "users": "[Circular Reference]",
              "buyers": "[Circular Reference]"
            }
          ]
        }
      ]
    },
    "type": "text"
  },
  "externalIds": {
    "erpCompanyContact": "text",
    "erpCustomer": "text",
    "accountExternalId": "text"
  },
  "status": "Active",
  "icon": "text",
  "address": {
    "addressLine1": "text",
    "addressLine2": "text",
    "postCode": "text",
    "city": "text",
    "state": "text",
    "country": "text"
  },
  "taxId": "text",
  "account": {
    "id": "text",
    "audit": {
      "created": {
        "by": "[Circular Reference]"
      },
      "updated": {
        "by": "[Circular Reference]"
      }
    },
    "$meta": {
      "omitted": [
        null
      ]
    },
    "href": "text",
    "externalIds": {},
    "externalId": "text",
    "externalName": "text",
    "type": "Client",
    "status": "Active",
    "serviceLevel": "Express",
    "address": {
      "addressLine1": "text",
      "postCode": "text",
      "city": "text",
      "state": "text",
      "country": "text"
    },
    "icon": "text",
    "technicalSupportEmail": "[e-mail]",
    "website": "text",
    "description": "text",
    "name": "text",
    "groups": [
      {
        "audit": "[Circular Reference]",
        "$meta": {
          "omitted": [
            null
          ]
        },
        "account": "[Circular Reference]",
        "modules": "[Circular Reference]",
        "users": "[Circular Reference]",
        "buyers": "[Circular Reference]"
      }
    ]
  },
  "name": "text",
  "errors": [
    {
      "id": "text",
      "message": "text",
      "parameters": null
    }
  ],
  "sellers": [
    {
      "id": "text",
      "audit": {
        "created": {
          "by": "[Circular Reference]"
        },
        "updated": {
          "by": "[Circular Reference]"
        }
      },
      "$meta": {
        "omitted": [
          null
        ]
      },
      "href": "text",
      "externalId": "text",
      "status": "Active",
      "icon": "text",
      "address": {
        "addressLine1": "text",
        "postCode": "text",
        "city": "text",
        "state": "text",
        "country": "text"
      },
      "name": "text",
      "currencies": [
        "text"
      ]
    }
  ]
}

Created