---
title: "Supplier"
url: "https://developer.retailexpress.com.au/apis/retail-express-api-21-v2/versions/d3750347-3c58-45e9-b3b1-b23a00e713ed/schemas/Supplier"
---

> Full API specification: https://developer.retailexpress.com.au/apis/retail-express-api-21-v2/versions/d3750347-3c58-45e9-b3b1-b23a00e713ed.md

# Supplier

Supplier model

## OpenAPI definition

```yaml
openapi: 3.0.1
info:
  title: Retail Express API
  version: V2
servers:
  - url: https://api.retailexpress.com.au/v2
components:
  schemas:
    SupplierReturnAddress:
      title: ""
      type: object
      properties:
        address_line1:
          maxLength: 255
          minLength: 0
          type: string
          description: Address line 1
          nullable: true
        suburb:
          maxLength: 50
          minLength: 0
          type: string
          description: Suburb
          nullable: true
        state:
          maxLength: 50
          minLength: 0
          type: string
          description: State
          nullable: true
        postcode:
          maxLength: 10
          minLength: 0
          type: string
          description: Post code
          nullable: true
        country:
          $ref: "#/components/schemas/SupplierAddressCountry"
      additionalProperties: false
      description: Supplier address model
    SupplierShippingPort:
      title: ""
      type: object
      properties:
        id:
          type: integer
          description: Supplier shipping port id
          format: int32
        name:
          maxLength: 100
          minLength: 0
          type: string
          description: Supplier shipping port name
          nullable: true
      additionalProperties: false
    SupplierAddressCountry:
      title: ""
      type: object
      properties:
        id:
          type: integer
          description: Supplier country id
          format: int32
          nullable: true
        name:
          type: string
          description: Supplier country name
          nullable: true
      additionalProperties: false
    Supplier:
      title: ""
      type: object
      properties:
        id:
          type: integer
          description: Supplier Id
          format: int32
          nullable: true
        supplier_code:
          maxLength: 20
          minLength: 0
          type: string
          description: Supplier Code
          nullable: true
        name:
          maxLength: 50
          minLength: 0
          type: string
          description: Supplier Name
          nullable: true
        address:
          $ref: "#/components/schemas/SupplierReturnAddress"
        phone:
          maxLength: 20
          minLength: 0
          type: string
          description: Supplier Phone Number
          nullable: true
        fax:
          maxLength: 20
          minLength: 0
          type: string
          description: Supplier Fax Number
          nullable: true
        contact_name:
          maxLength: 50
          minLength: 0
          type: string
          description: Supplier Contact Name
          nullable: true
        contact_email:
          maxLength: 120
          minLength: 0
          type: string
          description: Supplier Contact Email
          format: email
          nullable: true
        order_email:
          maxLength: 120
          minLength: 0
          type: string
          description: Supplier Order Email
          format: email
          nullable: true
        admin_only_orders:
          type: boolean
          description: Admin Only Orders Flag
          default: false
        deposit_required:
          type: boolean
          description: Deposit Required Flag
          default: false
        shipping_port:
          $ref: "#/components/schemas/SupplierShippingPort"
        country_of_origin:
          $ref: "#/components/schemas/SupplierAddressCountry"
        shipping_terms:
          maxLength: 50
          minLength: 0
          type: string
          description: Supplier Shipping Terms
          nullable: true
        payment_terms:
          maxLength: 50
          minLength: 0
          type: string
          description: Supplier Payment Terms
          nullable: true
        comments:
          maxLength: 255
          minLength: 0
          pattern: ^[^*|":<>[\]{}`\()';@&$#!-/?]+$
          type: string
          description: Supplier Comments
          nullable: true
        purchase_order_template:
          type: string
          description: Supplier Purchase Order Template type
          nullable: true
        modified_on:
          type: string
          description: Modified On
          format: date-time
      additionalProperties: false
      description: Supplier model
```