Go-to-Light Service 4.0.0.2397 - 121 - API License to Cloud Demo

<back to all web services

UpdateReturnsItemBatchNumber

Requires Authentication
The following routes are available for this service:
All Verbs/UpdateReturnsItemBatchNumber
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class StockAdditional:
    stock_i_d: int = 0
    gtin: Optional[str] = None
    stock_location: Optional[str] = None
    physical_quantity_stock_location: float = 0.0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Stock:
    stock_i_d: int = 0
    product_i_d: Optional[str] = None
    product_attribute_i_d: Optional[str] = None
    reference: Optional[str] = None
    gtin: Optional[str] = None
    gtin_attribute: Optional[str] = None
    label: Optional[str] = None
    stock_location: Optional[str] = None
    physical_quantity_stock_location: float = 0.0
    reserve_stock_location: Optional[str] = None
    physical_quantity_reserve_stock_location: float = 0.0
    nb_s_k_u_in_package: Optional[int] = None
    package_reference: Optional[str] = None
    nb_s_k_u_in_package2: Optional[int] = None
    package_reference2: Optional[str] = None
    weight: Optional[str] = None
    fill_in_batch_number: bool = False
    fill_in_date: bool = False
    picture_u_r_l: Optional[str] = None
    stock_additionals: List[StockAdditional] = field(default_factory=list)
    search_key: Optional[str] = None


class ReturnRackPositionStatus(str, Enum):
    EMPTY = 'EMPTY'
    USED = 'USED'
    FULL = 'FULL'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ReturnsDispatchingRackPosition:
    id: int = 0
    returns_dispersion_rack_i_d: int = 0
    name: Optional[str] = None
    ean: Optional[str] = None
    batch_number: Optional[str] = None
    item_date: Optional[datetime.datetime] = None
    quantity: int = 0
    status: Optional[ReturnRackPositionStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ReturnsResultInfo:
    result: Optional[str] = None
    error: Optional[str] = None
    stock: Optional[Stock] = None
    rack_position: Optional[ReturnsDispatchingRackPosition] = None
    rack_i_d: int = 0
    ean: Optional[str] = None
    batch_number: Optional[str] = None
    item_date: Optional[datetime.datetime] = None
    specific_case_to_be_treated: List[str] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UpdateReturnsItemBatchNumber:
    # @ApiMember(Description="Returns rack id", IsRequired=true)
    returns_result: Optional[ReturnsResultInfo] = None
    """
    Returns rack id
    """


    # @ApiMember(Description="batch number", IsRequired=true)
    batch_number: Optional[str] = None
    """
    batch number
    """

Python UpdateReturnsItemBatchNumber DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /UpdateReturnsItemBatchNumber HTTP/1.1 
Host: clouddemo.pickeos.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UpdateReturnsItemBatchNumber xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoToLightAPI">
  <BatchNumber>String</BatchNumber>
  <ReturnsResult xmlns:d2p1="http://schemas.datacontract.org/2004/07/GoToLightAPI.Entities">
    <d2p1:BatchNumber>String</d2p1:BatchNumber>
    <d2p1:EAN>String</d2p1:EAN>
    <d2p1:Error>String</d2p1:Error>
    <d2p1:ItemDate>0001-01-01T00:00:00</d2p1:ItemDate>
    <d2p1:RackID>0</d2p1:RackID>
    <d2p1:RackPosition>
      <d2p1:BatchNumber>String</d2p1:BatchNumber>
      <d2p1:EAN>String</d2p1:EAN>
      <d2p1:ID>0</d2p1:ID>
      <d2p1:ItemDate>0001-01-01T00:00:00</d2p1:ItemDate>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:Quantity>0</d2p1:Quantity>
      <d2p1:ReturnsDispersionRackID>0</d2p1:ReturnsDispersionRackID>
      <d2p1:Status>EMPTY</d2p1:Status>
    </d2p1:RackPosition>
    <d2p1:Result>String</d2p1:Result>
    <d2p1:SpecificCaseToBeTreated xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </d2p1:SpecificCaseToBeTreated>
    <d2p1:Stock>
      <FillInBatchNumber>false</FillInBatchNumber>
      <FillInDate>false</FillInDate>
      <Gtin>String</Gtin>
      <GtinAttribute>String</GtinAttribute>
      <Label>String</Label>
      <NbSKUInPackage>0</NbSKUInPackage>
      <NbSKUInPackage2>0</NbSKUInPackage2>
      <PackageReference>String</PackageReference>
      <PackageReference2>String</PackageReference2>
      <PhysicalQuantityReserveStockLocation>0</PhysicalQuantityReserveStockLocation>
      <PhysicalQuantityStockLocation>0</PhysicalQuantityStockLocation>
      <PictureURL>String</PictureURL>
      <ProductAttributeID>String</ProductAttributeID>
      <ProductID>String</ProductID>
      <Reference>String</Reference>
      <ReserveStockLocation>String</ReserveStockLocation>
      <StockAdditionals>
        <StockAdditional>
          <Gtin>String</Gtin>
          <PhysicalQuantityStockLocation>0</PhysicalQuantityStockLocation>
          <StockID>0</StockID>
          <StockLocation>String</StockLocation>
        </StockAdditional>
      </StockAdditionals>
      <StockID>0</StockID>
      <StockLocation>String</StockLocation>
      <Weight>String</Weight>
    </d2p1:Stock>
  </ReturnsResult>
</UpdateReturnsItemBatchNumber>