openapi: 3.0.1
info:
  title: Documentation Norce Commerce Connect Order Service
  description: >-
    The Order Service  has Entities and Operations concerned with orders created
    in Norce Commerce.
  version: '4.0'
servers:
  - url: https://customer-slug.api-se.norce.tech/commerce/connect/4.0
paths:
  /webhooks:
    post:
      tags:
        - Order Notification
      summary: Create Order
      description: >-
        A post of the Order Request for the ERP or OMS,<br/>Read more about the
        how to implement a receiver <a
        href='/orderreceiverimplementation/'>here</a>
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/OrderRequest'
        required: true
      responses:
        '200':
          description: Order received successfully - No retries
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/OrderResponse'
        '400':
          description: Bad Request - Trigger retries
          content: {}
        '401':
          description: Unauthorized - Trigger retries
          content: {}
        '408':
          description: Request Timeout - Trigger retries
          content: {}
        '503':
          description: Service Unavailable - Trigger retries
          content: {}
      x-codegen-request-body-name: OrderRequest
  /Order/CancelOrder:
    post:
      tags:
        - Order
      summary: Cancel an order
      description: >-
        Cancel an order, and, if applicable, payment. Changes the order status
        to cancelled.
      operationId: CancelOrder
      requestBody:
        description: Order cancellation request.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CancelOrderRequest'
          application/xml:
            schema:
              $ref: '#/components/schemas/CancelOrderRequest'
        required: true
      responses:
        '200':
          description: Success
          content: {}
        '400':
          description: Bad Request
          content: {}
        '500':
          description: Internal Server Error
          content: {}
      x-codegen-request-body-name: cancelOrderRequest
  /Order/CreateDeliveryNote:
    post:
      tags:
        - Order
      summary: Import a delivery note.
      description: >-
        Created a delivery note from another system in Norce.<br/>Read more
        about the method <a
        href='/shoppingintegration/#creating-delivery-notes'>here</a>.
      operationId: CreateDeliveryNote
      requestBody:
        description: Delivery note to import.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeliveryNote'
          application/xml:
            schema:
              $ref: '#/components/schemas/DeliveryNote'
        required: true
      responses:
        '200':
          description: Success
          content: {}
        '400':
          description: Bad Request
          content: {}
        '500':
          description: Internal Server Error
          content: {}
      x-codegen-request-body-name: deliveryNote
  /Order/CreateInvoice:
    post:
      tags:
        - Invoice
      summary: Import an invoice.
      description: >-
        Creates an invoice from another system. Will capture/activate payment if
        applicable.<br/>Read more about the method <a
        href='/shoppingintegration/#creating-invoice-and-capture-payments'>here</a>.
      operationId: CreateInvoice
      requestBody:
        description: Invoice
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Invoice'
          application/xml:
            schema:
              $ref: '#/components/schemas/Invoice'
        required: true
      responses:
        '200':
          description: Success
          content: {}
        '400':
          description: Bad Request
          content: {}
        '500':
          description: Internal Server Error
          content: {}
      x-codegen-request-body-name: invoice
  /Order/CreditPayment:
    post:
      tags:
        - Invoice
      summary: Credit an Order
      description: >-
        Create a credit request that is sent to a payment service, if
        applicable. Must be related to an order, but can be a partly
        credit.<br/>Read more about the method <a
        href='/shoppingintegration/#credit-payments'>here</a>.
      operationId: CreditPayment
      requestBody:
        description: Invoice to be credited.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Invoice'
          application/xml:
            schema:
              $ref: '#/components/schemas/Invoice'
        required: true
      responses:
        '200':
          description: Success
          content: {}
        '400':
          description: Bad Request
          content: {}
        '500':
          description: Internal Server Error
          content: {}
      x-codegen-request-body-name: credit
  /Order/SendOrderStatus:
    post:
      tags:
        - Order
      summary: Update the status on an order.
      description: >-
        Updates the status on an order.<br/>Read more about the method <a
        href='/shoppingintegration/#acknowledgement-and-order-updates'>here</a>.
      operationId: SendOrderStatus
      requestBody:
        description: Order status request.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SendOrderStatusRequest'
          application/xml:
            schema:
              $ref: '#/components/schemas/SendOrderStatusRequest'
        required: true
      responses:
        '200':
          description: Success
          content: {}
        '400':
          description: Bad Request
          content: {}
        '500':
          description: Internal Server Error
          content: {}
      x-codegen-request-body-name: sendOrderStatusRequest
  /Order/SendPosShipment:
    post:
      tags:
        - POS Shipment
      summary: Create a shipment request
      description: >-
        Sends shipment request to POS adapter. Must have a POS integration
        through Norce.
      operationId: SendPosShipment
      requestBody:
        description: Shipment to send.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Shipment'
          application/xml:
            schema:
              $ref: '#/components/schemas/Shipment'
        required: true
      responses:
        '200':
          description: Success
          content: {}
        '400':
          description: Bad Request
          content: {}
        '500':
          description: Internal Server Error
          content: {}
      x-codegen-request-body-name: shipment
