IMimis
BatchSummary

Updates a BatchSummary by id

Updates an instance of BatchSummary by id

put/BatchSummary/{BatchId}

Request

  • Base URL
    https://yourorgsite.com/api
  • URL
    https://yourorgsite.com/api/BatchSummary/{BatchId}
  • Auth
    OAuth 2
    Implicit: https://yourorgsite.com

Path parameters

BatchIdstring required

Id of BatchSummary to be Updated

Request body

$type'Asi.Soa.Commerce.DataContracts.BatchSummaryData, Asi.Contracts' required

The DataType must be "Asi.Soa.Commerce.DataContracts.BatchSummaryData, Asi.Contracts"

BatchDatestring date-time
BatchIdstring
BatchNumberstring
BatchStatus'Open' | 'ReadyForReview' | 'Closed' | 'PostingInProgress' | 'Completed' | 'PostingError' | 'Deleted' | 'Loading' | 'Deleting'
Descriptionstring
HasExportedTransactionsboolean
IsAutoPostedboolean
Namestring
PostingErrorstring
SourceSystemstring
TransactionCountinteger

Response

The request was successful.

Changes

No recorded changes to this operation across all 2 revisions of this API.