> For the complete documentation index, see [llms.txt](https://apidocs.akinon.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://apidocs.akinon.com/commerce-openapis/users/module-2/models.md).

# Models

## The AjaxSignupResponse object

```json
{"openapi":"3.1.0","info":{"title":"User API","version":"1.0.0"},"components":{"schemas":{"AjaxSignupResponse":{"type":"object","properties":{"location":{"type":"string","description":"URL to redirect to after successful signup."}}}}}}
```

## The AkifastAccountCheckRequest object

```json
{"openapi":"3.1.0","info":{"title":"User API","version":"1.0.0"},"components":{"schemas":{"AkifastAccountCheckRequest":{"type":"object","required":["uid"],"properties":{"uid":{"type":"string","description":"The unique identifier for the Akifast social account. Validated against existing social accounts."}}}}}}
```

## The ActivateCurrencyRequest object

```json
{"openapi":"3.1.0","info":{"title":"User API","version":"1.0.0"},"components":{"schemas":{"ActivateCurrencyRequest":{"type":"object","required":["currency_code"],"properties":{"currency_code":{"type":"string","description":"The currency code to activate (e.g., 'TRY', 'USD'). Must be one of the available currencies."}}}}}}
```

## The PasswordResetRequest object

```json
{"openapi":"3.1.0","info":{"title":"User API","version":"1.0.0"},"components":{"schemas":{"PasswordResetRequest":{"type":"object","required":["new_password1","new_password2"],"properties":{"new_password1":{"type":"string","format":"password","description":"The new password. Validated against the system's password validators (e.g., minimum length, common passwords)."},"new_password2":{"type":"string","format":"password","description":"Confirmation of the new password. Must match 'new_password1'."}}}}}}
```

## The ContactUsRequest object

```json
{"openapi":"3.1.0","info":{"title":"User API","version":"1.0.0"},"components":{"schemas":{"ContactUsRequest":{"type":"object","required":["subject","full_name","email","message"],"properties":{"subject":{"type":"integer","description":"ID of the contact subject. Determines if an order reference is required."},"full_name":{"type":"string","maxLength":70},"email":{"type":"string","format":"email"},"phone":{"type":"string","maxLength":70},"message":{"type":"string"},"file":{"type":"string","format":"binary","description":"Optional file attachment. Validated for allowed extensions and size limits."},"order":{"type":"integer","description":"ID of the related order. Required if the selected subject implies an order context. Must belong to the authenticated user."},"operation":{"type":"string","maxLength":30,"description":"Operation type key. Validated against configured contact email recipients (`CONTACT_US_EMAIL_TO`)."}}}}}}
```

## The ContactUsSubject object

```json
{"openapi":"3.1.0","info":{"title":"User API","version":"1.0.0"},"components":{"schemas":{"ContactUsSubject":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for the contact subject."},"text":{"type":"string","description":"Localized subject text."},"is_order_needed":{"type":"boolean","description":"Indicates if an order ID is required for this subject."}}}}}}
```

## The Conversation object

```json
{"openapi":"3.1.0","info":{"title":"User API","version":"1.0.0"},"components":{"schemas":{"Conversation":{"type":"object","description":"A conversation as its owner sees it, with the owner's own contact data. The moderation audit trail is not included.","properties":{"id":{"type":"integer","description":"Unique identifier for the conversation."},"subject":{"type":["string","null"],"description":"The subject of the conversation. `null` when none was sent."},"user":{"$ref":"#/components/schemas/UserMessage","description":"The user associated with the conversation."},"datasource":{"$ref":"#/components/schemas/DataSource","description":"The seller the conversation is with."},"item_object":{"type":["object","null"],"description":"Details of the related item. Structure depends on `item_content`:\n- `orderitem`: `{pk, product, status, order_number}`, where `product` is `{pk, name, sku, absolute_url, product_images}` and `status` is the order item's status code (e.g. `\"550\"` = delivered).\n- `product`: `{pk, name, sku, absolute_url, product_images}`.\n- `null` when the conversation is not about an item."},"item_content":{"type":["string","null"],"enum":["product","orderitem",null],"description":"Kind of item the conversation is about. New reviews always use `orderitem`, new questions `product` (or none), new private messages `orderitem` (or none). Conversations created before these rules may differ."},"message_set":{"type":"array","items":{"$ref":"#/components/schemas/Message"},"description":"Messages in the conversation, newest first."},"conversation_type":{"type":"string","enum":["message","question","review"],"description":"The type of conversation."},"last_message_date":{"type":"string","format":"date-time","description":"Timestamp of the last message in the conversation."},"is_public":{"type":"boolean","description":"`true` once a moderator has approved the review or question; it is then listed on `/public-reviews/` or `/public-questions/`. Always `false` for a private message. Conversations created before moderation existed keep the visibility they had."},"is_answered":{"type":"boolean","description":"Indicates if the conversation has been answered."},"rating":{"type":["integer","null"],"minimum":1,"maximum":5,"description":"Star rating from 1 to 5 on a review. `null` on questions, private messages and reviews written before ratings existed."},"status":{"$ref":"#/components/schemas/ConversationStatus"}}},"UserMessage":{"type":"object","properties":{"id":{"type":"integer","description":"User ID."},"first_name":{"type":"string","description":"User's first name."},"last_name":{"type":"string","description":"User's last name."},"email":{"type":"string","description":"User's email address."},"phone":{"type":["string","null"],"description":"User's phone number."},"gender":{"type":["string","null"],"enum":["male","female","not_to_say",null],"description":"User's gender."}}},"DataSource":{"type":"object","description":"The seller a conversation is with.","properties":{"pk":{"type":"integer","description":"Seller ID."},"name":{"type":["string","null"],"description":"Name of the seller."},"slug":{"type":["string","null"],"description":"Seller slug (used by the `data_source` filter)."},"title":{"type":["string","null"],"description":"Seller's display title."},"supplier_code":{"type":"string","description":"Supplier code of the seller."},"address":{"type":["string","null"]},"email":{"type":["string","null"],"format":"email"},"phone_number":{"type":["string","null"]},"fax_number":{"type":["string","null"]},"kep_address":{"type":["string","null"],"format":"email"},"mersis_number":{"type":["string","null"]},"trade_association":{"type":["string","null"]},"extras":{"type":["object","null"],"description":"Free-form seller data."},"price_list":{"type":["integer","null"],"description":"ID of the seller's price list."},"stock_list":{"type":["integer","null"],"description":"ID of the seller's stock list."},"is_active":{"type":"boolean"}}},"Message":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for the message."},"message_content":{"type":"string","description":"The content of the message."},"user_type":{"type":["string","null"],"enum":["guest","registered",null],"description":"The type of user who sent the message."},"content_object":{"$ref":"#/components/schemas/MessageContent","description":"Details of the sender (User or DataSource)."},"content_type":{"type":"string","description":"The type of the sender (e.g., 'user', 'datasource')."},"created_date":{"type":"string","format":"date-time","description":"Timestamp when the message was created."}}},"MessageContent":{"type":"object","properties":{"id":{"type":"integer","description":"ID of the sender."},"email":{"type":"string","description":"Email of the sender."},"first_name":{"type":"string","description":"First name of the sender."},"last_name":{"type":"string","description":"Last name of the sender."},"phone":{"type":"string","description":"Phone number of the sender."},"gender":{"type":["string","null"],"description":"Gender of the sender, as its display label in the request language (e.g. `female`, or `kadın` in Turkish; `Prefer not to say` for `not_to_say`), not the enum value."},"name":{"type":"string","description":"Name of the sender (if DataSource)."},"title":{"type":"string","description":"Title of the sender (if applicable)."}}},"ConversationStatus":{"type":["string","null"],"enum":["pending","approved","rejected",null],"description":"Moderation state of a review or question:\n- `pending`: waiting for a moderator; not public.\n- `approved`: published on the storefront (`is_public: true`).\n- `rejected`: turned down by a moderator; not public. The author is e-mailed the reason, unless the brand has disabled that e-mail. The author may post again.\n- `null`: private messages (never moderated) and conversations created before moderation existed."}}}}
```

## The CreateConversationRequest object

```json
{"openapi":"3.1.0","info":{"title":"User API","version":"1.0.0"},"components":{"schemas":{"CreateConversationRequest":{"type":"object","required":["message_content","user_type","content_id","content_type","datasource","user","conversation_type"],"properties":{"message_content":{"type":"string","minLength":1,"maxLength":500,"description":"The body of the message. For a review, the review text; for a question, the question. May not be blank."},"user_type":{"type":"string","enum":["guest","registered"],"description":"Type of user creating the conversation."},"content_id":{"type":"integer","minimum":1,"description":"ID of the message author. Must be the authenticated user's ID."},"content_type":{"type":"string","enum":["user","datasource"],"description":"Author type of the message. Must be `user` on this endpoint; `datasource` is refused with `Users do not match.`"},"conversation":{"type":"integer","description":"ID of one of your own **private message** threads to add this message to. Omit it to open a new conversation. Reviews and questions do not accept further messages. An ID that does not exist is refused with `400` on `conversation` (`Invalid pk \"<id>\" - object does not exist.`)."},"datasource":{"type":"integer","description":"ID of the seller the conversation is with."},"user":{"type":"integer","description":"ID of the user who owns the conversation. Must be the authenticated user's ID."},"subject":{"type":"string","maxLength":500,"description":"Subject of the conversation."},"item_content":{"type":"string","enum":["product","orderitem"],"description":"Kind of item the conversation is about. Allowed per kind: `review` → `orderitem` only (required); `question` → `product` only; `message` → `orderitem` only. Optional for questions and messages."},"item_id":{"type":"integer","minimum":1,"description":"ID of the order item or product named in `item_content`. Required for a review. It must exist, an order item must belong to one of your orders, and an item that names a seller must belong to `datasource`."},"conversation_type":{"type":"string","enum":["message","question","review"],"description":"Type of conversation."},"rating":{"type":"integer","minimum":1,"maximum":5,"description":"Star rating from 1 to 5. Required when `conversation_type` is `review`; refused for `question` and `message`."},"is_public":{"type":"boolean","readOnly":true,"description":"Ignored if sent. Visibility follows moderation: every new conversation is created with `is_public: false`, and only a moderator's approval publishes a review or question."}},"description":"Request body for creating a conversation or message.\n\n**Validation:**\n- Users must match the authenticated user and content owner: `user` and `content_id` are the caller's ID, `content_type` is `user`, and `conversation` (when sent) is one of the caller's threads.\n- `rating` is required on a review and refused on a question or private message.\n- `item_content` must be allowed for the kind (see the table on the endpoint). An `orderitem` must belong to one of the caller's orders.\n- The item must exist, and an item that names a seller must belong to `datasource`.\n- A review must name an order item (`item_content: orderitem` + `item_id`). By default that order item must be delivered (`REVIEW_REQUIRES_PURCHASE`).\n- One review per order item: a review of it that was not rejected (pending, approved, or written before moderation existed) blocks a new one; a rejected one does not.\n- Only private messages accept further customer messages through `conversation`.\n- An identical conversation (same seller, subject, kind and item) may exist only once, published or not; a rejected one does not count.\n\nThe kind and item, rating, item existence and seller, add-to-thread and duplicate rules answer `406` with an `error_code`; field validation and the author, order-item ownership and review checks answer `400` (see the endpoint)."}}}}
```

## The Message object

```json
{"openapi":"3.1.0","info":{"title":"User API","version":"1.0.0"},"components":{"schemas":{"Message":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for the message."},"message_content":{"type":"string","description":"The content of the message."},"user_type":{"type":["string","null"],"enum":["guest","registered",null],"description":"The type of user who sent the message."},"content_object":{"$ref":"#/components/schemas/MessageContent","description":"Details of the sender (User or DataSource)."},"content_type":{"type":"string","description":"The type of the sender (e.g., 'user', 'datasource')."},"created_date":{"type":"string","format":"date-time","description":"Timestamp when the message was created."}}},"MessageContent":{"type":"object","properties":{"id":{"type":"integer","description":"ID of the sender."},"email":{"type":"string","description":"Email of the sender."},"first_name":{"type":"string","description":"First name of the sender."},"last_name":{"type":"string","description":"Last name of the sender."},"phone":{"type":"string","description":"Phone number of the sender."},"gender":{"type":["string","null"],"description":"Gender of the sender, as its display label in the request language (e.g. `female`, or `kadın` in Turkish; `Prefer not to say` for `not_to_say`), not the enum value."},"name":{"type":"string","description":"Name of the sender (if DataSource)."},"title":{"type":"string","description":"Title of the sender (if applicable)."}}}}}}
```

## The MessageContent object

```json
{"openapi":"3.1.0","info":{"title":"User API","version":"1.0.0"},"components":{"schemas":{"MessageContent":{"type":"object","properties":{"id":{"type":"integer","description":"ID of the sender."},"email":{"type":"string","description":"Email of the sender."},"first_name":{"type":"string","description":"First name of the sender."},"last_name":{"type":"string","description":"Last name of the sender."},"phone":{"type":"string","description":"Phone number of the sender."},"gender":{"type":["string","null"],"description":"Gender of the sender, as its display label in the request language (e.g. `female`, or `kadın` in Turkish; `Prefer not to say` for `not_to_say`), not the enum value."},"name":{"type":"string","description":"Name of the sender (if DataSource)."},"title":{"type":"string","description":"Title of the sender (if applicable)."}}}}}}
```

## The UserMessage object

```json
{"openapi":"3.1.0","info":{"title":"User API","version":"1.0.0"},"components":{"schemas":{"UserMessage":{"type":"object","properties":{"id":{"type":"integer","description":"User ID."},"first_name":{"type":"string","description":"User's first name."},"last_name":{"type":"string","description":"User's last name."},"email":{"type":"string","description":"User's email address."},"phone":{"type":["string","null"],"description":"User's phone number."},"gender":{"type":["string","null"],"enum":["male","female","not_to_say",null],"description":"User's gender."}}}}}}
```

## The DataSource object

```json
{"openapi":"3.1.0","info":{"title":"User API","version":"1.0.0"},"components":{"schemas":{"DataSource":{"type":"object","description":"The seller a conversation is with.","properties":{"pk":{"type":"integer","description":"Seller ID."},"name":{"type":["string","null"],"description":"Name of the seller."},"slug":{"type":["string","null"],"description":"Seller slug (used by the `data_source` filter)."},"title":{"type":["string","null"],"description":"Seller's display title."},"supplier_code":{"type":"string","description":"Supplier code of the seller."},"address":{"type":["string","null"]},"email":{"type":["string","null"],"format":"email"},"phone_number":{"type":["string","null"]},"fax_number":{"type":["string","null"]},"kep_address":{"type":["string","null"],"format":"email"},"mersis_number":{"type":["string","null"]},"trade_association":{"type":["string","null"]},"extras":{"type":["object","null"],"description":"Free-form seller data."},"price_list":{"type":["integer","null"],"description":"ID of the seller's price list."},"stock_list":{"type":["integer","null"],"description":"ID of the seller's stock list."},"is_active":{"type":"boolean"}}}}}}
```

## The UserEmail object

```json
{"openapi":"3.1.0","info":{"title":"User API","version":"1.0.0"},"components":{"schemas":{"UserEmail":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for the email address. Read-only."},"user":{"type":"integer","description":"Identifier of the owning user. Ignored on input — the endpoint always uses the authenticated user. Read-only."},"email":{"type":"string","format":"email","description":"The email address. Required when adding a new email."},"verified":{"type":"boolean","description":"Indicates if the email address has been verified. Read-only."},"primary":{"type":"boolean","description":"Indicates if this is the primary email address for the user. Read-only."}}}}}}
```

## The UserEmailChangeRequest object

```json
{"openapi":"3.1.0","info":{"title":"User API","version":"1.0.0"},"components":{"schemas":{"UserEmailChangeRequest":{"type":"object","required":["email","password"],"description":"Under the step-up gate the discovery call deliberately omits `password`\n(and the token): the gate answers `406` before the body is validated, so a\nrequest carrying only `email` is enough to learn which factors are needed.\n`password` is not required under `OtpOnlyEmailChangeView`.","properties":{"user":{"type":"integer","readOnly":true,"description":"Ignored on input — the endpoint always sets it to the authenticated\nuser. Echoed back in the response."},"email":{"type":"string","format":"email","description":"The new email address. Must be different from the current email and not already in use.\nUnder the step-up gate it must also equal the `target` the verification token was issued for."},"password":{"type":"string","format":"password","description":"The user's current password. Required for verification."}}}}}}
```

## The RevokeRequest object

```json
{"openapi":"3.1.0","info":{"title":"User API","version":"1.0.0"},"components":{"schemas":{"RevokeRequest":{"type":"object","required":["revoke_token"],"properties":{"revoke_token":{"type":"string","maxLength":1024,"description":"Signed token from the notice email/SMS, taken verbatim."}}}}}}
```

## The StepUpRequiredResponse object

```json
{"openapi":"3.1.0","info":{"title":"User API","version":"1.0.0"},"components":{"schemas":{"StepUpRequiredResponse":{"type":"object","description":"406 response of a step-up gated endpoint whose factors are not satisfied.\nDrive the UI from `step_up.required` — it lists only the unmet factors, and\n`allowed_channels` is already filtered for the factor-repetition rule (a\nstep-up code may not be sent over the channel the session signed in with).","properties":{"non_field_errors":{"type":"string"},"error_code":{"type":"string"},"step_up":{"type":"object","properties":{"purpose":{"type":"string"},"required":{"type":"array","description":"One entry per unmet factor. A `password` entry names the body field\nto collect; an `otp` entry carries the channels still allowed, the\nheader to send the token in, and the two endpoint URLs to run.","items":{"type":"object"}}}}}}}}}
```

## The CodedErrorResponse object

```json
{"openapi":"3.1.0","info":{"title":"User API","version":"1.0.0"},"components":{"schemas":{"CodedErrorResponse":{"type":"object","description":"Business-error payload, returned with HTTP 406. `error_code` is stable —\nbranch on it, not on the translated message.","properties":{"non_field_errors":{"type":"string"},"error_code":{"type":"string"}}}}}}
```

## The UserCityRequest object

```json
{"openapi":"3.1.0","info":{"title":"User API","version":"1.0.0"},"components":{"schemas":{"UserCityRequest":{"type":"object","required":["city"],"properties":{"city":{"type":"string","description":"City name or ID. Validated against available cities in the system."}}}}}}
```

## The EnumValue object

```json
{"openapi":"3.1.0","info":{"title":"User API","version":"1.0.0"},"components":{"schemas":{"EnumValue":{"type":"object","properties":{"value":{"type":"string","description":"The internal value of the enum choice."},"label":{"type":"string","description":"The human-readable label of the enum choice."}}}}}}
```

## The ValidationErrorResponse object

```json
{"openapi":"3.1.0","info":{"title":"User API","version":"1.0.0"},"components":{"schemas":{"ValidationErrorResponse":{"type":"object","description":"Standard DRF validation error response","additionalProperties":{"type":"array","items":{"type":"string"}}}}}}
```

## The DetailErrorResponse object

```json
{"openapi":"3.1.0","info":{"title":"User API","version":"1.0.0"},"components":{"schemas":{"DetailErrorResponse":{"type":"object","properties":{"detail":{"type":"string"}}}}}}
```

## The SimpleErrorResponse object

```json
{"openapi":"3.1.0","info":{"title":"User API","version":"1.0.0"},"components":{"schemas":{"SimpleErrorResponse":{"type":"object","properties":{"error":{"type":"string"}}}}}}
```

## The PasswordResetErrorResponse object

```json
{"openapi":"3.1.0","info":{"title":"User API","version":"1.0.0"},"components":{"schemas":{"PasswordResetErrorResponse":{"type":"object","properties":{"validlink":{"type":"boolean"},"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}}}}}
```

## The CaptchaErrorResponse object

```json
{"openapi":"3.1.0","info":{"title":"User API","version":"1.0.0"},"components":{"schemas":{"CaptchaErrorResponse":{"type":"object","properties":{"form_errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}}}}}
```

## The ConversationStatus object

```json
{"openapi":"3.1.0","info":{"title":"User API","version":"1.0.0"},"components":{"schemas":{"ConversationStatus":{"type":["string","null"],"enum":["pending","approved","rejected",null],"description":"Moderation state of a review or question:\n- `pending`: waiting for a moderator; not public.\n- `approved`: published on the storefront (`is_public: true`).\n- `rejected`: turned down by a moderator; not public. The author is e-mailed the reason, unless the brand has disabled that e-mail. The author may post again.\n- `null`: private messages (never moderated) and conversations created before moderation existed."}}}}
```

## The PaginatedConversationList object

```json
{"openapi":"3.1.0","info":{"title":"User API","version":"1.0.0"},"components":{"schemas":{"PaginatedConversationList":{"type":"object","description":"Paginated list of the caller's conversations.","required":["count","next","previous","results"],"properties":{"count":{"type":"integer","description":"Total number of matching conversations."},"next":{"type":["string","null"],"format":"uri","description":"URL of the next page, or `null` on the last page."},"previous":{"type":["string","null"],"format":"uri","description":"URL of the previous page, or `null` on the first page."},"results":{"type":"array","items":{"$ref":"#/components/schemas/Conversation"}}}},"Conversation":{"type":"object","description":"A conversation as its owner sees it, with the owner's own contact data. The moderation audit trail is not included.","properties":{"id":{"type":"integer","description":"Unique identifier for the conversation."},"subject":{"type":["string","null"],"description":"The subject of the conversation. `null` when none was sent."},"user":{"$ref":"#/components/schemas/UserMessage","description":"The user associated with the conversation."},"datasource":{"$ref":"#/components/schemas/DataSource","description":"The seller the conversation is with."},"item_object":{"type":["object","null"],"description":"Details of the related item. Structure depends on `item_content`:\n- `orderitem`: `{pk, product, status, order_number}`, where `product` is `{pk, name, sku, absolute_url, product_images}` and `status` is the order item's status code (e.g. `\"550\"` = delivered).\n- `product`: `{pk, name, sku, absolute_url, product_images}`.\n- `null` when the conversation is not about an item."},"item_content":{"type":["string","null"],"enum":["product","orderitem",null],"description":"Kind of item the conversation is about. New reviews always use `orderitem`, new questions `product` (or none), new private messages `orderitem` (or none). Conversations created before these rules may differ."},"message_set":{"type":"array","items":{"$ref":"#/components/schemas/Message"},"description":"Messages in the conversation, newest first."},"conversation_type":{"type":"string","enum":["message","question","review"],"description":"The type of conversation."},"last_message_date":{"type":"string","format":"date-time","description":"Timestamp of the last message in the conversation."},"is_public":{"type":"boolean","description":"`true` once a moderator has approved the review or question; it is then listed on `/public-reviews/` or `/public-questions/`. Always `false` for a private message. Conversations created before moderation existed keep the visibility they had."},"is_answered":{"type":"boolean","description":"Indicates if the conversation has been answered."},"rating":{"type":["integer","null"],"minimum":1,"maximum":5,"description":"Star rating from 1 to 5 on a review. `null` on questions, private messages and reviews written before ratings existed."},"status":{"$ref":"#/components/schemas/ConversationStatus"}}},"UserMessage":{"type":"object","properties":{"id":{"type":"integer","description":"User ID."},"first_name":{"type":"string","description":"User's first name."},"last_name":{"type":"string","description":"User's last name."},"email":{"type":"string","description":"User's email address."},"phone":{"type":["string","null"],"description":"User's phone number."},"gender":{"type":["string","null"],"enum":["male","female","not_to_say",null],"description":"User's gender."}}},"DataSource":{"type":"object","description":"The seller a conversation is with.","properties":{"pk":{"type":"integer","description":"Seller ID."},"name":{"type":["string","null"],"description":"Name of the seller."},"slug":{"type":["string","null"],"description":"Seller slug (used by the `data_source` filter)."},"title":{"type":["string","null"],"description":"Seller's display title."},"supplier_code":{"type":"string","description":"Supplier code of the seller."},"address":{"type":["string","null"]},"email":{"type":["string","null"],"format":"email"},"phone_number":{"type":["string","null"]},"fax_number":{"type":["string","null"]},"kep_address":{"type":["string","null"],"format":"email"},"mersis_number":{"type":["string","null"]},"trade_association":{"type":["string","null"]},"extras":{"type":["object","null"],"description":"Free-form seller data."},"price_list":{"type":["integer","null"],"description":"ID of the seller's price list."},"stock_list":{"type":["integer","null"],"description":"ID of the seller's stock list."},"is_active":{"type":"boolean"}}},"Message":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for the message."},"message_content":{"type":"string","description":"The content of the message."},"user_type":{"type":["string","null"],"enum":["guest","registered",null],"description":"The type of user who sent the message."},"content_object":{"$ref":"#/components/schemas/MessageContent","description":"Details of the sender (User or DataSource)."},"content_type":{"type":"string","description":"The type of the sender (e.g., 'user', 'datasource')."},"created_date":{"type":"string","format":"date-time","description":"Timestamp when the message was created."}}},"MessageContent":{"type":"object","properties":{"id":{"type":"integer","description":"ID of the sender."},"email":{"type":"string","description":"Email of the sender."},"first_name":{"type":"string","description":"First name of the sender."},"last_name":{"type":"string","description":"Last name of the sender."},"phone":{"type":"string","description":"Phone number of the sender."},"gender":{"type":["string","null"],"description":"Gender of the sender, as its display label in the request language (e.g. `female`, or `kadın` in Turkish; `Prefer not to say` for `not_to_say`), not the enum value."},"name":{"type":"string","description":"Name of the sender (if DataSource)."},"title":{"type":"string","description":"Title of the sender (if applicable)."}}},"ConversationStatus":{"type":["string","null"],"enum":["pending","approved","rejected",null],"description":"Moderation state of a review or question:\n- `pending`: waiting for a moderator; not public.\n- `approved`: published on the storefront (`is_public: true`).\n- `rejected`: turned down by a moderator; not public. The author is e-mailed the reason, unless the brand has disabled that e-mail. The author may post again.\n- `null`: private messages (never moderated) and conversations created before moderation existed."}}}}
```

## The CreateConversationResponse object

```json
{"openapi":"3.1.0","info":{"title":"User API","version":"1.0.0"},"components":{"schemas":{"CreateConversationResponse":{"type":"object","description":"Echo of the stored message and its conversation. `id` is the **conversation** ID, not the message ID; send it as `conversation` to add to a private message thread. When a message is added to an existing thread, the conversation fields (`subject`, `item_content`, `item_id`, `conversation_type`, `rating`, …) are the thread's.","properties":{"id":{"type":"integer","description":"Conversation ID."},"datasource":{"type":"integer","description":"Seller ID."},"user":{"type":"integer","description":"ID of the user who owns the conversation."},"subject":{"type":["string","null"]},"item_content":{"type":["string","null"],"enum":["product","orderitem",null]},"is_public":{"type":"boolean","description":"Always `false` for a new conversation; approval by a moderator is what publishes a review or question."},"item_id":{"type":["integer","null"]},"conversation_type":{"type":"string","enum":["message","question","review"]},"message_content":{"type":"string"},"user_type":{"type":"string","enum":["guest","registered"]},"content_id":{"type":"integer","description":"ID of the message author."},"content_type":{"type":"string","description":"Author type of the message (`user`)."},"rating":{"type":["integer","null"],"minimum":1,"maximum":5,"description":"The stored star rating; `null` for questions and private messages."}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://apidocs.akinon.com/commerce-openapis/users/module-2/models.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