components:
  schemas:
    Address:
      type: object
      properties:
        Box:
          type: string
          description: 'Box information. Max length: 100'
        CareOf:
          type: string
          description: 'Care of information. Max length: 100'
        City:
          type: string
          description: 'City. Max length: 50'
        Country:
          type: string
          description: >-
            Country code in ISO 3166-1 alpha-2 format, e.g. SE, BY. Max length:
            2
        Line1:
          type: string
          description: 'First line of address. Max length: 100'
        Line2:
          type: string
          description: 'Second line of address. Max length: 100'
        Region:
          type: string
          description: 'Region. Max length: 50'
        Type:
          type: string
          description: Always null. Deprecated
        ZipCode:
          type: string
          description: 'Zip code. Max length: 50'
      description: Represents person or company address.
      format: Address
    CancelOrderRequest:
      required:
        - ClientOrderRef
        - ErpOrderNo
      type: object
      properties:
        ClientOrderRef:
          type: integer
          description: Basket/Quotation id. Used for order matching.
          format: int32
        ErpOrderNo:
          type: string
          description: ERP order number. Used for order matching.
        Payments:
          type: array
          description: >-
            If supplied, a cancel call is made for all included payments.
            Required property for each Payment is PaymentRef.
          items:
            $ref: '#/components/schemas/Payment'
      description: >-
        Request for order cancellation. Either ClientOrderRef or ErpOrderNo must
        be provided.
      format: CancelOrderRequest
    ClientCustomer:
      type: object
      properties:
        Company:
          $ref: '#/components/schemas/Company'
        Person:
          $ref: '#/components/schemas/Person'
      description: Represents customer, either a person or a company.
      format: ClientCustomer
    CodeValue:
      type: object
      properties:
        Code:
          type: string
          description: >-
            Configurable identifier in Norce Commerce. This has erroneous
            behaviour.
        Code2:
          type: string
          description: Configurable identifier in Norce Commerce.
        Id:
          type: integer
          description: Norce Commerce internal id for the info type (use code instead)
          format: int32
        Value:
          type: string
          description: >-
            The value set to the item from an integrated system to Norce
            Commerce.
      description: >-
        Represents a configurable information item that is stored in Norce
        Commerce but maintained by other integrated systems via the APIs.
        Preferable to use Code2 over Code.
      format: CodeValue
    Company:
      type: object
      properties:
        AdditionalInfo:
          type: array
          description: Always null, deprecated.
          items:
            $ref: '#/components/schemas/CodeValue'
        Addresses:
          type: array
          description: Always null, deprecated.
          items:
            $ref: '#/components/schemas/Address'
        Code:
          type: string
          description: >-
            Company code. If exists the company is already in ERP. Max length:
            50
        DeliveryCodeLimit:
          type: boolean
          description: Always false, deprecated.
        DeliveryCodes:
          type: array
          description: Always null, deprecated.
          items:
            type: string
        Email:
          type: string
          description: Always null, deprecated.
        Fax:
          type: string
          description: Always null, deprecated.
        IsActive:
          type: boolean
          description: Always false, deprecated.
        Name:
          type: string
          description: 'Company name. Max length: 100'
        PaymentCodeLimit:
          type: boolean
          description: Always false, decprecated.
        PaymentCodes:
          type: array
          description: Always null, deprecated.
          items:
            type: string
        Phone:
          type: string
          description: Always null, deprecated.
        PriceListCodes:
          type: array
          description: Always null, deprecated.
          items:
            type: string
        PriceListLimit:
          type: boolean
          description: Always false, deprecated.
        VatNo:
          type: string
          description: 'VAT number. Max length: 50'
      description: Represents a company.
      format: Company
    DeliveryNote:
      required:
        - DeliveryDate
        - NoteNo
        - OrderNo
      type: object
      properties:
        DeliveryDate:
          type: string
          description: Date when order was shipped/delivered.
          format: DateTime
        NoteNo:
          type: string
          description: Delivery note identification number.
        OrderNo:
          type: string
          description: Order number that was shipped.
        BuyerCompanyCode:
          type: string
          description: Customer code (if company).
        BuyerCustomerCode:
          type: string
          description: Customer code
        DeliveryAddress:
          $ref: '#/components/schemas/Address'
        DeliveryAttention:
          type: string
          description: Attention name for receiver.
        DeliveryMode:
          type: string
          description: Delivery mode/method.
        DeliveryName:
          type: string
          description: Name of person to receive package.
        DeliverynoteItems:
          type: array
          description: List of delivered items.
          items:
            $ref: '#/components/schemas/DeliveryNoteItem'
        DeliveryNotePackages:
          type: array
          description: List of packages for delivery tracking.
          items:
            $ref: '#/components/schemas/DeliveryNotePackage'
        DivisionCode:
          type: string
          description: Division code
        IsPrinted:
          type: boolean
          description: Always null, deprecated
        NoteText:
          type: string
          description: Additional comments for delivery.
        StatusId:
          type: integer
          description: >-
            Related order status.<br>4 = Delivered<br>8 = Partly Delivered<br>19
            = Ready for reservation.
          format: int32
      description: Notification information about shipped order.
      format: DeliveryNote
    DeliveryNoteItem:
      required:
        - ItemNo
        - Qty
        - RowNumber
      type: object
      properties:
        ItemNo:
          type: string
          description: Part no of delivered item.
        Qty:
          type: number
          description: Quantity of items shipped.
        RowNumber:
          type: number
          description: Delivery note line number.
        Comment:
          type: string
          description: Supplier comment.
        Description:
          type: string
          description: Item description.
        Id:
          type: integer
          description: Always null, deprecated.
      description: Information about delivered item.
      format: DeliveryNoteItem
    DeliveryNotePackage:
      type: object
      properties:
        Id:
          type: integer
          description: Always null, deprecated
        ParcelNumber:
          type: string
          description: Tracking number.
        StatusId:
          type: integer
          description: >-
            Parcel status:<br>4 = Delivered<br>6 = Canceled<br>11 = Ready for
            pickup<br>12 = Pickedup<br>20 = Reserved
          format: int32
      description: Package information for tracking.
      format: DeliveryNotePackage
    Discount:
      type: object
      properties:
        Amount:
          type: number
          description: Discount amount.
        Code:
          type: string
          description: Discount code. Used for discount matching in Norce Commerce.
        Type:
          type: string
          description: Discount type
      description: Order discount
      format: Discount
    Fee:
      type: object
      properties:
        Amount:
          type: number
          description: Fee amount.
        Description:
          type: string
          description: Fee description.
        Type:
          type: integer
          description: Fee type.<br>0 = Shipping<br>1 = Invoice
          format: int32
        VatRate:
          type: number
          description: VAT in percent.
      description: Represents a fee on an order
      format: Fee
    Header:
      type: object
      properties:
        ApplicationKey:
          type: string
          description: Application from where the order is created.
          format: Guid
      description: Header information about order.
      format: Header
    Invoice:
      required:
        - ClientOrderRef
        - CurrencyCode
        - ErpOrderNo
        - InvoiceDate
      type: object
      properties:
        ClientOrderRef:
          type: integer
          description: Reference basket/quotation id.
          format: int32
        CurrencyCode:
          type: string
          description: 'Currency code, e.g. SEK. Max length: 3'
        ErpOrderNo:
          type: string
          description: Reference ERP order number.
        InvoiceDate:
          type: string
          description: Invoice creation date.
          format: DateTime
        InvoiceNo:
          type: string
          description: Invoice identification number. Must be unique.
        AddressLine1:
          type: string
          description: First line of receiver's address.
        AddressLine2:
          type: string
          description: Second line of receiver's address.
        ApplicationKey:
          type: string
          description: Application identifier.
          format: Guid
        Attention:
          type: string
          description: Receiver attention.
        CareOf:
          type: string
          description: Receiver care of.
        City:
          type: string
          description: Receiver's city.
        Comment:
          type: string
          description: Client comment.
        Country:
          type: string
          description: Receiver's country.
        CountryCode:
          type: string
          description: >-
            Country code (e.g. 'SE') explicit set for invoice to be forwarded to
            PSP.
        CreditedInvoiceNo:
          type: string
          description: >-
            Invoice number of the invoice to credit (Only mandatory for
            credits).
        CultureCode:
          type: string
          description: >-
            Culture code (e.g. 'sv-SE') explicit set for invoice to be forwarded
            to PSP.
        DeliveryDate:
          type: string
          description: Date when order was shipped.
          format: DateTime
        Gln:
          type: string
          description: Global location number. Identifier for company/customer.
        GroupCode:
          type: string
          description: Code used for grouping of invoices (for partial invoicing).
        InvoiceDueDate:
          type: string
          description: Last date for invoice payments.
          format: DateTime
        InvoiceRoundOff:
          type: number
          description: Total invoice round off.
        IsLastInvoiceForOrder:
          type: boolean
          description: >-
            Determines if all invoices already received in case of partial
            payments. Null is considered as true.
        Items:
          type: array
          description: List of invoiced order items. Mandatory for PSP capture.
          items:
            $ref: '#/components/schemas/InvoiceItem'
        Name:
          type: string
          description: Receiver name
        Payment:
          $ref: '#/components/schemas/Payment'
        PaymentMethodCode:
          type: string
          description: Code for payment method used (for receipts).
        PaymentMethodName:
          type: string
          description: Name of payment method used (for receipts).
        Region:
          type: string
          description: Receiver's region.
        SuppressPspCall:
          type: boolean
          description: >-
            Set to true to suppress a PSP call for this invoice. Invoice will be
            stored as information only.
        TotalAmount:
          type: number
          description: Deprecated
        Vat:
          type: number
          description: VAT amount
        VatRoundOff:
          type: number
          description: Deprecated
        ZipCode:
          type: string
          description: Receiver's zip code.
      description: >-
        Invoice information. Either InvoiceNo or ClientOrderRef must be
        provided.
      format: Invoice
    InvoiceItem:
      required:
        - PartNo
        - Quantity
        - UnitPrice
      type: object
      properties:
        PartNo:
          type: string
          description: Item part no.
        Quantity:
          type: integer
          description: Quantity of invoiced items.
          format: int32
        UnitPrice:
          type: number
          description: Unit price
        Description:
          type: string
          description: Item description. Mandatory for PSP capture.
        Discount:
          type: number
          description: Deprecated
        LineAmount:
          type: number
          description: Deprecated
        LineNo:
          type: number
          description: Line number.
        PriceList:
          type: string
          description: Item price list.
        ProductName:
          type: string
          description: Product name.
        SalePrice:
          type: number
          description: Deprecated
        UnitVat:
          type: number
          description: Unit VAT amount. Mandatory for PSP capture.
        VatRate:
          type: number
          description: VAT rate in percent. Mandatory for PSP capture.
      description: Order item to be invoiced.
      format: InvoiceItem
    OrderInfo:
      required:
        - Code
      type: object
      properties:
        Code:
          type: string
          description: Info code. Used for info matching.
        Value:
          type: string
          description: Value to set
      description: Additional client-defined order information
      format: OrderInfo
    OrderItem:
      required:
        - Discount
        - LineNo
        - PartNo
        - Quantity
        - Quantity2
        - Type
        - TypeGroup
        - UnitPrice
        - UnitPriceOriginal
        - UnitVat
        - VatRate
      type: object
      properties:
        Discount:
          type: number
          description: Discount
        LineNo:
          type: integer
          description: Norce Commerce generated row identifier. Unique within the order.
          format: int32
        PartNo:
          type: string
          description: Article number (Part No) in Norce Commerce.
        Quantity:
          type: integer
          description: Number of items ordered.
          format: int32
        Quantity2:
          type: number
          description: Item quantity for non-integer values.
        Type:
          type: string
          description: Type of product.
          enum:
            - Undefined
            - ErpStandard
            - Refurbished
            - Freight
            - Insurance
            - GiftCertificate
            - Bid
            - Download
            - Structure
            - Invoice
            - Demo
            - Service
            - Installation
            - Accumulation
            - Standard
            - StandardAfterCreated
            - Donation
            - Brand
            - EnvironmentalFee
            - PackingFee
        TypeGroup:
          type: string
          description: Product type group.
          enum:
            - Undefined
            - Physical
            - Virtual
            - Fee
            - Service
            - AddedFee
        UnitPrice:
          type: number
          description: >-
            Sale price for one item only excluding VAT (to get the row amount
            you multiply with quantity).
        UnitPriceOriginal:
          type: number
          description: Sale price before discounts.
        UnitVat:
          type: number
          description: VAT amount for one item (to get the row VAT multiply with quantity).
        VatRate:
          type: number
          description: VAT in percent
        AdditionalInfo:
          type: array
          description: Client specific information on order item.
          items:
            $ref: '#/components/schemas/CodeValue'
        Comment:
          type: string
          description: Row comment.
        Description:
          type: string
          description: Product description (ERP name in Norce Commerce).
        ErpPartNo:
          type: string
          description: >-
            Article number in ERP (usually same as PartNo, different for SKU
            type 13 'Accumulation').
        InternalProductId:
          type: integer
          description: Internal product id in Norce Commerce.
          format: int32
        ParentLineNo:
          type: integer
          description: >-
            Exists if the row is a child to another row, e.g. in case of service
            articles or items in a package/bundle.
          format: int32
        PriceListNo:
          type: integer
          description: Price list from which the price is derived.
          format: int32
        PriceLists:
          type: array
          description: >-
            All price lists that the unit price original is based on. This is a
            list of all pricelists in the hierarchy.
          items:
            $ref: '#/components/schemas/PriceListItem'
        Promotions:
          type: array
          description: List of all promotions applied to the order item.
          items:
            $ref: '#/components/schemas/Promotion'
        UnitOfMeasure:
          type: string
          description: Unit of measurement, e.g. pieces, mm, g.
      description: Represents order row
      format: OrderItem
    OrderRequest:
      type: object
      properties:
        AdditionalInfo:
          type: array
          description: Client specific information on the order
          items:
            $ref: '#/components/schemas/CodeValue'
        BillTo:
          $ref: '#/components/schemas/ClientCustomer'
        ClientOrderRef:
          type: string
          description: >-
            Usually weborder number (basket id in Norce Commerce). For orders
            from external source this is their number. Max length: 50
        CurrencyCode:
          type: string
          description: >-
            Currency code in ISO 4217 format, e.g. "SEK", "EUR", "USD". Max
            length: 3
        CustomerOrderComment:
          type: string
          description: Comment field
        CustomerOrderRef:
          type: string
          description: >-
            Buyers reference, usually added in the checkout for B2B orders. Max
            length: 50
        Discounts:
          type: array
          description: >-
            List of order discounts that are not represented on order lines. Not
            commonly used.
          items:
            $ref: '#/components/schemas/Discount'
        DoHold:
          type: boolean
          description: >-
            True if web solution thinks that this order should be manually
            validated before processed
        ErpOrderNo:
          type: string
          description: >-
            Usually empty. If exists this is a suggestion from web solution
            which order number the order should have in ERP. Max length: 50
        Fees:
          type: array
          description: >-
            Collection of fees on the order. Not commonly used, the fees are
            mostly implemented as order items with TypeGroup "Fee".
          items:
            $ref: '#/components/schemas/Fee'
        Header:
          $ref: '#/components/schemas/Header'
        Items:
          type: array
          description: >-
            Collection of order rows. Other than the articles this collection
            can also contain fees such as freight.
          items:
            $ref: '#/components/schemas/OrderItem'
        OrderType:
          type: integer
          description: >-
            Order type:<br>1 = Order<br>3 = Subscription/Recurring order<br>5 =
            External order
          format: int32
        Payments:
          type: array
          description: >-
            An order can have several payments. Usually this is only one, but
            sometime there are an additional payment method like giftcard or a
            voucher.
          items:
            $ref: '#/components/schemas/Payment'
        ReferId:
          type: integer
          description: If order is created from a referral like an ad
          format: int32
        SalesContactCode:
          type: string
          description: >-
            Code of sales contact if a sales rep should be marked as seller. Max
            length: 50
        SalesContactDivision:
          type: string
          description: >-
            Code of sales department if a sales dep should be marked as seller.
            Max length: 50
        SellTo:
          $ref: '#/components/schemas/ClientCustomer'
        ShipTo:
          $ref: '#/components/schemas/ClientCustomer'
        ShippingAdvice:
          $ref: '#/components/schemas/ShippingAdvice'
        Source:
          type: string
          description: >-
            Order source. Should be WEB for all orders created from client web
            sites.
        SubmitDate:
          type: string
          description: Timestamp when order was created in Norce Commerce.
          format: DateTime
      description: Represents a new order from Norce Commerce
      format: OrderRequest
    OrderResponse:
      required:
        - HasErpOrderNo
        - StatusCode
      type: object
      properties:
        HasErpOrderNo:
          type: boolean
          description: True if ErpOrder number is provided.
        StatusCode:
          type: string
          description: >-
            Order response status. Allowed values are "OK" or "Failed". Max
            length: 50
          enum:
            - OK
            - Failed
        Description:
          type: string
          description: >-
            Use this for a more information if status code is failed. Max
            length: 255
        ErpOrderNo:
          type: string
          description: >-
            Order number from the ERP, if available. Can be sent in with
            SendOrderStatus as well. Max length: 50
      description: Represents successful order registration in receiving system.
      format: OrderResponse
    Payment:
      required:
        - PaymentCode
        - PaymentMethodCode
        - PaymentRef
      type: object
      properties:
        PaymentCode:
          type: integer
          description: Payment code. Used for payment matching.
          format: int32
        PaymentMethodCode:
          type: string
          description: >-
            Payment method that should be sent in to the ERP, the code is
            configurable in Norce Commerce.
        PaymentRef:
          type: string
          description: >-
            Transaction identifier from 3rd party, like payment service
            provider.
        AdditionalInfo:
          type: array
          description: >-
            3rd party specific information abount payment (client and PSP
            decides what this can contain).
          items:
            $ref: '#/components/schemas/CodeValue'
        Amount:
          type: number
          description: Amount paid or reserved including VAT after rounding rules.
        CurrencyCode:
          type: string
          description: >-
            Currency code in ISO 4217 format, e.g. "SEK", "EUR", "USD". Max
            length: 3
      description: >-
        Represents successful payment reservation. Either PaymentCode or
        PaymentRef must be provided.
      format: Payment
    Person:
      type: object
      properties:
        Address:
          $ref: '#/components/schemas/Address'
        CellPhone:
          type: string
          description: 'Mobile phone number. Max length: 50'
        CompanyCode:
          type: string
          description: Always null, deprecated.
        CustomerCode:
          type: string
          description: >-
            Customer code. If exists the person is already in ERP. Max length:
            50
        Email:
          type: string
          description: 'Personal email. Max length: 255'
        FirstName:
          type: string
          description: 'Person name. Max length: 50'
        IsActive:
          type: boolean
          description: Deprecated
        JobTitle:
          type: string
          description: 'Person job title. Max length: 10'
        LastName:
          type: string
          description: 'Person surname. Max length: 50'
        PrivatePhone:
          type: string
          description: 'Private phone number. Max length: 50'
        SSN:
          type: string
          description: 'Social security number. Max length: 50'
        WorkPhone:
          type: string
          description: 'Work phone number. Max length: 50'
      description: Represents information about person related to an order.
      format: Person
    PickupStore:
      type: object
      properties:
        AdditionalInfo:
          type: array
          description: >-
            3rd party specific information on pickup point (client and
            transporter decides what this can contain).
          items:
            $ref: '#/components/schemas/CodeValue'
        Address:
          $ref: '#/components/schemas/Address'
        Code:
          type: string
          description: Transporter code for store.
        IsDropPoint:
          type: boolean
          description: Determines if store is pick up point.
        Name:
          type: string
          description: Store name
      description: Represents pickup store for an order
      format: PickupStore
    PriceListItem:
      type: object
      properties:
        IsActive:
          type: boolean
          description: Sets item in price list to active or inactive.
        IsStandardPriceList:
          type: boolean
          description: Determines if price list is standard.
        PriceListName:
          type: string
          description: 'Name of price list. Max length: 50'
        QtyBreak:
          type: integer
          description: Threshold value for applying price list based on item quantity.
          format: int32
        UnitPrice:
          type: number
          description: Sale price for one item only excluding VAT.
      description: Price list applied to order item.
      format: PriceListItem
    Promotion:
      type: object
      properties:
        AppliedAmount:
          type: number
          description: Amount applied to the order item from this promotion.
        DiscountCode:
          type: string
          description: >-
            External code for the promotion (if configured in Norce Commerce).
            Max length: 50
        Id:
          type: integer
          description: Norce Commerce internal id for the promotion.
          format: int32
        Name:
          type: string
          description: 'Name of the promotion. Max length: 255'
      description: Represents a promotional discount on an order row.
      format: Promotion
    SendOrderStatusRequest:
      required:
        - ClientOrderRef
        - ErpOrderNo
        - OrderStatus
      type: object
      properties:
        ClientOrderRef:
          type: integer
          description: Quotation/basket id. Used for order matching as reference.
          format: int32
        ErpOrderNo:
          type: string
          description: ERP order number. Used for order matching.
        OrderStatus:
          type: string
          description: Order status.
          enum:
            - Allocation
            - Confirmed
            - BackOrder
            - Delivered
            - Invoiced
            - Cancelled
            - CreditControl
            - PartlyDelivered
            - Acknowledged
            - ErpConfirmed
            - ReadyForPickup
            - PickedUp
            - NotPickedUp
            - OnHold
            - WaitingForCancel
            - WaitingForOnHoldRemoved
            - CancelError
            - AcknowledgementError
            - ReadyForReservation
            - Reserved
        AccountId:
          type: integer
          description: Norce Commerce account used for order update.
          format: int32
        Infos:
          type: array
          description: List of additional order information fields.
          items:
            $ref: '#/components/schemas/OrderInfo'
      description: >-
        Order update request. Either ClientOrderRef or ErpOrderNo must be
        provided.
      format: SendOrderStatusRequest
    Shipment:
      required:
        - ApplicationKey
        - DeliveryNoteNo
        - InvoiceNo
        - ShipmentNo
        - SourceWarehouseCode
        - TargetWarehouseCode
      type: object
      properties:
        ApplicationKey:
          type: string
          description: Application identifier
          format: uuid
        DeliveryNoteNo:
          type: string
          description: External identifier for the delivery note.
        InvoiceNo:
          type: string
          description: External identifier for related invoice.
        ShipmentNo:
          type: string
          description: External identifier for shipment.
        SourceWarehouseCode:
          type: string
          description: External identifier for the warehouse to ship items from.
        TargetWarehouseCode:
          type: string
          description: External identifier for the warehouse to receive the items.
        Barcode:
          type: string
          description: >-
            Barcode for whole shipment (individual shipment packages may have
            individual barcodes)
        CarrierName:
          type: string
          description: Carrier service name
        CarrierReference:
          type: string
          description: Carrier service shipment reference
        CarrierTrackingUrl:
          type: string
          description: Carrier service tracking url.
          format: uri
        Comment:
          type: string
          description: User comment.
        Items:
          type: array
          description: Items in the shipment
          items:
            $ref: '#/components/schemas/ShipmentItem'
        ReceiverName:
          type: string
          description: Name of receiver
        SenderName:
          type: string
          description: Name of sender
        ShipmentPackages:
          type: array
          description: List of shipment parts.
          items:
            $ref: '#/components/schemas/ShipmentPackage'
        ShipmentWarehouse:
          $ref: '#/components/schemas/Address'
        TargetWarehouseAddress:
          $ref: '#/components/schemas/Address'
      description: >-
        Information about shipment to POS system. Either DeliveryNoteNo or
        InvoiceNo and Items must be provided.
      format: Shipment
    ShipmentItem:
      required:
        - LineNo
        - PartNo
        - Quantity
      type: object
      properties:
        LineNo:
          type: integer
          description: Line number
          format: int32
        PartNo:
          type: string
          description: The item's part number
        Quantity:
          type: integer
          description: Quantity of the item
          format: int32
        Name:
          type: string
          description: Name of the item.
        PackageNo:
          type: string
          description: >-
            External reference to which shipment package that includes this
            item.
        Price:
          type: number
          description: Deprecated. Use PurchaseCost.
        PurchaseCost:
          type: number
          description: Purchase cost of the item.
        UnitCost:
          type: number
          description: Unit cost of the item.
      description: Items in a POS shipment
      format: ShipmentItem
    ShipmentPackage:
      required:
        - PackageNo
      type: object
      properties:
        PackageNo:
          type: string
          description: >-
            External identifier for the package. May be referenced on a shipment
            item.
        Barcode:
          type: string
          description: >-
            Barcode for the shipment package. Not necessarily the same a s the
            shipment barcode.
        Comment:
          type: string
          description: General comment for shipment package.
      description: Package in a POS shipment.
      format: ShipmentPackage
    ShippingAdvice:
      type: object
      properties:
        DeliveryMethodCode:
          type: string
          description: Delivery method sent to ERP, configurable in Norce Commerce
        DoSMSNotify:
          type: boolean
          description: True if buyer expects SMS notifications when delivery is ready.
        IsComplete:
          type: boolean
          description: >-
            True if it is expected that the order is shipped only once, no
            partial deliveries.
        IsFeeChargedOnce:
          type: boolean
          description: >-
            True if it is expected that the freight fee should be charged one
            time even if order is delivered in several dispatches.
        PickupStore:
          $ref: '#/components/schemas/PickupStore'
        ShipAdvisorOrderCode:
          type: string
          description: >-
            Code of the order from the shipping advisor (if Norce Commerce has
            integration to it).
        TmsReference:
          type: string
          description: Shipping reference from PSP or other TMS if available.
      description: Represents order shipping information
      format: ShippingAdvice
    WarehouseTransaction:
      required:
        - Items
        - TransactionNo
        - WarehouseCode
      type: object
      properties:
        Items:
          type: array
          description: List of items for the warehouse transaction.
          items:
            $ref: '#/components/schemas/WarehouseTransactionItem'
        TransactionNo:
          type: string
          description: External identifier for the warehouse transaction.
        WarehouseCode:
          type: string
          description: External identifier of the affected warehouse.
        Comment:
          type: string
          description: General comment.
        DeliveryNoteNo:
          type: string
          description: >-
            Optional delivery note number if transaction has delivery note
            connection.
        ExternalReference:
          type: string
          description: Optional external reference.
        LocationCode:
          type: string
          description: External identifier of the affected location.
        OrderNo:
          type: string
          description: Optional order reference if transaction has order connection.
        PurchaseOrderNo:
          type: string
          description: >-
            Optional purchase order reference if transaction has purchase order
            connection.
        ReasonCode:
          type: string
          description: Reason for transaction (user defined).
        TransactionDate:
          type: string
          description: Date of the transaction.
          format: DateTime
        Type:
          type: string
          description: Type of warehouse transaction.
      description: >-
        Record of transaction of items. No actions are taken in Norce Commerce
        from this document. Information only.
      format: WarehouseTransaction
    WarehouseTransactionItem:
      required:
        - PartNo
        - Qty
      type: object
      properties:
        PartNo:
          type: string
          description: Item part number.
        Qty:
          type: number
          description: Quantity of item in transaction.
        Amount:
          type: number
          description: Value of item in transaction.
        LineNumber:
          type: number
          description: Item line number.
        RemainingAmount:
          type: number
          description: Remaining amount of the item.
        RemainingQty:
          type: number
          description: Remaining quantity of the item.
      description: Items in a warehouse transaction.
      format: WarehouseTransactionItem
x-original-swagger-version: '2.0'
