---
title: "SupplierReturnItem"
url: "https://developer.retailexpress.com.au/apis/retail-express-api-21-v2/versions/210b509a-613e-44ac-a87b-ef6c22c23a2c/schemas/SupplierReturnItem"
---

> Full API specification: https://developer.retailexpress.com.au/apis/retail-express-api-21-v2/versions/210b509a-613e-44ac-a87b-ef6c22c23a2c.md

# SupplierReturnItem

Supplier Return Item

## OpenAPI definition

```yaml
openapi: 3.0.1
info:
  title: Retail Express API
  version: v2.1
servers:
  - url: https://api.retailexpress.com.au/v2.1
components:
  schemas:
    SupplierReturnItemProduct:
      title: ""
      type: object
      properties:
        id:
          type: integer
          description: Product Id.
          format: int32
          nullable: true
        supplier_sku:
          type: string
          description: Supplier SKU.
          nullable: true
        manufacturer_sku:
          type: string
          description: Manufacture SKU
          nullable: true
        supplier_sku2:
          type: string
          description: Supplier SKU 2.
          nullable: true
        short_description:
          type: string
          description: Product description.
          nullable: true
        size:
          $ref: "#/components/schemas/AttributeValueLimited"
        colour:
          $ref: "#/components/schemas/AttributeValueLimited"
      additionalProperties: false
      description: Supplier Return Item Product Model
    SupplierReturnReasons:
      title: ""
      type: object
      properties:
        id:
          type: integer
          description: Supplier Return Reason Id.
          format: int32
          nullable: true
        name:
          type: string
          description: Supplier Return Reason name
          nullable: true
        created_on:
          type: string
          description: Created on
          format: date-time
        modified_on:
          type: string
          description: Modified on
          format: date-time
        deleted:
          type: boolean
          description: Is Supplier Return Reason deleted
          default: false
        deleted_on:
          type: string
          description: Deleted on
          format: date-time
          nullable: true
      additionalProperties: false
      description: Supplier Return Reason model
    CreditNoteItemExtended:
      title: ""
      type: object
      properties:
        id:
          type: integer
          description: Credit Note Item id
          format: int32
          nullable: true
        credit_note_id:
          type: integer
          description: Credit Note id
          format: int32
        credit_amount_ex:
          type: number
          description: Credit Amount Ex
          format: double
          nullable: true
        total_credit_amount_ex:
          type: number
          description: Total Credit Amount Ex
          format: double
          nullable: true
        total_credit_amount_inc:
          type: number
          description: Total Credit Amount Inc
          format: double
          nullable: true
      additionalProperties: false
    SupplierReturnItemStatus:
      title: ""
      type: object
      properties:
        id:
          type: integer
          description: Supplier Return Item Status Id.
          format: int32
          nullable: true
        name:
          type: string
          description: Supplier Return Item Status name
          nullable: true
      additionalProperties: false
      description: Supplier Return Item Status Model
    SupplierReturnItemSource:
      title: ""
      type: object
      properties:
        id:
          type: integer
          description: Supplier Return Item source Id.
          format: int32
          nullable: true
        name:
          type: string
          description: Supplier Return Item source name
          nullable: true
      additionalProperties: false
      description: Supplier Return Item Product Model
    UserExtended:
      title: ""
      type: object
      properties:
        id:
          type: integer
          description: Id.
          format: int32
          nullable: true
        user_code:
          type: string
          description: User code.
          nullable: true
        first_name:
          type: string
          description: First name.
          nullable: true
        surname:
          type: string
          description: Surname.
          nullable: true
      additionalProperties: false
    AttributeValueLimited:
      title: ""
      type: object
      properties:
        id:
          type: integer
          description: Attribute Value Id
          format: int32
          nullable: true
        name:
          type: string
          description: Attribute Value Name
          nullable: true
        list_order:
          type: integer
          description: Attribute Value List Order
          format: int32
          nullable: true
      additionalProperties: false
    SupplierReturnItem:
      title: ""
      type: object
      properties:
        id:
          type: integer
          description: Supplier Return Item identifier
          format: int32
        supplier_return_id:
          type: integer
          description: Supplier Return id
          format: int32
        product:
          $ref: "#/components/schemas/SupplierReturnItemProduct"
        supplier_return_reason:
          $ref: "#/components/schemas/SupplierReturnReasons"
        credit_note_item:
          $ref: "#/components/schemas/CreditNoteItemExtended"
        return_quantity:
          type: integer
          description: Return Quantity
          format: int32
          nullable: true
        original_buy_ex:
          type: number
          description: Supplier price ex
          format: double
          nullable: true
        total_original_buy_ex:
          type: number
          description: Total supplier buy ex
          format: double
          nullable: true
        supplier_return_item_status:
          $ref: "#/components/schemas/SupplierReturnItemStatus"
        supplier_return_item_source:
          $ref: "#/components/schemas/SupplierReturnItemSource"
        original_supplier_invoice:
          type: string
          description: Supplier invoice number
          nullable: true
        claim_amount_ex:
          type: number
          description: Claim amount ex
          format: double
          nullable: true
        supplier_return_item_notes:
          type: string
          description: Notes
          nullable: true
        total_claim_amount_ex:
          type: number
          description: Total claim amount ex
          format: double
          nullable: true
        total_claim_amount_tax:
          type: number
          description: Total claim amount tax
          format: double
          nullable: true
        total_claim_amount_inc:
          type: number
          description: Total claim amount inc
          format: double
          nullable: true
        created_on:
          type: string
          description: Created on
          format: date-time
        modified_on:
          type: string
          description: Modified on
          format: date-time
        created_by:
          $ref: "#/components/schemas/UserExtended"
        modified_by:
          $ref: "#/components/schemas/UserExtended"
      additionalProperties: false
      description: Supplier Return Item
```